accel30  2.1.0.0
accel30.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef ACCEL30_H
29 #define ACCEL30_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_spi_master.h"
39 #include "spi_specifics.h"
40 
61 #define ACCEL30_REG_EXT_STAT_1 0x00
62 #define ACCEL30_REG_EXT_STAT_2 0x01
63 #define ACCEL30_REG_XOUT_LSB 0x02
64 #define ACCEL30_REG_XOUT_MSB 0x03
65 #define ACCEL30_REG_YOUT_LSB 0x04
66 #define ACCEL30_REG_YOUT_MSB 0x05
67 #define ACCEL30_REG_ZOUT_LSB 0x06
68 #define ACCEL30_REG_ZOUT_MSB 0x07
69 #define ACCEL30_REG_STATUS_1 0x08
70 #define ACCEL30_REG_STATUS_2 0x09
71 #define ACCEL30_REG_FREG_1 0x0D
72 #define ACCEL30_REG_FREG_2 0x0E
73 #define ACCEL30_REG_INIT_1 0x0F
74 #define ACCEL30_REG_MODE_C 0x10
75 #define ACCEL30_REG_WAKE_C 0x11
76 #define ACCEL30_REG_SNIFF_C 0x12
77 #define ACCEL30_REG_SNIFFTH_C 0x13
78 #define ACCEL30_REG_SNIFFCF_C 0x14
79 #define ACCEL30_REG_RANGE_C 0x15
80 #define ACCEL30_REG_FIFO_C 0x16
81 #define ACCEL30_REG_INTR_C 0x17
82 #define ACCEL30_REG_INIT_3 0x1A
83 #define ACCEL30_REG_SCRATCH 0x1B
84 #define ACCEL30_REG_POWER_MODE 0x1C
85 #define ACCEL30_REG_DMX 0x20
86 #define ACCEL30_REG_DMY 0x21
87 #define ACCEL30_REG_DMZ 0x22
88 #define ACCEL30_REG_RESET 0x24
89 #define ACCEL30_REG_INIT_2 0x28
90 #define ACCEL30_REG_TRIGC 0x29
91 #define ACCEL30_REG_XOFFL 0x2A
92 #define ACCEL30_REG_XOFFH 0x2B
93 #define ACCEL30_REG_YOFFL 0x2C
94 #define ACCEL30_REG_YOFFH 0x2D
95 #define ACCEL30_REG_ZOFFL 0x2E
96 #define ACCEL30_REG_ZOFFH 0x2F
97 #define ACCEL30_REG_XGAIN 0x30
98 #define ACCEL30_REG_YGAIN 0x31
99 #define ACCEL30_REG_ZGAIN 0x32
100 #define ACCEL30_REG_OPT 0x3B
101 #define ACCEL30_REG_GAIN 0x21
102 
103  // accel30_reg
105 
120 #define ACCEL30_MODE_BIT_MASK 0xF0
121 #define ACCEL30_RANGE_BIT_MASK 0x07
122 #define ACCEL30_GAIN_BIT_MASK 0x3F
123 #define ACCEL30_RESOLUTION_BIT_MASK 0x70
124 #define ACCEL30_DMX_PN_DISABLE 0x00
125 #define ACCEL30_DMX_RES_BIT_MASK 0x01
126 #define ACCEL30_ENABLE_XYZ_AXIS_PD 0x00
127 #define ACCEL30_TRIG_CMD_CONTINUOUS 0x00
128 #define ACCEL30_TRIG_CMD_ONE_SHOT 0x01
129 #define ACCEL30_FORCE_RESET 0x40
130 #define ACCEL30_I2C_ENABLE 0x40
131 #define ACCEL30_SPI_ENABLE 0x80
132 #define ACCEL30_MODE_BIT_MASK 0xF0
133 
139 #define ACCEL30_DEVICE_ADDRESS_GND 0x4C
140 #define ACCEL30_DEVICE_ADDRESS_VCC 0x6C
141 
150 #define ACCEL30_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
151 #define ACCEL30_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
152  // accel30_set
154 
169 #define ACCEL30_MAP_MIKROBUS( cfg, mikrobus ) \
170  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
171  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
172  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
173  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
174  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
175  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
176  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
177  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
178  // accel30_map // accel30
181 
186 typedef enum
187 {
192 
197 typedef err_t ( *accel30_master_io_t )( struct accel30_s*, uint8_t, uint8_t*, uint8_t );
203 typedef struct accel30_s
204 {
205  digital_out_t rst;
207  digital_in_t int_pin;
209  i2c_master_t i2c;
210  spi_master_t spi;
212  uint8_t slave_address;
213  pin_name_t chip_select;
219  uint8_t range_cfg;
220  uint8_t resolution_cfg;
223 
228 typedef struct
229 {
230  pin_name_t scl;
231  pin_name_t sda;
232  pin_name_t miso;
233  pin_name_t mosi;
234  pin_name_t sck;
235  pin_name_t cs;
236  pin_name_t rst;
237  pin_name_t int_pin;
239  uint32_t i2c_speed;
240  uint8_t i2c_address;
242  uint32_t spi_speed;
243  spi_master_mode_t spi_mode;
244  spi_master_chip_select_polarity_t cs_polarity;
248 } accel30_cfg_t;
249 
254 typedef enum
255 {
257  ACCEL30_ERROR = -1
258 
260 
265 typedef enum
266 {
271 
273 
278 typedef enum
279 {
285 
287 
292 typedef enum
293 {
300 
302 
307 typedef enum
308 {
316 
318 
323 typedef enum
324 {
342 
344 
349 typedef enum
350 {
363 
365 
370 typedef enum
371 {
375 
377 
382 typedef enum
383 {
389 
391 
396 typedef struct
397 {
398  int16_t x;
399  int16_t y;
400  int16_t z;
401 
403 
408 typedef struct
409 {
410  float x;
411  float y;
412  float z;
413 
415 
432 
448 
462 err_t accel30_init ( accel30_t *ctx, accel30_cfg_t *cfg );
463 
477 
492 err_t accel30_generic_write ( accel30_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
493 
508 err_t accel30_generic_read ( accel30_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
509 
523 
537 
550 
564 
578 
592 
606 
620 
634 
647 err_t accel30_get_axis ( accel30_t *ctx, accel30_axis_t *acc_axis );
648 
661 err_t accel30_get_avg_axes ( accel30_t *ctx, accel30_avg_axis_t *acc_avg_axis );
662 
674 
675 #ifdef __cplusplus
676 }
677 #endif
678 #endif // ACCEL30_H
679  // accel30
681 
682 // ------------------------------------------------------------------------ END
accel30_cfg_t::sda
pin_name_t sda
Definition: accel30.h:231
ACCEL30_DRV_SEL_I2C
@ ACCEL30_DRV_SEL_I2C
Definition: accel30.h:189
ACCEL30_SNIFF_SR_6Hz
@ ACCEL30_SNIFF_SR_6Hz
Definition: accel30.h:355
accel30_axis_t::z
int16_t z
Definition: accel30.h:400
accel30_set_pwr_mode
err_t accel30_set_pwr_mode(accel30_t *ctx, accel30_power_mode_t pwr_mode)
Accel 30 set power mode function.
accel30_power_mode_t
accel30_power_mode_t
Accel 30 Click power mode value data.
Definition: accel30.h:383
accel30_get_axis
err_t accel30_get_axis(accel30_t *ctx, accel30_axis_t *acc_axis)
Accel 30 get accel data function.
accel30_cfg_t::drv_sel
accel30_drv_t drv_sel
Definition: accel30.h:246
accel30_range_t
accel30_range_t
Accel 30 Click range value data.
Definition: accel30.h:293
ACCEL30_CWAKE_750Hz
@ ACCEL30_CWAKE_750Hz
Definition: accel30.h:340
accel30_s::int_pin
digital_in_t int_pin
Definition: accel30.h:207
accel30_cfg_t::rst
pin_name_t rst
Definition: accel30.h:236
ACCEL30_FIFO_MODE_END
@ ACCEL30_FIFO_MODE_END
Definition: accel30.h:374
accel30_init
err_t accel30_init(accel30_t *ctx, accel30_cfg_t *cfg)
Accel 30 initialization function.
ACCEL30_GAIN_NOT_USED
@ ACCEL30_GAIN_NOT_USED
Definition: accel30.h:270
accel30_cwake_t
accel30_cwake_t
Accel 30 Click CWAKE sampling value data.
Definition: accel30.h:324
ACCEL30_RANGE_8G
@ ACCEL30_RANGE_8G
Definition: accel30.h:296
accel30_return_value_t
accel30_return_value_t
Accel 30 Click return value data.
Definition: accel30.h:255
accel30_cfg_t::cs
pin_name_t cs
Definition: accel30.h:235
ACCEL30_CWAKE_54Hz
@ ACCEL30_CWAKE_54Hz
Definition: accel30.h:332
ACCEL30_CWAKE_0p8Hz
@ ACCEL30_CWAKE_0p8Hz
Definition: accel30.h:327
accel30_set_wake_gain
err_t accel30_set_wake_gain(accel30_t *ctx, accel30_gain_t gain)
Accel 30 set wake gain function.
ACCEL30_MODE_STANDBY
@ ACCEL30_MODE_STANDBY
Definition: accel30.h:281
accel30_cfg_t::miso
pin_name_t miso
Definition: accel30.h:232
spi_specifics.h
This file contains SPI specific macros, functions, etc.
ACCEL30_SNIFF_SR_0p4Hz
@ ACCEL30_SNIFF_SR_0p4Hz
Definition: accel30.h:352
ACCEL30_RESOLUTION_10BIT
@ ACCEL30_RESOLUTION_10BIT
Definition: accel30.h:312
accel30_cfg_setup
void accel30_cfg_setup(accel30_cfg_t *cfg)
Accel 30 configuration object setup function.
ACCEL30_RESOLUTION_7BIT
@ ACCEL30_RESOLUTION_7BIT
Definition: accel30.h:310
accel30_s::chip_select
pin_name_t chip_select
Definition: accel30.h:213
accel30_t
struct accel30_s accel30_t
Accel 30 Click context object.
accel30_s::i2c
i2c_master_t i2c
Definition: accel30.h:209
accel30_s
Accel 30 Click context object.
Definition: accel30.h:204
ACCEL30_RESOLUTION_6BIT
@ ACCEL30_RESOLUTION_6BIT
Definition: accel30.h:309
accel30_set_range_ctrl
err_t accel30_set_range_ctrl(accel30_t *ctx, accel30_range_t range)
Accel 30 set range control function.
accel30_sniff_sr_t
accel30_sniff_sr_t
Accel 30 Click SNIFF sampling value data.
Definition: accel30.h:350
accel30_generic_read
err_t accel30_generic_read(accel30_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Accel 30 data reading function.
accel30_cfg_t::mosi
pin_name_t mosi
Definition: accel30.h:233
accel30_s::resolution_cfg
uint8_t resolution_cfg
Definition: accel30.h:220
accel30_set_sample_rate
err_t accel30_set_sample_rate(accel30_t *ctx, accel30_cwake_t sample_rate)
Accel 30 set sampling rate function.
accel30_avg_axis_t::y
float y
Definition: accel30.h:411
ACCEL30_RANGE_END
@ ACCEL30_RANGE_END
Definition: accel30.h:299
accel30_drv_interface_selection
void accel30_drv_interface_selection(accel30_cfg_t *cfg, accel30_drv_t drv_sel)
Accel 30 driver interface setup function.
ACCEL30_CWAKE_28Hz
@ ACCEL30_CWAKE_28Hz
Definition: accel30.h:331
accel30_fifo_mode_t
accel30_fifo_mode_t
Accel 30 Click FIFO mode value data.
Definition: accel30.h:371
ACCEL30_SNIFF_SR_100Hz
@ ACCEL30_SNIFF_SR_100Hz
Definition: accel30.h:359
ACCEL30_OK
@ ACCEL30_OK
Definition: accel30.h:256
accel30_axis_t::y
int16_t y
Definition: accel30.h:399
accel30_cfg_t::sck
pin_name_t sck
Definition: accel30.h:234
ACCEL30_SNIFF_SR_2Hz
@ ACCEL30_SNIFF_SR_2Hz
Definition: accel30.h:354
ACCEL30_ULOW_POWER
@ ACCEL30_ULOW_POWER
Definition: accel30.h:387
ACCEL30_CWAKE_14Hz
@ ACCEL30_CWAKE_14Hz
Definition: accel30.h:330
ACCEL30_CWAKE_210Hz
@ ACCEL30_CWAKE_210Hz
Definition: accel30.h:334
accel30_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel30.h:239
ACCEL30_RESERVED_1
@ ACCEL30_RESERVED_1
Definition: accel30.h:385
ACCEL30_SNIFF_SR_50Hz
@ ACCEL30_SNIFF_SR_50Hz
Definition: accel30.h:358
accel30_avg_axis_t::z
float z
Definition: accel30.h:412
accel30_set_sniff_gain
err_t accel30_set_sniff_gain(accel30_t *ctx, accel30_gain_t gain)
Accel 30 set sniff gain function.
accel30_avg_axis_t
Accel 30 Click Axis averaged structure object.
Definition: accel30.h:409
ACCEL30_CWAKE_6Hz
@ ACCEL30_CWAKE_6Hz
Definition: accel30.h:329
accel30_cfg_t
Accel 30 Click configuration object.
Definition: accel30.h:229
accel30_s::read_f
accel30_master_io_t read_f
Definition: accel30.h:217
ACCEL30_RESOLUTION_8BIT
@ ACCEL30_RESOLUTION_8BIT
Definition: accel30.h:311
ACCEL30_SNIFF_SR_END
@ ACCEL30_SNIFF_SR_END
Definition: accel30.h:362
accel30_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel30.h:240
ACCEL30_GAIN_4X
@ ACCEL30_GAIN_4X
Definition: accel30.h:268
ACCEL30_CWAKE_END
@ ACCEL30_CWAKE_END
Definition: accel30.h:341
ACCEL30_CWAKE_400Hz
@ ACCEL30_CWAKE_400Hz
Definition: accel30.h:335
accel30_set_resolution_ctrl
err_t accel30_set_resolution_ctrl(accel30_t *ctx, accel30_resolution_t resolution)
Accel 30 set resolution control function.
accel30_drv_t
accel30_drv_t
Accel 30 Click driver selector.
Definition: accel30.h:187
ACCEL30_SNIFF_SR_DEFAULT_6Hz
@ ACCEL30_SNIFF_SR_DEFAULT_6Hz
Definition: accel30.h:351
ACCEL30_MODE_SLEEP
@ ACCEL30_MODE_SLEEP
Definition: accel30.h:280
accel30_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel30.h:242
accel30_s::range_cfg
uint8_t range_cfg
Definition: accel30.h:219
ACCEL30_RESOLUTION_12BIT
@ ACCEL30_RESOLUTION_12BIT
Definition: accel30.h:313
ACCEL30_MODE_SNIFF
@ ACCEL30_MODE_SNIFF
Definition: accel30.h:282
ACCEL30_SNIFF_SR_400Hz
@ ACCEL30_SNIFF_SR_400Hz
Definition: accel30.h:361
ACCEL30_RANGE_4G
@ ACCEL30_RANGE_4G
Definition: accel30.h:295
accel30_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel30.h:244
ACCEL30_GAIN_1X
@ ACCEL30_GAIN_1X
Definition: accel30.h:269
accel30_cfg_t::int_pin
pin_name_t int_pin
Definition: accel30.h:237
ACCEL30_MODE_CWAKE
@ ACCEL30_MODE_CWAKE
Definition: accel30.h:283
accel30_gain_t
accel30_gain_t
Accel 30 Click gain value data.
Definition: accel30.h:266
ACCEL30_SNIFF_SR_25Hz
@ ACCEL30_SNIFF_SR_25Hz
Definition: accel30.h:357
ACCEL30_DRV_SEL_SPI
@ ACCEL30_DRV_SEL_SPI
Definition: accel30.h:188
ACCEL30_MODE_TRIG
@ ACCEL30_MODE_TRIG
Definition: accel30.h:284
ACCEL30_FIFO_MODE_WATERMARK
@ ACCEL30_FIFO_MODE_WATERMARK
Definition: accel30.h:373
accel30_axis_t::x
int16_t x
Definition: accel30.h:398
accel30_default_cfg
err_t accel30_default_cfg(accel30_t *ctx)
Accel 30 default configuration function.
ACCEL30_CWAKE_2Hz
@ ACCEL30_CWAKE_2Hz
Definition: accel30.h:328
ACCEL30_LOW_POWER
@ ACCEL30_LOW_POWER
Definition: accel30.h:384
accel30_master_io_t
err_t(* accel30_master_io_t)(struct accel30_s *, uint8_t, uint8_t *, uint8_t)
Accel 30 Click driver interface.
Definition: accel30.h:197
ACCEL30_ERROR
@ ACCEL30_ERROR
Definition: accel30.h:257
ACCEL30_RESOLUTION_14BIT
@ ACCEL30_RESOLUTION_14BIT
Definition: accel30.h:314
ACCEL30_RESERVED_2
@ ACCEL30_RESERVED_2
Definition: accel30.h:386
ACCEL30_CWAKE_RESER0
@ ACCEL30_CWAKE_RESER0
Definition: accel30.h:337
accel30_soft_reset
err_t accel30_soft_reset(accel30_t *ctx)
Accel 30 soft reset function.
ACCEL30_FIFO_MODE_NORMAL
@ ACCEL30_FIFO_MODE_NORMAL
Definition: accel30.h:372
ACCEL30_CWAKE_RESER2
@ ACCEL30_CWAKE_RESER2
Definition: accel30.h:339
ACCEL30_SNIFF_SR_0p8Hz
@ ACCEL30_SNIFF_SR_0p8Hz
Definition: accel30.h:353
accel30_get_int_pin
uint8_t accel30_get_int_pin(accel30_t *ctx)
Accel 30 get interrupt function.
accel30_get_avg_axes
err_t accel30_get_avg_axes(accel30_t *ctx, accel30_avg_axis_t *acc_avg_axis)
Accel 30 get accel averaged data function.
ACCEL30_SNIFF_SR_200Hz
@ ACCEL30_SNIFF_SR_200Hz
Definition: accel30.h:360
accel30_set_sniff_sample_rate
err_t accel30_set_sniff_sample_rate(accel30_t *ctx, accel30_sniff_sr_t sample_rate)
Accel 30 set sniff sampling rate function.
accel30_avg_axis_t::x
float x
Definition: accel30.h:410
ACCEL30_RANGE_16G
@ ACCEL30_RANGE_16G
Definition: accel30.h:298
ACCEL30_SNIFF_SR_13Hz
@ ACCEL30_SNIFF_SR_13Hz
Definition: accel30.h:356
accel30_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel30.h:243
ACCEL30_RESOLUTION_END
@ ACCEL30_RESOLUTION_END
Definition: accel30.h:315
accel30_resolution_t
accel30_resolution_t
Accel 30 Click resolution value data.
Definition: accel30.h:308
ACCEL30_GAIN_DEFAULT
@ ACCEL30_GAIN_DEFAULT
Definition: accel30.h:267
ACCEL30_CWAKE_600Hz
@ ACCEL30_CWAKE_600Hz
Definition: accel30.h:336
ACCEL30_CWAKE_RESER1
@ ACCEL30_CWAKE_RESER1
Definition: accel30.h:338
accel30_s::slave_address
uint8_t slave_address
Definition: accel30.h:212
accel30_set_mode
err_t accel30_set_mode(accel30_t *ctx, accel30_op_mode_t mode)
Accel 30 set operating mode function.
ACCEL30_RANGE_2G
@ ACCEL30_RANGE_2G
Definition: accel30.h:294
ACCEL30_CWAKE_100Hz
@ ACCEL30_CWAKE_100Hz
Definition: accel30.h:333
ACCEL30_RANGE_12G
@ ACCEL30_RANGE_12G
Definition: accel30.h:297
ACCEL30_CWAKE_0p4Hz
@ ACCEL30_CWAKE_0p4Hz
Definition: accel30.h:326
accel30_s::rst
digital_out_t rst
Definition: accel30.h:205
accel30_generic_write
err_t accel30_generic_write(accel30_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Accel 30 data writing function.
ACCEL30_PRE_POWER
@ ACCEL30_PRE_POWER
Definition: accel30.h:388
accel30_s::drv_sel
accel30_drv_t drv_sel
Definition: accel30.h:214
accel30_s::spi
spi_master_t spi
Definition: accel30.h:210
ACCEL30_CWAKE_DEFAULT_50Hz
@ ACCEL30_CWAKE_DEFAULT_50Hz
Definition: accel30.h:325
accel30_op_mode_t
accel30_op_mode_t
Accel 30 Click operating mode value data.
Definition: accel30.h:279
accel30_s::write_f
accel30_master_io_t write_f
Definition: accel30.h:216
accel30_cfg_t::scl
pin_name_t scl
Definition: accel30.h:230
accel30_axis_t
Accel 30 Click Axis structure object.
Definition: accel30.h:397