accel4 2.0.0.0
accel4.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 ACCEL4_H
29#define ACCEL4_H
30
31#ifdef __cplusplus
32extern "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 ACCEL4_REG_INT_STATUS 0x00
62#define ACCEL4_REG_TEMP_OUT 0x01
63#define ACCEL4_REG_VECM_LSB 0x02
64#define ACCEL4_REG_VECM_MSB 0x03
65#define ACCEL4_REG_OUT_X_LSB 0x04
66#define ACCEL4_REG_OUT_X_MSB 0x05
67#define ACCEL4_REG_OUT_Y_LSB 0x06
68#define ACCEL4_REG_OUT_Y_MSB 0x07
69#define ACCEL4_REG_OUT_Z_LSB 0x08
70#define ACCEL4_REG_OUT_Z_MSB 0x09
71#define ACCEL4_REG_BUF_STATUS 0x0B
72#define ACCEL4_REG_BUF_X_LSB 0x0C
73#define ACCEL4_REG_BUF_X_MSB 0x0D
74#define ACCEL4_REG_BUF_Y_LSB 0x0E
75#define ACCEL4_REG_BUF_Y_MSB 0x0F
76#define ACCEL4_REG_BUF_Z_LSB 0x10
77#define ACCEL4_REG_BUF_Z_MSB 0x11
78#define ACCEL4_REG_PROD_REV 0x12
79#define ACCEL4_REG_WHO_AM_I 0x13
80#define ACCEL4_REG_SYS_MODE 0x14
81#define ACCEL4_REG_SENS_CONFIG1 0x15
82#define ACCEL4_REG_SENS_CONFIG2 0x16
83#define ACCEL4_REG_SENS_CONFIG3 0x17
84#define ACCEL4_REG_SENS_CONFIG4 0x18
85#define ACCEL4_REG_SENS_CONFIG5 0x19
86#define ACCEL4_REG_WAKE_IDLE_LSB 0x1A
87#define ACCEL4_REG_WAKE_IDLE_MSB 0x1B
88#define ACCEL4_REG_SLEEP_IDLE_LSB 0x1C
89#define ACCEL4_REG_SLEEP_IDLE_MSB 0x1D
90#define ACCEL4_REG_ASLP_COUINT_LSB 0x1E
91#define ACCEL4_REG_ASLP_COUINT_MSB 0x1F
92#define ACCEL4_REG_INT_EN 0x20
93#define ACCEL4_REG_INT_PIN_SEL 0x21
94#define ACCEL4_REG_OFF_X 0x22
95#define ACCEL4_REG_OFF_Y 0x23
96#define ACCEL4_REG_OFF_Z 0x24
97#define ACCEL4_REG_BUF_CONFIG1 0x26
98#define ACCEL4_REG_BUF_CONFIG2 0x27
99#define ACCEL4_REG_ORIENT_STATUS 0x28
100#define ACCEL4_REG_ORIENT_CONFIG 0x29
101#define ACCEL4_REG_ORINET_DBCOUNT 0x2A
102#define ACCEL4_REG_ORIENT_BF_ZCOMP 0x2B
103#define ACCEL4_REG_ORIENT_THS_REG 0x2C
104#define ACCEL4_REG_SDCD_INT_SRC1 0x2D
105#define ACCEL4_REG_SDCD_INT_SRC2 0x2E
106#define ACCEL4_REG_SDCD_CONFIG1 0x2F
107#define ACCEL4_REG_SDCD_CONFIG2 0x30
108#define ACCEL4_REG_SDCD_OT_DBCNT 0x31
109#define ACCEL4_REG_SDCD_WT_DBCNT 0x32
110#define ACCEL4_REG_SDCD_LTHS_LSB 0x33
111#define ACCEL4_REG_SDCD_LTHS_MSB 0x34
112#define ACCEL4_REG_SDCD_UTHS_LSB 0x35
113#define ACCEL4_REG_SDCD_UTHS_MSB 0x36
114#define ACCEL4_REG_SELF_TEST_CONFIG1 0x37
115#define ACCEL4_REG_SELF_TEST_CONFIG2 0x38
116 // accel4_reg
118
133#define ACCEL4_DEVICE_ID 0x84
134
140#define ACCEL4_SET_DEV_ADDR 0x18
141
150#define ACCEL4_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
151#define ACCEL4_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
152 // accel4_set
154
169#define ACCEL4_MAP_MIKROBUS( cfg, mikrobus ) \
170 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
171 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
172 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
173 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
174 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
175 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
176 cfg.int2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
177 cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
178 // accel4_map // accel4
181
186typedef enum
187{
192
197typedef err_t ( *accel4_master_io_t )( struct accel4_s*, uint8_t, uint8_t*, uint8_t );
203typedef struct accel4_s
204{
205 digital_in_t int2;
206 digital_in_t int1;
208 i2c_master_t i2c;
209 spi_master_t spi;
212 pin_name_t chip_select;
219
221
226typedef struct
227{
228 pin_name_t scl;
229 pin_name_t sda;
230 pin_name_t miso;
231 pin_name_t mosi;
232 pin_name_t sck;
233 pin_name_t cs;
234 pin_name_t int2;
235 pin_name_t int1;
237 uint32_t i2c_speed;
238 uint8_t i2c_address;
240 uint32_t spi_speed;
241 spi_master_mode_t spi_mode;
242 spi_master_chip_select_polarity_t cs_polarity;
247
252typedef struct
253{
254 float x;
255 float y;
256 float z;
259
264typedef enum
265{
267 ACCEL4_ERROR = -1
268
270
287
303
318err_t accel4_init ( accel4_t *ctx, accel4_cfg_t *cfg );
319
334
350err_t accel4_generic_write ( accel4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
351
367err_t accel4_generic_read ( accel4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
368
376uint8_t accel4_get_int1 ( accel4_t *ctx );
377
385uint8_t accel4_get_int2 ( accel4_t *ctx );
386
401
413
414#ifdef __cplusplus
415}
416#endif
417#endif // ACCEL4_H
418 // accel4
420
421// ------------------------------------------------------------------------ END
struct accel4_s accel4_t
Accel 4 Click context object.
accel4_return_value_t
Accel 4 Click return value data.
Definition: accel4.h:265
@ ACCEL4_OK
Definition: accel4.h:266
@ ACCEL4_ERROR
Definition: accel4.h:267
accel4_drv_t
Accel 4 Click driver selector.
Definition: accel4.h:187
@ ACCEL4_DRV_SEL_SPI
Definition: accel4.h:188
@ ACCEL4_DRV_SEL_I2C
Definition: accel4.h:189
err_t(* accel4_master_io_t)(struct accel4_s *, uint8_t, uint8_t *, uint8_t)
Accel 4 Click driver interface.
Definition: accel4.h:197
uint8_t accel4_get_int1(accel4_t *ctx)
Get interrupt 1 pin state.
err_t accel4_init(accel4_t *ctx, accel4_cfg_t *cfg)
Accel 4 initialization function.
err_t accel4_get_axes_data(accel4_t *ctx, accel4_axes_t *axes)
Accel data reading.
err_t accel4_generic_read(accel4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Accel 4 data reading function.
uint8_t accel4_get_int2(accel4_t *ctx)
Get interrupt 2 pin state.
void accel4_cfg_setup(accel4_cfg_t *cfg)
Accel 4 configuration object setup function.
void accel4_drv_interface_selection(accel4_cfg_t *cfg, accel4_drv_t drv_sel)
Accel 4 driver interface setup function.
err_t accel4_generic_write(accel4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Accel 4 data writing function.
err_t accel4_default_cfg(accel4_t *ctx)
Accel 4 default configuration function.
float accel4_axes_get_resolution(accel4_t *ctx)
Reads current resolution of output data.
This file contains SPI specific macros, functions, etc.
Accel 4 Click axes data.
Definition: accel4.h:253
float y
Definition: accel4.h:255
float x
Definition: accel4.h:254
float z
Definition: accel4.h:256
Accel 4 Click configuration object.
Definition: accel4.h:227
pin_name_t int1
Definition: accel4.h:235
pin_name_t int2
Definition: accel4.h:234
uint32_t i2c_speed
Definition: accel4.h:237
accel4_drv_t drv_sel
Definition: accel4.h:244
spi_master_chip_select_polarity_t cs_polarity
Definition: accel4.h:242
pin_name_t sck
Definition: accel4.h:232
spi_master_mode_t spi_mode
Definition: accel4.h:241
pin_name_t mosi
Definition: accel4.h:231
uint32_t spi_speed
Definition: accel4.h:240
pin_name_t scl
Definition: accel4.h:228
pin_name_t miso
Definition: accel4.h:230
pin_name_t sda
Definition: accel4.h:229
pin_name_t cs
Definition: accel4.h:233
uint8_t i2c_address
Definition: accel4.h:238
Accel 4 Click context object.
Definition: accel4.h:204
digital_in_t int2
Definition: accel4.h:205
spi_master_t spi
Definition: accel4.h:209
float resolution
Definition: accel4.h:218
accel4_drv_t drv_sel
Definition: accel4.h:213
digital_in_t int1
Definition: accel4.h:206
accel4_master_io_t read_f
Definition: accel4.h:216
i2c_master_t i2c
Definition: accel4.h:208
uint8_t slave_address
Definition: accel4.h:211
accel4_master_io_t write_f
Definition: accel4.h:215
pin_name_t chip_select
Definition: accel4.h:212