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 "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 ACCEL18_REG_DEVICE_STATUS 0x05
72 #define ACCEL18_REG_INTERRUPT_ENABLE 0x06
73 #define ACCEL18_REG_MODE 0x07
74 #define ACCEL18_REG_SAMPLE_RATE 0x08
75 #define ACCEL18_REG_MOTION_CONTROL 0x09
76 #define ACCEL18_REG_FIFO_STATUS 0x0A
77 #define ACCEL18_REG_FIFO_READ_POINTER 0x0B
78 #define ACCEL18_REG_FIFO_WRITE_POINTER 0x0C
79 #define ACCEL18_REG_XOUT_ACCEL_DATA_LSB 0x0D
80 #define ACCEL18_REG_XOUT_ACCEL_DATA_MSB 0x0E
81 #define ACCEL18_REG_YOUT_ACCEL_DATA_LSB 0x0F
82 #define ACCEL18_REG_YOUT_ACCEL_DATA_MSB 0x10
83 #define ACCEL18_REG_ZOUT_ACCEL_DATA_LSB 0x11
84 #define ACCEL18_REG_ZOUT_ACCEL_DATA_MSB 0x12
85 #define ACCEL18_REG_STATUS 0x13
86 #define ACCEL18_REG_INTERRUPT_STATUS 0x14
87 #define ACCEL18_REG_RANGE_SELECTION 0x20
88 #define ACCEL18_REG_X_OFFSET_LSB 0x21
89 #define ACCEL18_REG_X_OFFSET_MSB 0x22
90 #define ACCEL18_REG_Y_OFFSET_LSB 0x23
91 #define ACCEL18_REG_Y_OFFSET_MSB 0x24
92 #define ACCEL18_REG_Z_OFFSET_LSB 0x25
93 #define ACCEL18_REG_Z_OFFSET_MSB 0x26
94 #define ACCEL18_REG_X_GAIN 0x27
95 #define ACCEL18_REG_Y_GAIN 0x28
96 #define ACCEL18_REG_Z_GAIN 0x29
97 #define ACCEL18_REG_FIFO_CONTROL 0x2D
98 #define ACCEL18_REG_FIFO_THRESHOLD 0x2E
99 #define ACCEL18_REG_FIFO_INTERRUPT_STATUS 0x2F
100 #define ACCEL18_REG_FIFO_CONTROL2 0x30
101 #define ACCEL18_REG_COMMUNICATION_CONTROL 0x31
102 #define ACCEL18_REG_GPIO_CONTROL 0x33
103 #define ACCEL18_REG_TILT_FLIP_THRESHOLD_LSB 0x40
104 #define ACCEL18_REG_TILT_FLIP_THRESHOLD_MSB 0x41
105 #define ACCEL18_REG_TILT_FLIP_DEBOUNCE 0x42
106 #define ACCEL18_REG_ANY_MOTION_THRESHOLD_LSB 0x43
107 #define ACCEL18_REG_ANY_MOTION_THRESHOLD_MSB 0x44
108 #define ACCEL18_REG_ANY_MOTION_DEBOUNCE 0x45
109 #define ACCEL18_REG_SNAKE_THRESHOLD_LSB 0x46
110 #define ACCEL18_REG_SNAKE_THRESHOLD_MSB 0x47
111 #define ACCEL18_REG_PEAK_TO_PEAK_DURATION_LSB 0x48
112 #define ACCEL18_REG_SNAKE_PEAK_TO_PEAK_DURATION_MSB 0x49
113 #define ACCEL18_REG_TIMER 0x4A
114 #define ACCEL18_REG_READ_COUNT 0x4B
115 
116  // accel18_reg
118 
133 #define ACCEL18_STATE_STANDBY 0x00
134 #define ACCEL18_STATE_WAKE 0x01
135 
140 #define ACCEL18_INT_TILT_EN 0x01
141 #define ACCEL18_INT_FLIP_EN 0x02
142 #define ACCEL18_INT_ANYM_EN 0x04
143 #define ACCEL18_INT_SHAKE_EN 0x08
144 #define ACCEL18_INT_TILT_35_EN 0x10
145 #define ACCEL18_INT_AUTO_CLR_EN 0x40
146 #define ACCEL18_INT_ACQ_EN 0x80
147 
152 #define ACCEL18_RATE_25 0x10
153 #define ACCEL18_RATE_50 0x11
154 #define ACCEL18_RATE_62p5 0x12
155 #define ACCEL18_RATE_100 0x13
156 #define ACCEL18_RATE_125 0x14
157 #define ACCEL18_RATE_250 0x15
158 #define ACCEL18_RATE_500 0x16
159 #define ACCEL18_RATE_1000 0x17
160 
165 #define ACCEL18_FIFO_CTRL2_BURST_MODE 0x80
166 #define ACCEL18_FIFO_CTRL2_SELECT_WRAP_ADDR 0x20
167 #define ACCEL18_FIFO_CTRL2_ENABLE_WRAP_N 0x10
168 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DISABLE 0x00
169 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_2 0x01
170 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_4 0x02
171 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_5 0x03
172 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_8 0x04
173 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_10 0x05
174 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_16 0x06
175 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_20 0x07
176 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_40 0x08
177 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_67 0x09
178 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_80 0x0A
179 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_100 0x0B
180 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_200 0x0C
181 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_250 0x0D
182 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_500 0x0E
183 #define ACCEL18_FIFO_CTRL2_DEC_MODE_RATE_DIV_1000 0x0F
184 
189 #define ACCEL18_GPIO_CTRL_INT1_ACTIVE_LOW 0x00
190 #define ACCEL18_GPIO_CTRL_INT1_ACTIVE_HIGH 0x04
191 #define ACCEL18_GPIO_CTRL_INT1_OPEN_DRAIN 0x00
192 #define ACCEL18_GPIO_CTRL_INT1_PUSH_PULL 0x08
193 #define ACCEL18_GPIO_CTRL_INT2_ACTIVE_LOW 0x00
194 #define ACCEL18_GPIO_CTRL_INT2_ACTIVE_HIGH 0x40
195 #define ACCEL18_GPIO_CTRL_INT2_OPEN_DRAIN 0x00
196 #define ACCEL18_GPIO_CTRL_INT2_PUSH_PULL 0x80
197 
202 #define ACCEL18_MOTION_TF_EN 0x01
203 #define ACCEL18_MOTION_LATCH 0x02
204 #define ACCEL18_MOTION_ANYM_EN 0x04
205 #define ACCEL18_MOTION_SHAKE_EN 0x08
206 #define ACCEL18_MOTION_TILT_35 0x10
207 #define ACCEL18_MOTION_Z_AXIS_ORT 0x20
208 #define ACCEL18_MOTION_RAW_PROC_STAT 0x40
209 #define ACCEL18_MOTION_RESET 0x80
210 
215 #define ACCEL18_STATUS_TILT 0x01
216 #define ACCEL18_STATUS_FLIP 0x02
217 #define ACCEL18_STATUS_ANYM 0x04
218 #define ACCEL18_STATUS_SHAKE 0x08
219 #define ACCEL18_STATUS_TILT35 0x10
220 #define ACCEL18_STATUS_FIFO 0x20
221 #define ACCEL18_STATUS_NEW_DATA 0x80
222 
227 #define ACCEL18_RANGE_2G 0x00
228 #define ACCEL18_RANGE_4G 0x10
229 #define ACCEL18_RANGE_8G 0x20
230 #define ACCEL18_RANGE_16G 0x30
231 #define ACCEL18_RANGE_12G 0x40
232 #define ACCEL18_LOW_PASS_FILTER_EN 0x08
233 #define ACCEL18_LOW_PASS_FILTER_DIV4p255 0x01
234 #define ACCEL18_LOW_PASS_FILTER_DIV6 0x02
235 #define ACCEL18_LOW_PASS_FILTER_DIV12 0x03
236 #define ACCEL18_LOW_PASS_FILTER_DIV16 0x05
237 
243 #define ACCEL18_GND_ADDR 0x4C
244 #define ACCEL18_VCC_ADDR 0x6C
245 #define ACCEL18_SET_DEV_ADDR ACCEL18_GND_ADDR
246 
255 #define ACCEL18_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
256 #define ACCEL18_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
257  // accel18_set
259 
274 #define ACCEL18_MAP_MIKROBUS( cfg, mikrobus ) \
275  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
276  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
277  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
278  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
279  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
280  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
281  cfg.i1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
282  cfg.i2 = MIKROBUS( mikrobus, MIKROBUS_INT )
283  // accel18_map // accel18
286 
291 typedef enum
292 {
297 
302 typedef err_t ( *accel18_master_io_t )( struct accel18_s*, uint8_t, uint8_t*, uint8_t );
308 typedef struct accel18_s
309 {
310  digital_in_t i1;
311  digital_in_t i2;
313  i2c_master_t i2c;
314  spi_master_t spi;
316  uint8_t slave_address;
317  pin_name_t chip_select;
326 
331 typedef struct
332 {
333  pin_name_t scl;
334  pin_name_t sda;
335  pin_name_t miso;
336  pin_name_t mosi;
337  pin_name_t sck;
338  pin_name_t cs;
339  pin_name_t i1;
340  pin_name_t i2;
342  uint32_t i2c_speed;
343  uint8_t i2c_address;
345  uint32_t spi_speed;
346  spi_master_mode_t spi_mode;
347  spi_master_chip_select_polarity_t cs_polarity;
351 } accel18_cfg_t;
352 
357 typedef struct
358 {
359  float x;
360  float y;
361  float z;
364 
369 typedef enum
370 {
372  ACCEL18_ERROR = -1
373 
375 
392 
408 
423 err_t accel18_init ( accel18_t *ctx, accel18_cfg_t *cfg );
424 
439 
455 err_t accel18_generic_write ( accel18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
456 
470 err_t accel18_byte_write ( accel18_t *ctx, uint8_t reg, uint8_t data_in );
471 
487 err_t accel18_generic_read ( accel18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
488 
502 err_t accel18_byte_read ( accel18_t *ctx, uint8_t reg, uint8_t *data_out );
503 
517 err_t accel18_read_axes ( accel18_t *ctx, accel18_axes_t *axes_data );
518 
532 err_t accel18_set_range ( accel18_t *ctx, uint8_t range_macro );
533 
542 
551 
552 #ifdef __cplusplus
553 }
554 #endif
555 #endif // ACCEL18_H
556  // accel18
558 
559 // ------------------------------------------------------------------------ END
accel18_cfg_t::miso
pin_name_t miso
Definition: accel18.h:335
accel18_s::drv_sel
accel18_drv_t drv_sel
Definition: accel18.h:318
accel18_s::read_f
accel18_master_io_t read_f
Definition: accel18.h:321
accel18_get_interrupt_2
uint8_t accel18_get_interrupt_2(accel18_t *ctx)
Get interrupt 2 pin state.
ACCEL18_DRV_SEL_I2C
@ ACCEL18_DRV_SEL_I2C
Definition: accel18.h:294
accel18_cfg_t::mosi
pin_name_t mosi
Definition: accel18.h:336
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
@ ACCEL18_OK
Definition: accel18.h:371
accel18_cfg_t::scl
pin_name_t scl
Definition: accel18.h:333
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_t
struct accel18_s accel18_t
Accel 18 Click context object.
accel18_s::range_resolution
float range_resolution
Definition: accel18.h:323
accel18_cfg_t::drv_sel
accel18_drv_t drv_sel
Definition: accel18.h:349
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:310
accel18_cfg_t::cs
pin_name_t cs
Definition: accel18.h:338
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:337
accel18_axes_t::z
float z
Definition: accel18.h:361
accel18_s::i2
digital_in_t i2
Definition: accel18.h:311
accel18_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel18.h:346
accel18_cfg_t
Accel 18 Click configuration object.
Definition: accel18.h:332
accel18_cfg_t::i2
pin_name_t i2
Definition: accel18.h:340
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:347
ACCEL18_DRV_SEL_SPI
@ ACCEL18_DRV_SEL_SPI
Definition: accel18.h:293
accel18_s::slave_address
uint8_t slave_address
Definition: accel18.h:316
ACCEL18_ERROR
@ ACCEL18_ERROR
Definition: accel18.h:372
accel18_return_value_t
accel18_return_value_t
Accel 18 Click return value data.
Definition: accel18.h:370
accel18_s::spi
spi_master_t spi
Definition: accel18.h:314
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:320
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:317
accel18_s::i2c
i2c_master_t i2c
Definition: accel18.h:313
accel18_s
Accel 18 Click context object.
Definition: accel18.h:309
accel18_axes_t
Accel 18 Click axes data.
Definition: accel18.h:358
accel18_axes_t::y
float y
Definition: accel18.h:360
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:359
accel18_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel18.h:342
accel18_drv_t
accel18_drv_t
Accel 18 Click driver selector.
Definition: accel18.h:292
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:302
accel18_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel18.h:343
accel18_cfg_t::i1
pin_name_t i1
Definition: accel18.h:339
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:345
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:334