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 "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 #include "drv_spi_master.h"
49 #include "spi_specifics.h"
50 
71 #define ACCEL30_REG_EXT_STAT_1 0x00
72 #define ACCEL30_REG_EXT_STAT_2 0x01
73 #define ACCEL30_REG_XOUT_LSB 0x02
74 #define ACCEL30_REG_XOUT_MSB 0x03
75 #define ACCEL30_REG_YOUT_LSB 0x04
76 #define ACCEL30_REG_YOUT_MSB 0x05
77 #define ACCEL30_REG_ZOUT_LSB 0x06
78 #define ACCEL30_REG_ZOUT_MSB 0x07
79 #define ACCEL30_REG_STATUS_1 0x08
80 #define ACCEL30_REG_STATUS_2 0x09
81 #define ACCEL30_REG_FREG_1 0x0D
82 #define ACCEL30_REG_FREG_2 0x0E
83 #define ACCEL30_REG_INIT_1 0x0F
84 #define ACCEL30_REG_MODE_C 0x10
85 #define ACCEL30_REG_WAKE_C 0x11
86 #define ACCEL30_REG_SNIFF_C 0x12
87 #define ACCEL30_REG_SNIFFTH_C 0x13
88 #define ACCEL30_REG_SNIFFCF_C 0x14
89 #define ACCEL30_REG_RANGE_C 0x15
90 #define ACCEL30_REG_FIFO_C 0x16
91 #define ACCEL30_REG_INTR_C 0x17
92 #define ACCEL30_REG_INIT_3 0x1A
93 #define ACCEL30_REG_SCRATCH 0x1B
94 #define ACCEL30_REG_POWER_MODE 0x1C
95 #define ACCEL30_REG_DMX 0x20
96 #define ACCEL30_REG_DMY 0x21
97 #define ACCEL30_REG_DMZ 0x22
98 #define ACCEL30_REG_RESET 0x24
99 #define ACCEL30_REG_INIT_2 0x28
100 #define ACCEL30_REG_TRIGC 0x29
101 #define ACCEL30_REG_XOFFL 0x2A
102 #define ACCEL30_REG_XOFFH 0x2B
103 #define ACCEL30_REG_YOFFL 0x2C
104 #define ACCEL30_REG_YOFFH 0x2D
105 #define ACCEL30_REG_ZOFFL 0x2E
106 #define ACCEL30_REG_ZOFFH 0x2F
107 #define ACCEL30_REG_XGAIN 0x30
108 #define ACCEL30_REG_YGAIN 0x31
109 #define ACCEL30_REG_ZGAIN 0x32
110 #define ACCEL30_REG_OPT 0x3B
111 #define ACCEL30_REG_GAIN 0x21
112 
113  // accel30_reg
115 
130 #define ACCEL30_MODE_BIT_MASK 0xF0
131 #define ACCEL30_RANGE_BIT_MASK 0x07
132 #define ACCEL30_GAIN_BIT_MASK 0x3F
133 #define ACCEL30_RESOLUTION_BIT_MASK 0x70
134 #define ACCEL30_DMX_PN_DISABLE 0x00
135 #define ACCEL30_DMX_RES_BIT_MASK 0x01
136 #define ACCEL30_ENABLE_XYZ_AXIS_PD 0x00
137 #define ACCEL30_TRIG_CMD_CONTINUOUS 0x00
138 #define ACCEL30_TRIG_CMD_ONE_SHOT 0x01
139 #define ACCEL30_FORCE_RESET 0x40
140 #define ACCEL30_I2C_ENABLE 0x40
141 #define ACCEL30_SPI_ENABLE 0x80
142 #define ACCEL30_MODE_BIT_MASK 0xF0
143 
149 #define ACCEL30_DEVICE_ADDRESS_GND 0x4C
150 #define ACCEL30_DEVICE_ADDRESS_VCC 0x6C
151 
160 #define ACCEL30_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
161 #define ACCEL30_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
162  // accel30_set
164 
179 #define ACCEL30_MAP_MIKROBUS( cfg, mikrobus ) \
180  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
181  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
182  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
183  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
184  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
185  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
186  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
187  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
188  // accel30_map // accel30
191 
196 typedef enum
197 {
202 
207 typedef err_t ( *accel30_master_io_t )( struct accel30_s*, uint8_t, uint8_t*, uint8_t );
213 typedef struct accel30_s
214 {
215  digital_out_t rst;
217  digital_in_t int_pin;
219  i2c_master_t i2c;
220  spi_master_t spi;
222  uint8_t slave_address;
223  pin_name_t chip_select;
229  uint8_t range_cfg;
230  uint8_t resolution_cfg;
233 
238 typedef struct
239 {
240  pin_name_t scl;
241  pin_name_t sda;
242  pin_name_t miso;
243  pin_name_t mosi;
244  pin_name_t sck;
245  pin_name_t cs;
246  pin_name_t rst;
247  pin_name_t int_pin;
249  uint32_t i2c_speed;
250  uint8_t i2c_address;
252  uint32_t spi_speed;
253  spi_master_mode_t spi_mode;
254  spi_master_chip_select_polarity_t cs_polarity;
258 } accel30_cfg_t;
259 
264 typedef enum
265 {
267  ACCEL30_ERROR = -1
268 
270 
275 typedef enum
276 {
281 
283 
288 typedef enum
289 {
295 
297 
302 typedef enum
303 {
310 
312 
317 typedef enum
318 {
326 
328 
333 typedef enum
334 {
352 
354 
359 typedef enum
360 {
373 
375 
380 typedef enum
381 {
385 
387 
392 typedef enum
393 {
399 
401 
406 typedef struct
407 {
408  int16_t x;
409  int16_t y;
410  int16_t z;
411 
413 
418 typedef struct
419 {
420  float x;
421  float y;
422  float z;
423 
425 
442 
458 
472 err_t accel30_init ( accel30_t *ctx, accel30_cfg_t *cfg );
473 
487 
502 err_t accel30_generic_write ( accel30_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
503 
518 err_t accel30_generic_read ( accel30_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
519 
533 
547 
560 
574 
588 
602 
616 
630 
644 
657 err_t accel30_get_axis ( accel30_t *ctx, accel30_axis_t *acc_axis );
658 
671 err_t accel30_get_avg_axes ( accel30_t *ctx, accel30_avg_axis_t *acc_avg_axis );
672 
684 
685 #ifdef __cplusplus
686 }
687 #endif
688 #endif // ACCEL30_H
689  // accel30
691 
692 // ------------------------------------------------------------------------ END
accel30_cfg_t::sda
pin_name_t sda
Definition: accel30.h:241
ACCEL30_DRV_SEL_I2C
@ ACCEL30_DRV_SEL_I2C
Definition: accel30.h:199
ACCEL30_SNIFF_SR_6Hz
@ ACCEL30_SNIFF_SR_6Hz
Definition: accel30.h:365
accel30_axis_t::z
int16_t z
Definition: accel30.h:410
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:393
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:256
accel30_range_t
accel30_range_t
Accel 30 Click range value data.
Definition: accel30.h:303
ACCEL30_CWAKE_750Hz
@ ACCEL30_CWAKE_750Hz
Definition: accel30.h:350
accel30_s::int_pin
digital_in_t int_pin
Definition: accel30.h:217
accel30_cfg_t::rst
pin_name_t rst
Definition: accel30.h:246
ACCEL30_FIFO_MODE_END
@ ACCEL30_FIFO_MODE_END
Definition: accel30.h:384
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:280
accel30_cwake_t
accel30_cwake_t
Accel 30 Click CWAKE sampling value data.
Definition: accel30.h:334
ACCEL30_RANGE_8G
@ ACCEL30_RANGE_8G
Definition: accel30.h:306
accel30_return_value_t
accel30_return_value_t
Accel 30 Click return value data.
Definition: accel30.h:265
accel30_cfg_t::cs
pin_name_t cs
Definition: accel30.h:245
ACCEL30_CWAKE_54Hz
@ ACCEL30_CWAKE_54Hz
Definition: accel30.h:342
ACCEL30_CWAKE_0p8Hz
@ ACCEL30_CWAKE_0p8Hz
Definition: accel30.h:337
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:291
accel30_cfg_t::miso
pin_name_t miso
Definition: accel30.h:242
spi_specifics.h
This file contains SPI specific macros, functions, etc.
ACCEL30_SNIFF_SR_0p4Hz
@ ACCEL30_SNIFF_SR_0p4Hz
Definition: accel30.h:362
ACCEL30_RESOLUTION_10BIT
@ ACCEL30_RESOLUTION_10BIT
Definition: accel30.h:322
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:320
accel30_s::chip_select
pin_name_t chip_select
Definition: accel30.h:223
accel30_t
struct accel30_s accel30_t
Accel 30 Click context object.
accel30_s::i2c
i2c_master_t i2c
Definition: accel30.h:219
accel30_s
Accel 30 Click context object.
Definition: accel30.h:214
ACCEL30_RESOLUTION_6BIT
@ ACCEL30_RESOLUTION_6BIT
Definition: accel30.h:319
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:360
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:243
accel30_s::resolution_cfg
uint8_t resolution_cfg
Definition: accel30.h:230
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:421
ACCEL30_RANGE_END
@ ACCEL30_RANGE_END
Definition: accel30.h:309
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:341
accel30_fifo_mode_t
accel30_fifo_mode_t
Accel 30 Click FIFO mode value data.
Definition: accel30.h:381
ACCEL30_SNIFF_SR_100Hz
@ ACCEL30_SNIFF_SR_100Hz
Definition: accel30.h:369
ACCEL30_OK
@ ACCEL30_OK
Definition: accel30.h:266
accel30_axis_t::y
int16_t y
Definition: accel30.h:409
accel30_cfg_t::sck
pin_name_t sck
Definition: accel30.h:244
ACCEL30_SNIFF_SR_2Hz
@ ACCEL30_SNIFF_SR_2Hz
Definition: accel30.h:364
ACCEL30_ULOW_POWER
@ ACCEL30_ULOW_POWER
Definition: accel30.h:397
ACCEL30_CWAKE_14Hz
@ ACCEL30_CWAKE_14Hz
Definition: accel30.h:340
ACCEL30_CWAKE_210Hz
@ ACCEL30_CWAKE_210Hz
Definition: accel30.h:344
accel30_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel30.h:249
ACCEL30_RESERVED_1
@ ACCEL30_RESERVED_1
Definition: accel30.h:395
ACCEL30_SNIFF_SR_50Hz
@ ACCEL30_SNIFF_SR_50Hz
Definition: accel30.h:368
accel30_avg_axis_t::z
float z
Definition: accel30.h:422
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:419
ACCEL30_CWAKE_6Hz
@ ACCEL30_CWAKE_6Hz
Definition: accel30.h:339
accel30_cfg_t
Accel 30 Click configuration object.
Definition: accel30.h:239
accel30_s::read_f
accel30_master_io_t read_f
Definition: accel30.h:227
ACCEL30_RESOLUTION_8BIT
@ ACCEL30_RESOLUTION_8BIT
Definition: accel30.h:321
ACCEL30_SNIFF_SR_END
@ ACCEL30_SNIFF_SR_END
Definition: accel30.h:372
accel30_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel30.h:250
ACCEL30_GAIN_4X
@ ACCEL30_GAIN_4X
Definition: accel30.h:278
ACCEL30_CWAKE_END
@ ACCEL30_CWAKE_END
Definition: accel30.h:351
ACCEL30_CWAKE_400Hz
@ ACCEL30_CWAKE_400Hz
Definition: accel30.h:345
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:197
ACCEL30_SNIFF_SR_DEFAULT_6Hz
@ ACCEL30_SNIFF_SR_DEFAULT_6Hz
Definition: accel30.h:361
ACCEL30_MODE_SLEEP
@ ACCEL30_MODE_SLEEP
Definition: accel30.h:290
accel30_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel30.h:252
accel30_s::range_cfg
uint8_t range_cfg
Definition: accel30.h:229
ACCEL30_RESOLUTION_12BIT
@ ACCEL30_RESOLUTION_12BIT
Definition: accel30.h:323
ACCEL30_MODE_SNIFF
@ ACCEL30_MODE_SNIFF
Definition: accel30.h:292
ACCEL30_SNIFF_SR_400Hz
@ ACCEL30_SNIFF_SR_400Hz
Definition: accel30.h:371
ACCEL30_RANGE_4G
@ ACCEL30_RANGE_4G
Definition: accel30.h:305
accel30_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel30.h:254
ACCEL30_GAIN_1X
@ ACCEL30_GAIN_1X
Definition: accel30.h:279
accel30_cfg_t::int_pin
pin_name_t int_pin
Definition: accel30.h:247
ACCEL30_MODE_CWAKE
@ ACCEL30_MODE_CWAKE
Definition: accel30.h:293
accel30_gain_t
accel30_gain_t
Accel 30 Click gain value data.
Definition: accel30.h:276
ACCEL30_SNIFF_SR_25Hz
@ ACCEL30_SNIFF_SR_25Hz
Definition: accel30.h:367
ACCEL30_DRV_SEL_SPI
@ ACCEL30_DRV_SEL_SPI
Definition: accel30.h:198
ACCEL30_MODE_TRIG
@ ACCEL30_MODE_TRIG
Definition: accel30.h:294
ACCEL30_FIFO_MODE_WATERMARK
@ ACCEL30_FIFO_MODE_WATERMARK
Definition: accel30.h:383
accel30_axis_t::x
int16_t x
Definition: accel30.h:408
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:338
ACCEL30_LOW_POWER
@ ACCEL30_LOW_POWER
Definition: accel30.h:394
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:207
ACCEL30_ERROR
@ ACCEL30_ERROR
Definition: accel30.h:267
ACCEL30_RESOLUTION_14BIT
@ ACCEL30_RESOLUTION_14BIT
Definition: accel30.h:324
ACCEL30_RESERVED_2
@ ACCEL30_RESERVED_2
Definition: accel30.h:396
ACCEL30_CWAKE_RESER0
@ ACCEL30_CWAKE_RESER0
Definition: accel30.h:347
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:382
ACCEL30_CWAKE_RESER2
@ ACCEL30_CWAKE_RESER2
Definition: accel30.h:349
ACCEL30_SNIFF_SR_0p8Hz
@ ACCEL30_SNIFF_SR_0p8Hz
Definition: accel30.h:363
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:370
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:420
ACCEL30_RANGE_16G
@ ACCEL30_RANGE_16G
Definition: accel30.h:308
ACCEL30_SNIFF_SR_13Hz
@ ACCEL30_SNIFF_SR_13Hz
Definition: accel30.h:366
accel30_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel30.h:253
ACCEL30_RESOLUTION_END
@ ACCEL30_RESOLUTION_END
Definition: accel30.h:325
accel30_resolution_t
accel30_resolution_t
Accel 30 Click resolution value data.
Definition: accel30.h:318
ACCEL30_GAIN_DEFAULT
@ ACCEL30_GAIN_DEFAULT
Definition: accel30.h:277
ACCEL30_CWAKE_600Hz
@ ACCEL30_CWAKE_600Hz
Definition: accel30.h:346
ACCEL30_CWAKE_RESER1
@ ACCEL30_CWAKE_RESER1
Definition: accel30.h:348
accel30_s::slave_address
uint8_t slave_address
Definition: accel30.h:222
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:304
ACCEL30_CWAKE_100Hz
@ ACCEL30_CWAKE_100Hz
Definition: accel30.h:343
ACCEL30_RANGE_12G
@ ACCEL30_RANGE_12G
Definition: accel30.h:307
ACCEL30_CWAKE_0p4Hz
@ ACCEL30_CWAKE_0p4Hz
Definition: accel30.h:336
accel30_s::rst
digital_out_t rst
Definition: accel30.h:215
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:398
accel30_s::drv_sel
accel30_drv_t drv_sel
Definition: accel30.h:224
accel30_s::spi
spi_master_t spi
Definition: accel30.h:220
ACCEL30_CWAKE_DEFAULT_50Hz
@ ACCEL30_CWAKE_DEFAULT_50Hz
Definition: accel30.h:335
accel30_op_mode_t
accel30_op_mode_t
Accel 30 Click operating mode value data.
Definition: accel30.h:289
accel30_s::write_f
accel30_master_io_t write_f
Definition: accel30.h:226
accel30_cfg_t::scl
pin_name_t scl
Definition: accel30.h:240
accel30_axis_t
Accel 30 Click Axis structure object.
Definition: accel30.h:407