accel21  2.1.0.0
accel21.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 ACCEL21_H
29 #define ACCEL21_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 ACCEL21_REG_STATUS_AUX 0x07
62 #define ACCEL21_REG_OUT_TEMP_L 0x0C
63 #define ACCEL21_REG_OUT_TEMP_H 0x0D
64 #define ACCEL21_REG_INT_COUNTER 0x0E
65 #define ACCEL21_REG_WHO_AM_I 0x0F
66 #define ACCEL21_REG_TEMP_CFG 0x1F
67 #define ACCEL21_REG_CTRL_REG1 0x20
68 #define ACCEL21_REG_CTRL_REG2 0x21
69 #define ACCEL21_REG_CTRL_REG3 0x22
70 #define ACCEL21_REG_CTRL_REG4 0x23
71 #define ACCEL21_REG_CTRL_REG5 0x24
72 #define ACCEL21_REG_CTRL_REG6 0x25
73 #define ACCEL21_REG_REFERENCE_DATACAPTURE 0x26
74 #define ACCEL21_REG_STATUS 0x27
75 #define ACCEL21_REG_OUT_X_L 0x28
76 #define ACCEL21_REG_OUT_X_H 0x29
77 #define ACCEL21_REG_OUT_Y_L 0x2A
78 #define ACCEL21_REG_OUT_Y_H 0x2B
79 #define ACCEL21_REG_OUT_Z_L 0x2C
80 #define ACCEL21_REG_OUT_Z_H 0x2D
81 #define ACCEL21_REG_FIFO_CTRL 0x2E
82 #define ACCEL21_REG_FIFO_SRC 0x2F
83 #define ACCEL21_REG_INT1_CFG 0x30
84 #define ACCEL21_REG_INT1_SRC 0x31
85 #define ACCEL21_REG_INT1_THS 0x32
86 #define ACCEL21_REG_INT1_DURATION 0x33
87 #define ACCEL21_REG_INT2_CFG 0x34
88 #define ACCEL21_REG_INT2_SRC 0x35
89 #define ACCEL21_REG_INT2_THS 0x36
90 #define ACCEL21_REG_INT2_DURATION 0x37
91 #define ACCEL21_REG_CLICK_CFG 0x38
92 #define ACCEL21_REG_CLICK_SRC 0x39
93 #define ACCEL21_REG_CLICK_THS 0x3A
94 #define ACCEL21_REG_TIME_LIMIT 0x3B
95 #define ACCEL21_REG_TIME_LATENCY 0x3C
96 #define ACCEL21_REG_ACT_THS 0x3E
97 #define ACCEL21_REG_ACT_DUR 0x3F
98  // accel21_reg
100 
115 #define ACCEL21_STATUS_AUX_TDA_BIT_MASK 0x04
116 #define ACCEL21_STATUS_AUX_TOR_BIT_MASK 0x40
117 
118 #define ACCEL21_TEMP_CFG_TEMP_EN_BIT_MASK 0xC0
119 
120 #define ACCEL21_WHO_AM_I 0x33
121 
122 #define ACCEL21_OP_MODE_NORMAL 0x00
123 #define ACCEL21_OP_MODE_HIGH_RESOLUTION 0x01
124 #define ACCEL21_OP_MODE_LOW_POWER 0x02
125 #define ACCEL21_OP_MODE_NOT_ALLOWED 0x02
126 #define ACCEL21_CTRL_OP_MODE_BIT_MASK 0x08
127 
128 #define ACCEL21_STATUS_NEW_DATA_AVL_BIT_MASK 0x08
129 #define ACCEL21_STATUS_DATA_OVERRUN_BIT_MASK 0x80
130 
131 #define ACCEL21_CTRL_REG1_ODR_PWR_DOWN_MODE 0x00
132 #define ACCEL21_CTRL_REG1_ODR_1_Hz 0x01
133 #define ACCEL21_CTRL_REG1_ODR_10_Hz 0x02
134 #define ACCEL21_CTRL_REG1_ODR_25_Hz 0x03
135 #define ACCEL21_CTRL_REG1_ODR_50_Hz 0x04
136 #define ACCEL21_CTRL_REG1_ODR_100_Hz 0x05
137 #define ACCEL21_CTRL_REG1_ODR_200_Hz 0x06
138 #define ACCEL21_CTRL_REG1_ODR_400_Hz 0x07
139 #define ACCEL21_CTRL_REG1_ODR_1_62_kHz 0x08
140 #define ACCEL21_CTRL_REG1_ODR_1_344_kHz 0x09
141 #define ACCEL21_CTRL_REG1_ODR_BIT_MASK 0xF0
142 
143 #define ACCEL21_CTRL_REG1_LPEN_DISABLE 0x00
144 #define ACCEL21_CTRL_REG1_LPEN_ENABLE 0x01
145 #define ACCEL21_CTRL_REG1_LPEN_BIT_MASK 0x08
146 
147 #define ACCEL21_CTRL_REG1_XYZEN_DISABLE 0x00
148 #define ACCEL21_CTRL_REG1_XYZEN_ENABLE 0x01
149 #define ACCEL21_CTRL_REG1_ZEN_BIT_MASK 0x04
150 #define ACCEL21_CTRL_REG1_YEN_BIT_MASK 0x02
151 #define ACCEL21_CTRL_REG1_XEN_BIT_MASK 0x01
152 
153 #define ACCEL21_CTRL_REG4_BDU_CONTIN_UPDATE 0x00
154 #define ACCEL21_CTRL_REG4_BDU_NOT_UPDATE 0x01
155 #define ACCEL21_CTRL_REG4_BDU_BIT_MASK 0x80
156 
157 #define ACCEL21_CTRL_REG4_FS_2_g 0x00
158 #define ACCEL21_CTRL_REG4_FS_4_g 0x01
159 #define ACCEL21_CTRL_REG4_FS_10_g 0x02
160 #define ACCEL21_CTRL_REG4_FS_16_g 0x03
161 #define ACCEL21_CTRL_REG4_FS_BIT_MASK 0x30
162 
163 #define ACCEL21_CTRL_REG4_HR_DISABLE 0x00
164 #define ACCEL21_CTRL_REG4_HR_ENABLE 0x01
165 #define ACCEL21_CTRL_REG1_HR_BIT_MASK 0x08
166 
172 #define ACCEL21_DEVICE_ADDRESS_GND 0x18
173 #define ACCEL21_DEVICE_ADDRESS_VCC 0x19
174 
183 #define ACCEL21_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
184 #define ACCEL21_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
185  // accel21_set
187 
202 #define ACCEL21_MAP_MIKROBUS( cfg, mikrobus ) \
203  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
204  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
205  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
206  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
207  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
208  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
209  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
210  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
211  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_INT )
212  // accel21_map // accel21
215 
220 typedef enum
221 {
226 
231 typedef err_t ( *accel21_master_io_t )( struct accel21_s*, uint8_t, uint8_t*, uint8_t );
237 typedef struct accel21_s
238 {
239  digital_out_t rst;
241  digital_in_t in1;
242  digital_in_t in2;
244  i2c_master_t i2c;
245  spi_master_t spi;
247  uint8_t slave_address;
248  pin_name_t chip_select;
255 
260 typedef struct
261 {
262  pin_name_t scl;
263  pin_name_t sda;
264  pin_name_t miso;
265  pin_name_t mosi;
266  pin_name_t sck;
267  pin_name_t cs;
268  pin_name_t rst;
269  pin_name_t in1;
270  pin_name_t in2;
272  uint32_t i2c_speed;
273  uint8_t i2c_address;
275  uint32_t spi_speed;
276  spi_master_mode_t spi_mode;
277  spi_master_chip_select_polarity_t cs_polarity;
281 } accel21_cfg_t;
282 
287 typedef enum
288 {
290  ACCEL21_ERROR = -1
291 
293 
298 typedef struct
299 {
300  int16_t x;
301  int16_t y;
302  int16_t z;
303 
305 
310 typedef struct
311 {
312  uint8_t odr;
313  uint8_t lpen;
314  uint8_t zen;
315  uint8_t yen;
316  uint8_t xen;
317  uint8_t bdu;
318  uint8_t fs;
319  uint8_t hr;
320 
322 
339 
355 
369 err_t accel21_init ( accel21_t *ctx, accel21_cfg_t *cfg );
370 
384 
399 err_t accel21_generic_write ( accel21_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
400 
415 err_t accel21_generic_read ( accel21_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
416 
431 err_t accel21_get_temp_status ( accel21_t *ctx, uint8_t *temp_status );
432 
449 err_t accel21_check_temp_data_ready ( accel21_t *ctx, uint8_t *temp_data_ready );
450 
464 
481 err_t accel21_check_temp_data_ovr ( accel21_t *ctx, uint8_t *temp_data_ovr );
482 
500 err_t accel21_get_temp_data ( accel21_t *ctx, int16_t *temp_data );
501 
519 err_t accel21_get_temperature ( accel21_t *ctx, float *temperature );
520 
537 err_t accel21_set_op_mode ( accel21_t *ctx, uint8_t op_mode );
538 
555 err_t accel21_get_op_mode ( accel21_t *ctx, uint8_t *op_mode );
556 
570 err_t accel21_get_device_id ( accel21_t *ctx, uint8_t *device_id );
571 
585 
599 err_t accel21_get_status ( accel21_t *ctx, uint8_t *status );
600 
615 err_t accel21_check_data_overrun ( accel21_t *ctx, uint8_t *data_overrun );
616 
633 err_t accel21_check_new_data ( accel21_t *ctx, uint8_t *new_data_avl );
634 
650 
665 err_t accel21_get_axis ( accel21_t *ctx, accel21_axis_t *acc_axis );
666 
681 
696 
697 #ifdef __cplusplus
698 }
699 #endif
700 #endif // ACCEL21_H
701  // accel21
703 
704 // ------------------------------------------------------------------------ END
accel21_cfg_t::sda
pin_name_t sda
Definition: accel21.h:263
accel21_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel21.h:277
accel21_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel21.h:273
accel21_config_t::fs
uint8_t fs
Definition: accel21.h:318
accel21_config_t::lpen
uint8_t lpen
Definition: accel21.h:313
accel21_cfg_t::rst
pin_name_t rst
Definition: accel21.h:268
accel21_s
Accel 21 Click context object.
Definition: accel21.h:238
accel21_s::drv_sel
accel21_drv_t drv_sel
Definition: accel21.h:249
spi_specifics.h
This file contains SPI specific macros, functions, etc.
accel21_get_axis
err_t accel21_get_axis(accel21_t *ctx, accel21_axis_t *acc_axis)
Accel 21 get accel data function.
ACCEL21_OK
@ ACCEL21_OK
Definition: accel21.h:289
accel21_s::slave_address
uint8_t slave_address
Definition: accel21.h:247
accel21_get_op_mode
err_t accel21_get_op_mode(accel21_t *ctx, uint8_t *op_mode)
Accel 21 get operating mode function.
accel21_set_config
err_t accel21_set_config(accel21_t *ctx, accel21_config_t config)
Accel 21 set config function.
accel21_get_status
err_t accel21_get_status(accel21_t *ctx, uint8_t *status)
Accel 21 get status function.
accel21_axis_t::y
int16_t y
Definition: accel21.h:301
accel21_cfg_t::drv_sel
accel21_drv_t drv_sel
Definition: accel21.h:279
accel21_get_temp_data
err_t accel21_get_temp_data(accel21_t *ctx, int16_t *temp_data)
Accel 21 get temperature data function.
accel21_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel21.h:276
accel21_check_new_data
err_t accel21_check_new_data(accel21_t *ctx, uint8_t *new_data_avl)
Accel 21 check accel data ready function.
accel21_return_value_t
accel21_return_value_t
Accel 21 Click return value data.
Definition: accel21.h:288
accel21_cfg_setup
void accel21_cfg_setup(accel21_cfg_t *cfg)
Accel 21 configuration object setup function.
accel21_cfg_t::mosi
pin_name_t mosi
Definition: accel21.h:265
accel21_config_t::xen
uint8_t xen
Definition: accel21.h:316
accel21_s::read_f
accel21_master_io_t read_f
Definition: accel21.h:252
accel21_cfg_t::cs
pin_name_t cs
Definition: accel21.h:267
accel21_s::in1
digital_in_t in1
Definition: accel21.h:241
accel21_s::in2
digital_in_t in2
Definition: accel21.h:242
accel21_init
err_t accel21_init(accel21_t *ctx, accel21_cfg_t *cfg)
Accel 21 initialization function.
accel21_check_id
err_t accel21_check_id(accel21_t *ctx)
Accel 21 check device ID function.
accel21_check_data_overrun
err_t accel21_check_data_overrun(accel21_t *ctx, uint8_t *data_overrun)
Accel 21 check accel overrun function.
accel21_check_temp_data_ovr
err_t accel21_check_temp_data_ovr(accel21_t *ctx, uint8_t *temp_data_ovr)
Accel 21 check temperature overrun function.
accel21_enable_temp_data
err_t accel21_enable_temp_data(accel21_t *ctx)
Accel 21 enable temperature data function.
accel21_cfg_t
Accel 21 Click configuration object.
Definition: accel21.h:261
accel21_s::rst
digital_out_t rst
Definition: accel21.h:239
accel21_drv_interface_selection
void accel21_drv_interface_selection(accel21_cfg_t *cfg, accel21_drv_t drv_sel)
Accel 21 driver interface setup function.
accel21_s::chip_select
pin_name_t chip_select
Definition: accel21.h:248
accel21_get_in1_pin
uint8_t accel21_get_in1_pin(accel21_t *ctx)
Accel 21 get interrupt 1 function.
accel21_s::spi
spi_master_t spi
Definition: accel21.h:245
accel21_s::i2c
i2c_master_t i2c
Definition: accel21.h:244
accel21_get_in2_pin
uint8_t accel21_get_in2_pin(accel21_t *ctx)
Accel 21 get interrupt 2 function.
accel21_cfg_t::scl
pin_name_t scl
Definition: accel21.h:262
accel21_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel21.h:275
accel21_s::write_f
accel21_master_io_t write_f
Definition: accel21.h:251
accel21_config_t::odr
uint8_t odr
Definition: accel21.h:312
ACCEL21_DRV_SEL_I2C
@ ACCEL21_DRV_SEL_I2C
Definition: accel21.h:223
accel21_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel21.h:272
accel21_t
struct accel21_s accel21_t
Accel 21 Click context object.
accel21_default_cfg
err_t accel21_default_cfg(accel21_t *ctx)
Accel 21 default configuration function.
accel21_config_t::yen
uint8_t yen
Definition: accel21.h:315
ACCEL21_ERROR
@ ACCEL21_ERROR
Definition: accel21.h:290
accel21_axis_t::x
int16_t x
Definition: accel21.h:300
accel21_cfg_t::in1
pin_name_t in1
Definition: accel21.h:269
accel21_drv_t
accel21_drv_t
Accel 21 Click driver selector.
Definition: accel21.h:221
accel21_config_t
Accel 21 Click configuration structure object.
Definition: accel21.h:311
accel21_config_t::bdu
uint8_t bdu
Definition: accel21.h:317
accel21_config_t::zen
uint8_t zen
Definition: accel21.h:314
accel21_get_temperature
err_t accel21_get_temperature(accel21_t *ctx, float *temperature)
Accel 21 get temperature function.
accel21_generic_read
err_t accel21_generic_read(accel21_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Accel 21 data reading function.
accel21_axis_t::z
int16_t z
Definition: accel21.h:302
accel21_set_op_mode
err_t accel21_set_op_mode(accel21_t *ctx, uint8_t op_mode)
Accel 21 set operating mode function.
ACCEL21_DRV_SEL_SPI
@ ACCEL21_DRV_SEL_SPI
Definition: accel21.h:222
accel21_cfg_t::miso
pin_name_t miso
Definition: accel21.h:264
accel21_check_temp_data_ready
err_t accel21_check_temp_data_ready(accel21_t *ctx, uint8_t *temp_data_ready)
Accel 21 check temperature data ready function.
accel21_master_io_t
err_t(* accel21_master_io_t)(struct accel21_s *, uint8_t, uint8_t *, uint8_t)
Accel 21 Click driver interface.
Definition: accel21.h:231
accel21_cfg_t::sck
pin_name_t sck
Definition: accel21.h:266
accel21_get_device_id
err_t accel21_get_device_id(accel21_t *ctx, uint8_t *device_id)
Accel 21 get device ID function.
accel21_generic_write
err_t accel21_generic_write(accel21_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Accel 21 data writing function.
accel21_axis_t
Accel 21 Click Axis structure object.
Definition: accel21.h:299
accel21_config_t::hr
uint8_t hr
Definition: accel21.h:319
accel21_get_temp_status
err_t accel21_get_temp_status(accel21_t *ctx, uint8_t *temp_status)
Accel 21 get temperature status function.
accel21_cfg_t::in2
pin_name_t in2
Definition: accel21.h:270