accel18  2.0.0.0
accel18.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 ACCEL18_H
29 #define ACCEL18_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 ACCEL18_REG_DEVICE_STATUS 0x05
62 #define ACCEL18_REG_INTERRUPT_ENABLE 0x06
63 #define ACCEL18_REG_MODE 0x07
64 #define ACCEL18_REG_SAMPLE_RATE 0x08
65 #define ACCEL18_REG_MOTION_CONTROL 0x09
66 #define ACCEL18_REG_FIFO_STATUS 0x0A
67 #define ACCEL18_REG_FIFO_READ_POINTER 0x0B
68 #define ACCEL18_REG_FIFO_WRITE_POINTER 0x0C
69 #define ACCEL18_REG_XOUT_ACCEL_DATA_LSB 0x0D
70 #define ACCEL18_REG_XOUT_ACCEL_DATA_MSB 0x0E
71 #define ACCEL18_REG_YOUT_ACCEL_DATA_LSB 0x0F
72 #define ACCEL18_REG_YOUT_ACCEL_DATA_MSB 0x10
73 #define ACCEL18_REG_ZOUT_ACCEL_DATA_LSB 0x11
74 #define ACCEL18_REG_ZOUT_ACCEL_DATA_MSB 0x12
75 #define ACCEL18_REG_STATUS 0x13
76 #define ACCEL18_REG_INTERRUPT_STATUS 0x14
77 #define ACCEL18_REG_RANGE_SELECTION 0x20
78 #define ACCEL18_REG_X_OFFSET_LSB 0x21
79 #define ACCEL18_REG_X_OFFSET_MSB 0x22
80 #define ACCEL18_REG_Y_OFFSET_LSB 0x23
81 #define ACCEL18_REG_Y_OFFSET_MSB 0x24
82 #define ACCEL18_REG_Z_OFFSET_LSB 0x25
83 #define ACCEL18_REG_Z_OFFSET_MSB 0x26
84 #define ACCEL18_REG_X_GAIN 0x27
85 #define ACCEL18_REG_Y_GAIN 0x28
86 #define ACCEL18_REG_Z_GAIN 0x29
87 #define ACCEL18_REG_FIFO_CONTROL 0x2D
88 #define ACCEL18_REG_FIFO_THRESHOLD 0x2E
89 #define ACCEL18_REG_FIFO_INTERRUPT_STATUS 0x2F
90 #define ACCEL18_REG_FIFO_CONTROL2 0x30
91 #define ACCEL18_REG_COMMUNICATION_CONTROL 0x31
92 #define ACCEL18_REG_GPIO_CONTROL 0x33
93 #define ACCEL18_REG_TILT_FLIP_THRESHOLD_LSB 0x40
94 #define ACCEL18_REG_TILT_FLIP_THRESHOLD_MSB 0x41
95 #define ACCEL18_REG_TILT_FLIP_DEBOUNCE 0x42
96 #define ACCEL18_REG_ANY_MOTION_THRESHOLD_LSB 0x43
97 #define ACCEL18_REG_ANY_MOTION_THRESHOLD_MSB 0x44
98 #define ACCEL18_REG_ANY_MOTION_DEBOUNCE 0x45
99 #define ACCEL18_REG_SNAKE_THRESHOLD_LSB 0x46
100 #define ACCEL18_REG_SNAKE_THRESHOLD_MSB 0x47
101 #define ACCEL18_REG_PEAK_TO_PEAK_DURATION_LSB 0x48
102 #define ACCEL18_REG_SNAKE_PEAK_TO_PEAK_DURATION_MSB 0x49
103 #define ACCEL18_REG_TIMER 0x4A
104 #define ACCEL18_REG_READ_COUNT 0x4B
105 
106  // accel18_reg
108 
123 #define ACCEL18_STATE_STANDBY 0x00
124 #define ACCEL18_STATE_WAKE 0x01
125 
130 #define ACCEL18_INT_TILT_EN 0x01
131 #define ACCEL18_INT_FLIP_EN 0x02
132 #define ACCEL18_INT_ANYM_EN 0x04
133 #define ACCEL18_INT_SHAKE_EN 0x08
134 #define ACCEL18_INT_TILT_35_EN 0x10
135 #define ACCEL18_INT_AUTO_CLR_EN 0x40
136 #define ACCEL18_INT_ACQ_EN 0x80
137 
142 #define ACCEL18_RATE_25 0x10
143 #define ACCEL18_RATE_50 0x11
144 #define ACCEL18_RATE_62p5 0x12
145 #define ACCEL18_RATE_100 0x13
146 #define ACCEL18_RATE_125 0x14
147 #define ACCEL18_RATE_250 0x15
148 #define ACCEL18_RATE_500 0x16
149 #define ACCEL18_RATE_1000 0x17
150 
155 #define ACCEL18_MOTION_TF_EN 0x01
156 #define ACCEL18_MOTION_LATCH 0x02
157 #define ACCEL18_MOTION_ANYM_EN 0x04
158 #define ACCEL18_MOTION_SHAKE_EN 0x08
159 #define ACCEL18_MOTION_TILT_35 0x10
160 #define ACCEL18_MOTION_Z_AXIS_ORT 0x20
161 #define ACCEL18_MOTION_RAW_PROC_STAT 0x40
162 #define ACCEL18_MOTION_RESET 0x80
163 
168 #define ACCEL18_STATUS_TILT 0x01
169 #define ACCEL18_STATUS_FLIP 0x02
170 #define ACCEL18_STATUS_ANYM 0x04
171 #define ACCEL18_STATUS_SHAKE 0x08
172 #define ACCEL18_STATUS_TILT35 0x10
173 #define ACCEL18_STATUS_FIFO 0x20
174 #define ACCEL18_STATUS_NEW_DATA 0x80
175 
180 #define ACCEL18_RANGE_2G 0x00
181 #define ACCEL18_RANGE_4G 0x10
182 #define ACCEL18_RANGE_8G 0x20
183 #define ACCEL18_RANGE_16G 0x30
184 #define ACCEL18_RANGE_12G 0x40
185 #define ACCEL18_LOW_PASS_FILTER_EN 0x08
186 #define ACCEL18_LOW_PASS_FILTER_DIV4p255 0x01
187 #define ACCEL18_LOW_PASS_FILTER_DIV6 0x02
188 #define ACCEL18_LOW_PASS_FILTER_DIV12 0x03
189 #define ACCEL18_LOW_PASS_FILTER_DIV16 0x05
190 
196 #define ACCEL18_GND_ADDR 0x4C
197 #define ACCEL18_VCC_ADDR 0x6C
198 #define ACCEL18_SET_DEV_ADDR ACCEL18_GND_ADDR
199 
208 #define ACCEL18_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
209 #define ACCEL18_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
210  // accel18_set
212 
227 #define ACCEL18_MAP_MIKROBUS( cfg, mikrobus ) \
228  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
229  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
230  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
231  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
232  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
233  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
234  cfg.i1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
235  cfg.i2 = MIKROBUS( mikrobus, MIKROBUS_INT )
236  // accel18_map // accel18
239 
244 typedef enum
245 {
249 } accel18_drv_t;
250 
255 typedef err_t ( *accel18_master_io_t )( struct accel18_s*, uint8_t, uint8_t*, uint8_t );
261 typedef struct accel18_s
262 {
263  digital_in_t i1;
264  digital_in_t i2;
266  i2c_master_t i2c;
267  spi_master_t spi;
269  uint8_t slave_address;
270  pin_name_t chip_select;
278 } accel18_t;
279 
284 typedef struct
285 {
286  pin_name_t scl;
287  pin_name_t sda;
288  pin_name_t miso;
289  pin_name_t mosi;
290  pin_name_t sck;
291  pin_name_t cs;
292  pin_name_t i1;
293  pin_name_t i2;
295  uint32_t i2c_speed;
296  uint8_t i2c_address;
298  uint32_t spi_speed;
299  spi_master_mode_t spi_mode;
300  spi_master_chip_select_polarity_t cs_polarity;
304 } accel18_cfg_t;
305 
310 typedef struct
311 {
312  float x;
313  float y;
314  float z;
317 
322 typedef enum
323 {
326 
328 
344 void accel18_cfg_setup ( accel18_cfg_t *cfg );
345 
361 
376 err_t accel18_init ( accel18_t *ctx, accel18_cfg_t *cfg );
377 
391 err_t accel18_default_cfg ( accel18_t *ctx );
392 
408 err_t accel18_generic_write ( accel18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
409 
423 err_t accel18_byte_write ( accel18_t *ctx, uint8_t reg, uint8_t data_in );
424 
440 err_t accel18_generic_read ( accel18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
441 
455 err_t accel18_byte_read ( accel18_t *ctx, uint8_t reg, uint8_t *data_out );
456 
470 err_t accel18_read_axes ( accel18_t *ctx, accel18_axes_t *axes_data );
471 
485 err_t accel18_set_range ( accel18_t *ctx, uint8_t range_macro );
486 
494 uint8_t accel18_get_interrupt_1 ( accel18_t *ctx );
495 
503 uint8_t accel18_get_interrupt_2 ( accel18_t *ctx );
504 
505 #ifdef __cplusplus
506 }
507 #endif
508 #endif // ACCEL18_H
509  // accel18
511 
512 // ------------------------------------------------------------------------ END
accel18_cfg_t::miso
pin_name_t miso
Definition: accel18.h:288
accel18_s::drv_sel
accel18_drv_t drv_sel
Definition: accel18.h:271
accel18_s::read_f
accel18_master_io_t read_f
Definition: accel18.h:274
accel18_get_interrupt_2
uint8_t accel18_get_interrupt_2(accel18_t *ctx)
Get interrupt 2 pin state.
ACCEL18_DRV_SEL_I2C
Definition: accel18.h:247
accel18_cfg_t::mosi
pin_name_t mosi
Definition: accel18.h:289
accel18_init
err_t accel18_init(accel18_t *ctx, accel18_cfg_t *cfg)
Accel 18 initialization function.
accel18_cfg_setup
void accel18_cfg_setup(accel18_cfg_t *cfg)
Accel 18 configuration object setup function.
ACCEL18_OK
Definition: accel18.h:324
accel18_cfg_t::scl
pin_name_t scl
Definition: accel18.h:286
accel18_set_range
err_t accel18_set_range(accel18_t *ctx, uint8_t range_macro)
Set range configuration.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
accel18_s::range_resolution
float range_resolution
Definition: accel18.h:276
accel18_cfg_t::drv_sel
accel18_drv_t drv_sel
Definition: accel18.h:302
accel18_generic_write
err_t accel18_generic_write(accel18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Accel 18 data writing function.
accel18_s::i1
digital_in_t i1
Definition: accel18.h:263
accel18_cfg_t::cs
pin_name_t cs
Definition: accel18.h:291
accel18_drv_interface_selection
void accel18_drv_interface_selection(accel18_cfg_t *cfg, accel18_drv_t drv_sel)
Accel 18 driver interface setup function.
accel18_cfg_t::sck
pin_name_t sck
Definition: accel18.h:290
accel18_axes_t::z
float z
Definition: accel18.h:314
accel18_s::i2
digital_in_t i2
Definition: accel18.h:264
accel18_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel18.h:299
accel18_cfg_t
Accel 18 Click configuration object.
Definition: accel18.h:284
accel18_cfg_t::i2
pin_name_t i2
Definition: accel18.h:293
accel18_default_cfg
err_t accel18_default_cfg(accel18_t *ctx)
Accel 18 default configuration function.
accel18_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel18.h:300
ACCEL18_DRV_SEL_SPI
Definition: accel18.h:246
accel18_s::slave_address
uint8_t slave_address
Definition: accel18.h:269
ACCEL18_ERROR
Definition: accel18.h:325
accel18_return_value_t
accel18_return_value_t
Accel 18 Click return value data.
Definition: accel18.h:322
accel18_s::spi
spi_master_t spi
Definition: accel18.h:267
accel18_read_axes
err_t accel18_read_axes(accel18_t *ctx, accel18_axes_t *axes_data)
Accel data reading.
accel18_s::write_f
accel18_master_io_t write_f
Definition: accel18.h:273
accel18_byte_read
err_t accel18_byte_read(accel18_t *ctx, uint8_t reg, uint8_t *data_out)
Accel 18 byte reading function.
accel18_s::chip_select
pin_name_t chip_select
Definition: accel18.h:270
accel18_s::i2c
i2c_master_t i2c
Definition: accel18.h:266
accel18_s
Accel 18 Click context object.
Definition: accel18.h:261
accel18_axes_t
Accel 18 Click axes data.
Definition: accel18.h:310
accel18_axes_t::y
float y
Definition: accel18.h:313
accel18_t
struct accel18_s accel18_t
Accel 18 Click context object.
accel18_byte_write
err_t accel18_byte_write(accel18_t *ctx, uint8_t reg, uint8_t data_in)
Accel 18 byte writing function.
accel18_axes_t::x
float x
Definition: accel18.h:312
accel18_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel18.h:295
accel18_drv_t
accel18_drv_t
Accel 18 Click driver selector.
Definition: accel18.h:244
accel18_master_io_t
err_t(* accel18_master_io_t)(struct accel18_s *, uint8_t, uint8_t *, uint8_t)
Accel 18 Click driver interface.
Definition: accel18.h:255
accel18_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel18.h:296
accel18_cfg_t::i1
pin_name_t i1
Definition: accel18.h:292
accel18_generic_read
err_t accel18_generic_read(accel18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Accel 18 data reading function.
accel18_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel18.h:298
accel18_get_interrupt_1
uint8_t accel18_get_interrupt_1(accel18_t *ctx)
Get interrupt 1 pin state.
accel18_cfg_t::sda
pin_name_t sda
Definition: accel18.h:287