accel19  2.0.0.0
accel19.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 ACCEL19_H
29 #define ACCEL19_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 ACCEL19_REG_OUT_T_L 0x0D
62 #define ACCEL19_REG_OUT_T_H 0x0E
63 #define ACCEL19_REG_WHO_AM_I 0x0F
64 #define ACCEL19_REG_CTRL1 0x20
65 #define ACCEL19_REG_CTRL2 0x21
66 #define ACCEL19_REG_CTRL3 0x22
67 #define ACCEL19_REG_CTRL4_INT1_PAD_CTRL 0x23
68 #define ACCEL19_REG_CTRL5_INT2_PAD_CTRL 0x24
69 #define ACCEL19_REG_CTRL6 0x25
70 #define ACCEL19_REG_STATUS 0x27
71 #define ACCEL19_REG_OUT_X_L 0x28
72 #define ACCEL19_REG_OUT_X_H 0x29
73 #define ACCEL19_REG_OUT_Y_L 0x2A
74 #define ACCEL19_REG_OUT_Y_H 0x2B
75 #define ACCEL19_REG_OUT_Z_L 0x2C
76 #define ACCEL19_REG_OUT_Z_H 0x2D
77 #define ACCEL19_REG_FIFO_CTRL 0x2E
78 #define ACCEL19_REG_FIFO_SAMPLES 0x2F
79 #define ACCEL19_REG_TAP_THS_X 0x30
80 #define ACCEL19_REG_TAP_THS_Y 0x31
81 #define ACCEL19_REG_TAP_THS_Z 0x32
82 #define ACCEL19_REG_INT_DUR 0x33
83 #define ACCEL19_REG_WAKE_UP_THS 0x34
84 #define ACCEL19_REG_WAKE_UP_DUR 0x35
85 #define ACCEL19_REG_FREE_FALL 0x36
86 #define ACCEL19_REG_STATUS_DUP 0x37
87 #define ACCEL19_REG_WAKE_UP_SRC 0x38
88 #define ACCEL19_REG_TAP_SRC 0x39
89 #define ACCEL19_REG_SIXD_SRC 0x3A
90 #define ACCEL19_REG_ALL_INT_SRC 0x3B
91 #define ACCEL19_REG_X_OFS_USR 0x3C
92 #define ACCEL19_REG_Y_OFS_USR 0x3D
93 #define ACCEL19_REG_Z_OFS_USR 0x3E
94 #define ACCEL19_REG_CTRL7 0x3F
95  // accel19_reg
97 
112 #define ACCEL19_DEVICE_ID 0x44
113 
118 #define ACCEL19_CNTL1_ODR_BIT_MASK 0xF0
119 #define ACCEL19_CNTL1_ODR_POWER_DOWN 0x00
120 #define ACCEL19_CNTL1_ODR_LP_1_6_Hz 0x10
121 #define ACCEL19_CNTL1_ODR_HP_12_5_Hz 0x10
122 #define ACCEL19_CNTL1_ODR_HP_LP_12_5_Hz 0x20
123 #define ACCEL19_CNTL1_ODR_HP_LP_25_Hz 0x30
124 #define ACCEL19_CNTL1_ODR_HP_LP_50_Hz 0x40
125 #define ACCEL19_CNTL1_ODR_HP_LP_100_Hz 0x50
126 #define ACCEL19_CNTL1_ODR_HP_LP_200_Hz 0x60
127 #define ACCEL19_CNTL1_ODR_LP_200_Hz 0x70
128 #define ACCEL19_CNTL1_ODR_HP_400_Hz 0x70
129 #define ACCEL19_CNTL1_ODR_HP_800_Hz 0x80
130 #define ACCEL19_CNTL1_ODR_HP_1600_Hz 0x90
131 
136 #define ACCEL19_CNTL1_OP_MODE_BIT_MASK 0x0C
137 #define ACCEL19_CNTL1_OP_MODE_LOW_POWER_MODE 0x00
138 #define ACCEL19_CNTL1_OP_MODE_HIGH_POWER_MODE 0x04
139 #define ACCEL19_CNTL1_OP_MODE_SINGLE_DATA_CONV 0x08
140 
145 #define ACCEL19_CNTL1_LP_MODE_BIT_MASK 0x03
146 #define ACCEL19_CNTL1_LP_MODE1_RES_12_bit 0x00
147 #define ACCEL19_CNTL1_LP_MODE2_RES_14_bit 0x01
148 #define ACCEL19_CNTL1_LP_MODE3_RES_14_bit 0x02
149 #define ACCEL19_CNTL1_LP_MODE4_RES_14_bit 0x03
150 
155 #define ACCEL19_CNTL2_SOFT_RESET 0x40
156 
161 #define ACCEL19_INT_DRDY 0x00
162 #define ACCEL19_STATUS_DRDY 0x01
163 
168 #define ACCEL19_CTRL6_BW_FILT_BIT_MASK 0xC0
169 #define ACCEL19_CTRL6_BW_FILT_ODR_2 0x00
170 #define ACCEL19_CTRL6_BW_FILT_ODR_4 0x80
171 #define ACCEL19_CTRL6_BW_FILT_ODR_10 0x40
172 #define ACCEL19_CTRL6_BW_FILT_ODR_20 0xC0
173 
178 #define ACCEL19_CTRL6_FS_BIT_MASK 0x30
179 #define ACCEL19_CTRL6_FS_2g 0x00
180 #define ACCEL19_CTRL6_FS_4g 0x20
181 #define ACCEL19_CTRL6_FS_8g 0x10
182 #define ACCEL19_CTRL6_FS_16g 0x30
183 
189 #define ACCEL19_SET_DEV_ADDR_0 0x18
190 #define ACCEL19_SET_DEV_ADDR_1 0x19
191 
200 #define ACCEL19_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
201 #define ACCEL19_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
202  // accel19_set
204 
219 #define ACCEL19_MAP_MIKROBUS( cfg, mikrobus ) \
220  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
221  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
222  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
223  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
224  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
225  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
226  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
227  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_INT )
228  // accel19_map // accel19
231 
236 typedef enum
237 {
242 
247 typedef err_t ( *accel19_master_io_t )( struct accel19_s*, uint8_t, uint8_t*, uint8_t );
253 typedef struct accel19_s
254 {
255  digital_in_t in2;
256  digital_in_t in1;
258  i2c_master_t i2c;
259  spi_master_t spi;
261  uint8_t slave_address;
262  pin_name_t chip_select;
269 
274 typedef struct
275 {
276  pin_name_t scl;
277  pin_name_t sda;
278  pin_name_t miso;
279  pin_name_t mosi;
280  pin_name_t sck;
281  pin_name_t cs;
283  pin_name_t in2;
284  pin_name_t in1;
286  uint32_t i2c_speed;
287  uint8_t i2c_address;
289  uint32_t spi_speed;
290  spi_master_mode_t spi_mode;
291  spi_master_chip_select_polarity_t cs_polarity;
295 } accel19_cfg_t;
296 
301 typedef struct
302 {
303  int16_t x;
304  int16_t y;
305  int16_t z;
306 
308 
313 typedef enum
314 {
316  ACCEL19_ERROR = -1
317 
319 
336 
352 
367 err_t accel19_init ( accel19_t *ctx, accel19_cfg_t *cfg );
368 
383 
399 err_t accel19_generic_write ( accel19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
400 
416 err_t accel19_generic_read ( accel19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
417 
432 err_t accel19_get_temperature ( accel19_t *ctx, float *temperature );
433 
448 
465 err_t accel19_set_control ( accel19_t *ctx, uint8_t odr, uint8_t op_mode, uint8_t lp_mode );
466 
481 
496 err_t accel19_get_status ( accel19_t *ctx, uint8_t *status );
497 
512 
527 err_t accel19_set_full_scale ( accel19_t *ctx, uint8_t full_scale );
528 
543 err_t accel19_set_bw_filt_odr ( accel19_t *ctx, uint8_t bw_filt_odr );
544 
560 
573 uint8_t accel19_get_int_1 ( accel19_t *ctx );
574 
587 uint8_t accel19_get_int_2 ( accel19_t *ctx );
588 
589 #ifdef __cplusplus
590 }
591 #endif
592 #endif // ACCEL19_H
593  // accel19
595 
596 // ------------------------------------------------------------------------ END
accel19_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel19.h:287
accel19_cfg_t::drv_sel
accel19_drv_t drv_sel
Definition: accel19.h:293
accel19_s::in2
digital_in_t in2
Definition: accel19.h:255
accel19_drv_t
accel19_drv_t
Accel 19 Click driver selector.
Definition: accel19.h:237
accel19_set_full_scale
err_t accel19_set_full_scale(accel19_t *ctx, uint8_t full_scale)
Accel 19 set full scale function.
accel19_set_bw_filt_odr
err_t accel19_set_bw_filt_odr(accel19_t *ctx, uint8_t bw_filt_odr)
Accel 19 set digital filtering cutoff function.
accel19_axis_t
Accel 19 axis data structure.
Definition: accel19.h:302
ACCEL19_DRV_SEL_I2C
@ ACCEL19_DRV_SEL_I2C
Definition: accel19.h:239
spi_specifics.h
This file contains SPI specific macros, functions, etc.
accel19_axis_t::x
int16_t x
Definition: accel19.h:303
accel19_s::spi
spi_master_t spi
Definition: accel19.h:259
ACCEL19_DRV_SEL_SPI
@ ACCEL19_DRV_SEL_SPI
Definition: accel19.h:238
accel19_check_device_id
err_t accel19_check_device_id(accel19_t *ctx)
Accel 19 check device ID function.
accel19_cfg_t::scl
pin_name_t scl
Definition: accel19.h:276
accel19_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel19.h:290
accel19_cfg_t::miso
pin_name_t miso
Definition: accel19.h:278
accel19_cfg_t
Accel 19 Click configuration object.
Definition: accel19.h:275
accel19_get_int_2
uint8_t accel19_get_int_2(accel19_t *ctx)
Accel 19 get Interrupt 2 function.
accel19_cfg_t::sck
pin_name_t sck
Definition: accel19.h:280
accel19_return_value_t
accel19_return_value_t
Accel 19 Click return value data.
Definition: accel19.h:314
accel19_default_cfg
err_t accel19_default_cfg(accel19_t *ctx)
Accel 19 default configuration function.
accel19_get_status
err_t accel19_get_status(accel19_t *ctx, uint8_t *status)
Accel 19 get status function.
accel19_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel19.h:291
accel19_axis_t::z
int16_t z
Definition: accel19.h:305
accel19_t
struct accel19_s accel19_t
Accel 19 Click context object.
accel19_get_temperature
err_t accel19_get_temperature(accel19_t *ctx, float *temperature)
Accel 19 get temperature function.
accel19_generic_read
err_t accel19_generic_read(accel19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Accel 19 data reading function.
accel19_s::read_f
accel19_master_io_t read_f
Definition: accel19.h:266
accel19_cfg_t::in2
pin_name_t in2
Definition: accel19.h:283
accel19_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel19.h:289
accel19_drv_interface_selection
void accel19_drv_interface_selection(accel19_cfg_t *cfg, accel19_drv_t drv_sel)
Accel 19 driver interface setup function.
ACCEL19_OK
@ ACCEL19_OK
Definition: accel19.h:315
accel19_cfg_t::sda
pin_name_t sda
Definition: accel19.h:277
accel19_data_ready
uint8_t accel19_data_ready(accel19_t *ctx)
Accel 19 data ready function.
accel19_init
err_t accel19_init(accel19_t *ctx, accel19_cfg_t *cfg)
Accel 19 initialization function.
accel19_cfg_setup
void accel19_cfg_setup(accel19_cfg_t *cfg)
Accel 19 configuration object setup function.
accel19_s
Accel 19 Click context object.
Definition: accel19.h:254
accel19_cfg_t::mosi
pin_name_t mosi
Definition: accel19.h:279
accel19_s::write_f
accel19_master_io_t write_f
Definition: accel19.h:265
accel19_cfg_t::in1
pin_name_t in1
Definition: accel19.h:284
accel19_master_io_t
err_t(* accel19_master_io_t)(struct accel19_s *, uint8_t, uint8_t *, uint8_t)
Accel 19 Click driver interface.
Definition: accel19.h:247
accel19_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel19.h:286
ACCEL19_ERROR
@ ACCEL19_ERROR
Definition: accel19.h:316
accel19_set_control
err_t accel19_set_control(accel19_t *ctx, uint8_t odr, uint8_t op_mode, uint8_t lp_mode)
Accel 19 set control function.
accel19_s::slave_address
uint8_t slave_address
Definition: accel19.h:261
accel19_s::in1
digital_in_t in1
Definition: accel19.h:256
accel19_get_axis_data
err_t accel19_get_axis_data(accel19_t *ctx, accel19_axis_t *axis)
Accel 19 get accelerometer axis function.
accel19_s::drv_sel
accel19_drv_t drv_sel
Definition: accel19.h:263
accel19_get_int_1
uint8_t accel19_get_int_1(accel19_t *ctx)
Accel 19 get Interrupt 1 function.
accel19_axis_t::y
int16_t y
Definition: accel19.h:304
accel19_generic_write
err_t accel19_generic_write(accel19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Accel 19 data writing function.
accel19_soft_reset
err_t accel19_soft_reset(accel19_t *ctx)
Accel 19 soft reset function.
accel19_s::chip_select
pin_name_t chip_select
Definition: accel19.h:262
accel19_s::i2c
i2c_master_t i2c
Definition: accel19.h:258
accel19_cfg_t::cs
pin_name_t cs
Definition: accel19.h:281