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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define ACCEL16_CMD_WRITE_REG 0x0A
61 #define ACCEL16_CMD_READ_REG 0x0B
62 #define ACCEL16_CMD_READ_FIFO 0x0D
63 
68 #define ACCEL16_REG_DEVID_AD 0x00
69 #define ACCEL16_REG_DEVID_MST 0x01
70 #define ACCEL16_REG_DEVID 0x02
71 #define ACCEL16_REG_REVID 0x03
72 #define ACCEL16_REG_XDATA 0x08
73 #define ACCEL16_REG_YDATA 0x09
74 #define ACCEL16_REG_ZDATA 0x0A
75 #define ACCEL16_REG_STATUS 0x0B
76 #define ACCEL16_REG_FIFO_ENTRIES_L 0x0C
77 #define ACCEL16_REG_FIFO_ENTRIES_H 0x0D
78 #define ACCEL16_REG_XDATA_L 0x0E
79 #define ACCEL16_REG_XDATA_H 0x0F
80 #define ACCEL16_REG_YDATA_L 0x10
81 #define ACCEL16_REG_YDATA_H 0x11
82 #define ACCEL16_REG_ZDATA_L 0x12
83 #define ACCEL16_REG_ZDATA_H 0x13
84 #define ACCEL16_REG_TEMP_L 0x14
85 #define ACCEL16_REG_TEMP_H 0x15
86 #define ACCEL16_REG_ADC_DATA_L 0x16
87 #define ACCEL16_REG_ADC_DATA_H 0x17
88 #define ACCEL16_REG_SOFT_RESET 0x1F
89 #define ACCEL16_REG_THRESH_ACT_L 0x20
90 #define ACCEL16_REG_THRESH_ACT_H 0x21
91 #define ACCEL16_REG_TIME_ACT 0x22
92 #define ACCEL16_REG_THRESH_INACT_L 0x23
93 #define ACCEL16_REG_THRESH_INACT_H 0x24
94 #define ACCEL16_REG_TIME_INACT_L 0x25
95 #define ACCEL16_REG_TIME_INACT_H 0x26
96 #define ACCEL16_REG_ACT_INACT_CTL 0x27
97 #define ACCEL16_REG_FIFO_CONTROL 0x28
98 #define ACCEL16_REG_FIFO_SAMPLES 0x29
99 #define ACCEL16_REG_INTMAP1 0x2A
100 #define ACCEL16_REG_INTMAP2 0x2B
101 #define ACCEL16_REG_FILTER_CTL 0x2C
102 #define ACCEL16_REG_POWER_CTL 0x2D
103 #define ACCEL16_REG_SELF_CTL 0x2E
104  // accel16_reg
106 
121 #define ACCEL16_APPLICATION_FIFO 0xAA
122 #define ACCEL16_APPLICATION_REG 0xBB
123 
132 #define ACCEL16_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
133 #define ACCEL16_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
134  // accel16_set
136 
151 #define ACCEL16_MAP_MIKROBUS( cfg, mikrobus ) \
152  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
153  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
154  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
155  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
156  cfg.int2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
157  cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
158  // accel16_map // accel16
161 
166 typedef struct
167 {
168  // Input pins
169  digital_in_t int2;
170  digital_in_t int1;
172  // Modules
173  spi_master_t spi;
175  pin_name_t chip_select;
176  float resolution;
178 
179 } accel16_t;
180 
185 typedef struct
186 {
187  // Communication gpio pins
188  pin_name_t miso;
189  pin_name_t mosi;
190  pin_name_t sck;
191  pin_name_t cs;
193  // Additional gpio pins
194  pin_name_t int2;
195  pin_name_t int1;
197  // static variable
198  uint32_t spi_speed;
199  spi_master_mode_t spi_mode;
200  spi_master_chip_select_polarity_t cs_polarity;
202 } accel16_cfg_t;
203 
208 typedef struct
209 {
210  float x;
211  float y;
212  float z;
215 
220 typedef enum
221 {
224 
226 
231 typedef enum
232 {
236 
238 
243 typedef enum
244 {
251 
253 
269 void accel16_cfg_setup ( accel16_cfg_t *cfg );
270 
284 err_t accel16_init ( accel16_t *ctx, accel16_cfg_t *cfg );
285 
298 err_t accel16_default_cfg ( accel16_t *ctx );
299 
313 err_t accel16_multiple_reg_write ( accel16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
314 
326 err_t accel16_single_reg_write ( accel16_t *ctx, uint8_t reg, uint8_t data_in );
327 
341 err_t accel16_multiple_reg_read ( accel16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
342 
354 err_t accel16_single_reg_read ( accel16_t *ctx, uint8_t reg, uint8_t *data_out );
355 
369 err_t accel16_fifo_read ( accel16_t *ctx, uint8_t *data_out, uint16_t len );
370 
378 uint8_t accel16_get_interrupt_1 ( accel16_t *ctx );
379 
387 uint8_t accel16_get_interrupt_2 ( accel16_t *ctx );
388 
402 
414 err_t accel16_get_axes ( accel16_t *ctx, accel16_axes_t *axes );
415 
427 err_t accel16_get_temperature ( accel16_t *ctx, float *temperature );
428 
441 err_t accel16_get_adc ( accel16_t *ctx, float *v_adc );
442 
443 #ifdef __cplusplus
444 }
445 #endif
446 #endif // ACCEL16_H
447  // accel16
449 
450 // ------------------------------------------------------------------------ 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:194
ACCEL16_50HZ
Definition: accel16.h:247
ACCEL16_25HZ
Definition: accel16.h:246
accel16_t::int2
digital_in_t int2
Definition: accel16.h:169
accel16_axes_t::y
float y
Definition: accel16.h:211
spi_specifics.h
This file contains SPI specific macros, functions, etc.
accel16_t::chip_select
pin_name_t chip_select
Definition: accel16.h:175
accel16_return_value_t
accel16_return_value_t
Accel 16 Click return value data.
Definition: accel16.h:220
accel16_axes_t::x
float x
Definition: accel16.h:210
ACCEL16_100HZ
Definition: accel16.h:248
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
Definition: accel16.h:249
accel16_cfg_t
Accel 16 Click configuration object.
Definition: accel16.h:185
accel16_t::int1
digital_in_t int1
Definition: accel16.h:170
accel16_cfg_t::int1
pin_name_t int1
Definition: accel16.h:195
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:231
accel16_t
Accel 16 Click context object.
Definition: accel16.h:166
accel16_cfg_t::cs
pin_name_t cs
Definition: accel16.h:191
accel16_cfg_t::sck
pin_name_t sck
Definition: accel16.h:190
accel16_axes_t
Accel 16 Click axes data.
Definition: accel16.h:208
ACCEL16_400HZ
Definition: accel16.h:250
ACCEL16_ERROR
Definition: accel16.h:223
ACCEL16_2G
Definition: accel16.h:233
ACCEL16_8G
Definition: accel16.h:235
ACCEL16_4G
Definition: accel16.h:234
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:189
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
Definition: accel16.h:222
accel16_cfg_t::spi_speed
uint32_t spi_speed
Definition: accel16.h:198
accel16_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: accel16.h:199
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:243
accel16_get_adc
err_t accel16_get_adc(accel16_t *ctx, float *v_adc)
Get adc data.
accel16_t::resolution
float resolution
Definition: accel16.h:176
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:177
ACCEL16_12p5HZ
Definition: accel16.h:245
accel16_t::spi
spi_master_t spi
Definition: accel16.h:173
accel16_axes_t::z
float z
Definition: accel16.h:212
accel16_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: accel16.h:200
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:188