accel16  2.0.0.0
accel16.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 ACCEL16_H
29 #define ACCEL16_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_spi_master.h"
48 #include "spi_specifics.h"
49 
70 #define ACCEL16_CMD_WRITE_REG 0x0A
71 #define ACCEL16_CMD_READ_REG 0x0B
72 #define ACCEL16_CMD_READ_FIFO 0x0D
73 
78 #define ACCEL16_REG_DEVID_AD 0x00
79 #define ACCEL16_REG_DEVID_MST 0x01
80 #define ACCEL16_REG_DEVID 0x02
81 #define ACCEL16_REG_REVID 0x03
82 #define ACCEL16_REG_XDATA 0x08
83 #define ACCEL16_REG_YDATA 0x09
84 #define ACCEL16_REG_ZDATA 0x0A
85 #define ACCEL16_REG_STATUS 0x0B
86 #define ACCEL16_REG_FIFO_ENTRIES_L 0x0C
87 #define ACCEL16_REG_FIFO_ENTRIES_H 0x0D
88 #define ACCEL16_REG_XDATA_L 0x0E
89 #define ACCEL16_REG_XDATA_H 0x0F
90 #define ACCEL16_REG_YDATA_L 0x10
91 #define ACCEL16_REG_YDATA_H 0x11
92 #define ACCEL16_REG_ZDATA_L 0x12
93 #define ACCEL16_REG_ZDATA_H 0x13
94 #define ACCEL16_REG_TEMP_L 0x14
95 #define ACCEL16_REG_TEMP_H 0x15
96 #define ACCEL16_REG_ADC_DATA_L 0x16
97 #define ACCEL16_REG_ADC_DATA_H 0x17
98 #define ACCEL16_REG_SOFT_RESET 0x1F
99 #define ACCEL16_REG_THRESH_ACT_L 0x20
100 #define ACCEL16_REG_THRESH_ACT_H 0x21
101 #define ACCEL16_REG_TIME_ACT 0x22
102 #define ACCEL16_REG_THRESH_INACT_L 0x23
103 #define ACCEL16_REG_THRESH_INACT_H 0x24
104 #define ACCEL16_REG_TIME_INACT_L 0x25
105 #define ACCEL16_REG_TIME_INACT_H 0x26
106 #define ACCEL16_REG_ACT_INACT_CTL 0x27
107 #define ACCEL16_REG_FIFO_CONTROL 0x28
108 #define ACCEL16_REG_FIFO_SAMPLES 0x29
109 #define ACCEL16_REG_INTMAP1 0x2A
110 #define ACCEL16_REG_INTMAP2 0x2B
111 #define ACCEL16_REG_FILTER_CTL 0x2C
112 #define ACCEL16_REG_POWER_CTL 0x2D
113 #define ACCEL16_REG_SELF_CTL 0x2E
114  // accel16_reg
116 
131 #define ACCEL16_APPLICATION_FIFO 0xAA
132 #define ACCEL16_APPLICATION_REG 0xBB
133 
138 #define ACCEL16_ROOM_TEMPERATURE 25.0
139 #define ACCEL16_TEMPERATURE_BIAS 350
140 #define ACCEL16_TEMPERATURE_RES 0.065
141 #define ACCEL16_TEMPERATURE_CAL_SAMPLE_NUM 100
142 
151 #define ACCEL16_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
152 #define ACCEL16_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
153  // accel16_set
155 
170 #define ACCEL16_MAP_MIKROBUS( cfg, mikrobus ) \
171  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
172  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
173  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
174  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
175  cfg.int2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
176  cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
177  // accel16_map // accel16
180 
185 typedef struct
186 {
187  // Input pins
188  digital_in_t int2;
189  digital_in_t int1;
191  // Modules
192  spi_master_t spi;
194  pin_name_t chip_select;
195  float resolution;
199 } accel16_t;
200 
205 typedef struct
206 {
207  // Communication gpio pins
208  pin_name_t miso;
209  pin_name_t mosi;
210  pin_name_t sck;
211  pin_name_t cs;
213  // Additional gpio pins
214  pin_name_t int2;
215  pin_name_t int1;
217  // static variable
218  uint32_t spi_speed;
219  spi_master_mode_t spi_mode;
220  spi_master_chip_select_polarity_t cs_polarity;
222 } accel16_cfg_t;
223 
228 typedef struct
229 {
230  float x;
231  float y;
232  float z;
235 
240 typedef enum
241 {
243  ACCEL16_ERROR = -1
244 
246 
251 typedef enum
252 {
255  ACCEL16_8G = 2
256 
258 
263 typedef enum
264 {
271 
273 
290 
304 err_t accel16_init ( accel16_t *ctx, accel16_cfg_t *cfg );
305 
319 
333 err_t accel16_multiple_reg_write ( accel16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
334 
346 err_t accel16_single_reg_write ( accel16_t *ctx, uint8_t reg, uint8_t data_in );
347 
361 err_t accel16_multiple_reg_read ( accel16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
362 
374 err_t accel16_single_reg_read ( accel16_t *ctx, uint8_t reg, uint8_t *data_out );
375 
389 err_t accel16_fifo_read ( accel16_t *ctx, uint8_t *data_out, uint16_t len );
390 
399 
408 
422 
435 
447 err_t accel16_get_temperature ( accel16_t *ctx, float *temperature );
448 
461 err_t accel16_get_adc ( accel16_t *ctx, float *v_adc );
462 
474 err_t accel16_calibrate_temperature ( accel16_t *ctx, float room_temperature );
475 
476 #ifdef __cplusplus
477 }
478 #endif
479 #endif // ACCEL16_H
480  // accel16
482 
483 // ------------------------------------------------------------------------ END
accel16_multiple_reg_write
err_t accel16_multiple_reg_write(accel16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Write multiple registers.
accel16_get_interrupt_1
uint8_t accel16_get_interrupt_1(accel16_t *ctx)
Get interrupt 1 state.
accel16_init
err_t accel16_init(accel16_t *ctx, accel16_cfg_t *cfg)
Accel 16 initialization function.
accel16_cfg_t::int2
pin_name_t int2
Definition: accel16.h:214
ACCEL16_50HZ
@ ACCEL16_50HZ
Definition: accel16.h:267
ACCEL16_25HZ
@ ACCEL16_25HZ
Definition: accel16.h:266
accel16_t::int2
digital_in_t int2
Definition: accel16.h:188
accel16_axes_t::y
float y
Definition: accel16.h:231
spi_specifics.h
This file contains SPI specific macros, functions, etc.
accel16_t::chip_select
pin_name_t chip_select
Definition: accel16.h:194
accel16_return_value_t
accel16_return_value_t
Accel 16 Click return value data.
Definition: accel16.h:241
accel16_axes_t::x
float x
Definition: accel16.h:230
ACCEL16_100HZ
@ ACCEL16_100HZ
Definition: accel16.h:268
accel16_multiple_reg_read
err_t accel16_multiple_reg_read(accel16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Read multiple registers.
accel16_get_axes
err_t accel16_get_axes(accel16_t *ctx, accel16_axes_t *axes)
Get axes data.
ACCEL16_200HZ
@ ACCEL16_200HZ
Definition: accel16.h:269
accel16_cfg_t
Accel 16 Click configuration object.
Definition: accel16.h:206
accel16_t::int1
digital_in_t int1
Definition: accel16.h:189
accel16_cfg_t::int1
pin_name_t int1
Definition: accel16.h:215
accel16_get_interrupt_2
uint8_t accel16_get_interrupt_2(accel16_t *ctx)
Get interrupt 2 state.
accel16_filter_configuration
err_t accel16_filter_configuration(accel16_t *ctx, accel16_gain_t gain, accel16_output_rate_t odr)
Filter configuration.
accel16_gain_t
accel16_gain_t
Accel 16 Click gain.
Definition: accel16.h:252
accel16_t
Accel 16 Click context object.
Definition: accel16.h:186
accel16_cfg_t::cs
pin_name_t cs
Definition: accel16.h:211
accel16_cfg_t::sck
pin_name_t sck
Definition: accel16.h:210
accel16_axes_t
Accel 16 Click axes data.
Definition: accel16.h:229
ACCEL16_400HZ
@ ACCEL16_400HZ
Definition: accel16.h:270
ACCEL16_ERROR
@ ACCEL16_ERROR
Definition: accel16.h:243
ACCEL16_2G
@ ACCEL16_2G
Definition: accel16.h:253
ACCEL16_8G
@ ACCEL16_8G
Definition: accel16.h:255
ACCEL16_4G
@ ACCEL16_4G
Definition: accel16.h:254
accel16_default_cfg
err_t accel16_default_cfg(accel16_t *ctx)
Accel 16 default configuration function.
accel16_cfg_t::mosi
pin_name_t mosi
Definition: accel16.h:209
accel16_single_reg_read
err_t accel16_single_reg_read(accel16_t *ctx, uint8_t reg, uint8_t *data_out)
Read single registers.
ACCEL16_OK
@ ACCEL16_OK
Definition: accel16.h:242
accel16_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel16.h:218
accel16_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel16.h:219
accel16_get_temperature
err_t accel16_get_temperature(accel16_t *ctx, float *temperature)
Get temperature data.
accel16_cfg_setup
void accel16_cfg_setup(accel16_cfg_t *cfg)
Accel 16 configuration object setup function.
accel16_output_rate_t
accel16_output_rate_t
Accel 16 Click output data rate.
Definition: accel16.h:264
accel16_get_adc
err_t accel16_get_adc(accel16_t *ctx, float *v_adc)
Get adc data.
accel16_t::room_temp_offset
float room_temp_offset
Definition: accel16.h:196
accel16_t::resolution
float resolution
Definition: accel16.h:195
accel16_single_reg_write
err_t accel16_single_reg_write(accel16_t *ctx, uint8_t reg, uint8_t data_in)
Write single register.
accel16_t::application_type
uint8_t application_type
Definition: accel16.h:197
ACCEL16_12p5HZ
@ ACCEL16_12p5HZ
Definition: accel16.h:265
accel16_t::spi
spi_master_t spi
Definition: accel16.h:192
accel16_axes_t::z
float z
Definition: accel16.h:232
accel16_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel16.h:220
accel16_calibrate_temperature
err_t accel16_calibrate_temperature(accel16_t *ctx, float room_temperature)
Accel 16 calibrate temperature function.
accel16_fifo_read
err_t accel16_fifo_read(accel16_t *ctx, uint8_t *data_out, uint16_t len)
Read fifo.
accel16_cfg_t::miso
pin_name_t miso
Definition: accel16.h:208