accel7  2.0.0.0
accel7.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef ACCEL7_H
35 #define ACCEL7_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define ACCEL7_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
56 
62 #define ACCEL7_RETVAL uint8_t
63 
64 #define ACCEL7_OK 0x00
65 #define ACCEL7_INIT_ERROR 0xFF
66 
72 #define ACCEL7_AXIS_X 0x06
73 #define ACCEL7_AXIS_Y 0x08
74 #define ACCEL7_AXIS_Z 0x0A
75 #define ACCEL7_DATA_RESP_8bit 0x10
76 #define ACCEL7_DATA_RESP_12bit 0x20
77 #define ACCEL7_DATA_RESP_14bit 0x30
78 #define ACCEL7_RANGE_2g 0x01
79 #define ACCEL7_RANGE_4g 0x02
80 #define ACCEL7_RANGE_8g 0x03
81 #define ACCEL7_RANGE_16g 0x04
82 
88 #define ACCEL7_REG_AXIS_X_LSB 0x06
89 #define ACCEL7_REG_AXIS_X_MSB 0x07
90 #define ACCEL7_REG_AXIS_Y_LSB 0x08
91 #define ACCEL7_REG_AXIS_Y_MSB 0x09
92 #define ACCEL7_REG_AXIS_Z_LSB 0x0A
93 #define ACCEL7_REG_AXIS_Z_MSB 0x0B
94 #define ACCEL7_REG_DCST_RESP 0x0C
95 #define ACCEL7_REG_WHO_AM_I 0x0F
96 #define ACCEL7_REG_INT_SOURCE1 0x16
97 #define ACCEL7_REG_INT_SOURCE2 0x17
98 #define ACCEL7_REG_STATUS 0x18
99 #define ACCEL7_REG_INT_REL 0x1A
100 #define ACCEL7_REG_CTRL_REG1 0x1B
101 #define ACCEL7_REG_CTRL_REG2 0x1D
102 #define ACCEL7_REG_INT_CTRL_REG1 0x1E
103 #define ACCEL7_REG_INT_CTRL_REG2 0x1F
104 #define ACCEL7_REG_DATA_CTRL_REG 0x21
105 #define ACCEL7_REG_WAKEUP_COUNTER 0x29
106 #define ACCEL7_REG_NA_CAUNTER 0x2A
107 #define ACCEL7_REG_SELF_TEST 0x3A
108 #define ACCEL7_REG_WAKEUP_THRESHOLD_MSB 0x6A
109 #define ACCEL7_REG_WAKEUP_THRESHOLD_LSB 0x6B
110 
116 #define ACCEL7_CTRL_REG1_MODE_OPERATING 0x80
117 #define ACCEL7_CTRL_REG1_MODE_STANDBY 0x00
118 #define ACCEL7_CTRL_REG1_RES_LOW_CURRENT 0x00
119 #define ACCEL7_CTRL_REG1_RES_HIGH_RESOLUTION 0x40
120 #define ACCEL7_CTRL_REG1_DRDYE_ENABLE 0x20
121 #define ACCEL7_CTRL_REG1_DRDYE_DISABLE 0x00
122 #define ACCEL7_CTRL_REG1_RANGE_2g 0x00
123 #define ACCEL7_CTRL_REG1_RANGE_4g 0x08
124 #define ACCEL7_CTRL_REG1_RANGE_8g 0x10
125 #define ACCEL7_CTRL_REG1_RANGE_16g 0x04
126 #define ACCEL7_CTRL_REG1_RANGE_HIGH_RES_8g 0x18
127 #define ACCEL7_CTRL_REG1_RANGE_HIGH_RES_16g 0x1C
128 #define ACCEL7_CTRL_REG1_WAKEUP_DISABLE 0x00
129 #define ACCEL7_CTRL_REG1_WAKEUP_ENABLE 0x02
130 
136 #define ACCEL7_CTRL_REG2_START_RAM_REBOOT 0x80
137 #define ACCEL7_CTRL_REG2_DCST_ENABLE 0x10
138 #define ACCEL7_CTRL_REG2_DCST_DISABLE 0x00
139 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_0_781Hz 0x00
140 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_1_563Hz 0x01
141 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_3_125Hz 0x02
142 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_6_25Hz 0x03
143 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_12_5Hz 0x04
144 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_25Hz 0x05
145 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_50Hz 0x06
146 #define ACCEL7_CTRL_REG2_OUT_DATA_RATE_100Hz 0x07
147 
153 #define ACCEL7_INT_CTRL_REG1_IEN_DISABLE 0x00
154 #define ACCEL7_INT_CTRL_REG1_IEN_ENABLE 0x20
155 #define ACCEL7_INT_CTRL_REG1_IEA_DISABLE 0x00
156 #define ACCEL7_INT_CTRL_REG1_IEA_ENABLE 0x10
157 #define ACCEL7_INT_CTRL_REG1_IEL_DISABLE 0x00
158 #define ACCEL7_INT_CTRL_REG1_IEL_ENABLE 0x08
159 #define ACCEL7_INT_CTRL_REG1_SELF_TEST_POL_NEGATIVE 0x00
160 #define ACCEL7_INT_CTRL_REG1_SELF_TEST_POL_POSITIVE 0x02
161 
167 #define ACCEL7_INT_CTRL_REG2_ULMODE_ENABLE 0x80
168 #define ACCEL7_INT_CTRL_REG2_ULMODE_DISABLE 0x00
169 #define ACCEL7_INT_CTRL_REG2_X_NEGATIVE_ENABLE 0x20
170 #define ACCEL7_INT_CTRL_REG2_X_NEGATIVE_DISABLE 0x00
171 #define ACCEL7_INT_CTRL_REG2_Y_NEGATIVE_ENABLE 0x08
172 #define ACCEL7_INT_CTRL_REG2_Y_NEGATIVE_DISABLE 0x00
173 #define ACCEL7_INT_CTRL_REG2_Z_NEGATIVE_ENABLE 0x02
174 #define ACCEL7_INT_CTRL_REG2_Z_NEGATIVE_DISABLE 0x00
175 #define ACCEL7_INT_CTRL_REG2_X_POSITIVE_ENABLE 0x10
176 #define ACCEL7_INT_CTRL_REG2_X_POSITIVE_DISABLE 0x00
177 #define ACCEL7_INT_CTRL_REG2_Y_POSITIVE_ENABLE 0x04
178 #define ACCEL7_INT_CTRL_REG2_Y_POSITIVE_DISABLE 0x00
179 #define ACCEL7_INT_CTRL_REG2_Z_POSITIVE_ENABLE 0x01
180 #define ACCEL7_INT_CTRL_REG2_Z_POSITIVE_DISABLE 0x00
181 
187 #define ACCEL7_DATA_CTRL_REG_ODR_0_781Hz 0x08
188 #define ACCEL7_DATA_CTRL_REG_ODR_1_563Hz 0x09
189 #define ACCEL7_DATA_CTRL_REG_ODR_3_125Hz 0x0A
190 #define ACCEL7_DATA_CTRL_REG_ODR_6_25Hz 0x0B
191 #define ACCEL7_DATA_CTRL_REG_ODR_12_5Hz 0x00
192 #define ACCEL7_DATA_CTRL_REG_ODR_25Hz 0x01
193 #define ACCEL7_DATA_CTRL_REG_ODR_50Hz 0x02
194 #define ACCEL7_DATA_CTRL_REG_ODR_100Hz 0x03
195 #define ACCEL7_DATA_CTRL_REG_ODR_200Hz 0x04
196 #define ACCEL7_DATA_CTRL_REG_ODR_400Hz 0x05
197 #define ACCEL7_DATA_CTRL_REG_ODR_800Hz 0x06
198 #define ACCEL7_DATA_CTRL_REG_ODR_1600Hz 0x07
199 
205 #define ACCEL7_DEVICE_ADDRESS 0x0F
206  // End group macro
209 // --------------------------------------------------------------- PUBLIC TYPES
218 typedef struct
219 {
220  // Input pins
221 
222  digital_in_t int_pin;
223 
224  // Modules
225 
226  i2c_master_t i2c;
227 
228  // ctx variable
229 
230  uint8_t slave_address;
232 
233 } accel7_t;
234 
238 typedef struct
239 {
240  // Communication gpio pins
241 
242  pin_name_t scl;
243  pin_name_t sda;
244 
245  // Additional gpio pins
246 
247  pin_name_t int_pin;
248 
249  // static variable
250 
251  uint32_t i2c_speed;
252  uint8_t i2c_address;
254 
255 } accel7_cfg_t;
256  // End types group
258 
259 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
260 
266 #ifdef __cplusplus
267 extern "C"{
268 #endif
269 
279 
289 
299 void accel7_default_cfg ( accel7_t *ctx, uint8_t resolution, uint8_t range );
300 
311 void accel7_generic_write ( accel7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
312 
323 void accel7_generic_read ( accel7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
324 
334 void accel7_write_byte ( accel7_t *ctx, uint8_t reg, uint8_t input_data );
335 
344 uint8_t accel7_read_byte( accel7_t *ctx, uint8_t reg );
345 
354 int16_t accel7_get_axis ( accel7_t *ctx, uint8_t axis );
355 
366 void accel7_res_range_cfg ( accel7_t *ctx, uint8_t *resolution, uint8_t *range );
367 
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 #endif // _ACCEL7_H_
381  // End public_function group
384 
385 // ------------------------------------------------------------------------- END
accel7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: accel7.h:251
accel7_cfg_setup
void accel7_cfg_setup(accel7_cfg_t *cfg)
Config Object Initialization function.
accel7_cfg_t
Click configuration structure definition.
Definition: accel7.h:239
accel7_get_interrupt_state
uint8_t accel7_get_interrupt_state(accel7_t *ctx)
Get interrupt state function.
accel7_generic_read
void accel7_generic_read(accel7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
accel7_cfg_t::sda
pin_name_t sda
Definition: accel7.h:243
accel7_cfg_t::i2c_address
uint8_t i2c_address
Definition: accel7.h:252
accel7_init
ACCEL7_RETVAL accel7_init(accel7_t *ctx, accel7_cfg_t *cfg)
Initialization function.
ACCEL7_RETVAL
#define ACCEL7_RETVAL
Definition: accel7.h:62
accel7_t::slave_address
uint8_t slave_address
Definition: accel7.h:230
accel7_cfg_t::dev_data_resolution
uint8_t dev_data_resolution
Definition: accel7.h:253
accel7_res_range_cfg
void accel7_res_range_cfg(accel7_t *ctx, uint8_t *resolution, uint8_t *range)
Resolution/range configuration function.
accel7_write_byte
void accel7_write_byte(accel7_t *ctx, uint8_t reg, uint8_t input_data)
Write byte function.
accel7_read_byte
uint8_t accel7_read_byte(accel7_t *ctx, uint8_t reg)
Read byte function.
accel7_generic_write
void accel7_generic_write(accel7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
accel7_t::i2c
i2c_master_t i2c
Definition: accel7.h:226
accel7_cfg_t::scl
pin_name_t scl
Definition: accel7.h:242
accel7_t
Click ctx object definition.
Definition: accel7.h:219
accel7_t::data_resolution
uint8_t data_resolution
Definition: accel7.h:231
accel7_get_axis
int16_t accel7_get_axis(accel7_t *ctx, uint8_t axis)
Get axi function.
accel7_t::int_pin
digital_in_t int_pin
Definition: accel7.h:222
accel7_cfg_t::int_pin
pin_name_t int_pin
Definition: accel7.h:247
accel7_default_cfg
void accel7_default_cfg(accel7_t *ctx, uint8_t resolution, uint8_t range)
Click Default Configuration function.