inclinometer4  2.1.0.0
inclinometer4.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 INCLINOMETER4_H
29 #define INCLINOMETER4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 #include "drv_spi_master.h"
53 #include "spi_specifics.h"
54 
75 #define INCLINOMETER4_REG_INT_STATUS 0x00
76 #define INCLINOMETER4_REG_TEMP_OUT 0x01
77 #define INCLINOMETER4_REG_VECM_LSB 0x02
78 #define INCLINOMETER4_REG_VECM_MSB 0x03
79 #define INCLINOMETER4_REG_OUT_X_LSB 0x04
80 #define INCLINOMETER4_REG_OUT_X_MSB 0x05
81 #define INCLINOMETER4_REG_OUT_Y_LSB 0x06
82 #define INCLINOMETER4_REG_OUT_Y_MSB 0x07
83 #define INCLINOMETER4_REG_OUT_Z_LSB 0x08
84 #define INCLINOMETER4_REG_OUT_Z_MSB 0x09
85 #define INCLINOMETER4_REG_BUF_STATUS 0x0B
86 #define INCLINOMETER4_REG_BUF_X_LSB 0x0C
87 #define INCLINOMETER4_REG_BUF_X_MSB 0x0D
88 #define INCLINOMETER4_REG_BUF_Y_LSB 0x0E
89 #define INCLINOMETER4_REG_BUF_Y_MSB 0x0F
90 #define INCLINOMETER4_REG_BUF_Z_LSB 0x10
91 #define INCLINOMETER4_REG_BUF_Z_MSB 0x11
92 #define INCLINOMETER4_REG_PROD_REV 0x12
93 #define INCLINOMETER4_REG_WHO_AM_I 0x13
94 #define INCLINOMETER4_REG_SYS_MODE 0x14
95 #define INCLINOMETER4_REG_SENS_CONFIG1 0x15
96 #define INCLINOMETER4_REG_SENS_CONFIG2 0x16
97 #define INCLINOMETER4_REG_SENS_CONFIG3 0x17
98 #define INCLINOMETER4_REG_SENS_CONFIG4 0x18
99 #define INCLINOMETER4_REG_SENS_CONFIG5 0x19
100 #define INCLINOMETER4_REG_WAKE_IDLE_LSB 0x1A
101 #define INCLINOMETER4_REG_WAKE_IDLE_MSB 0x1B
102 #define INCLINOMETER4_REG_SLEEP_IDLE_LSB 0x1C
103 #define INCLINOMETER4_REG_SLEEP_IDLE_MSB 0x1D
104 #define INCLINOMETER4_REG_ASLP_COUNT_LSB 0x1E
105 #define INCLINOMETER4_REG_ASLP_COUNT_MSB 0x1F
106 #define INCLINOMETER4_REG_INT_EN 0x20
107 #define INCLINOMETER4_REG_INT_PIN_SEL 0x21
108 #define INCLINOMETER4_REG_OFF_X 0x22
109 #define INCLINOMETER4_REG_OFF_Y 0x23
110 #define INCLINOMETER4_REG_OFF_Z 0x24
111 #define INCLINOMETER4_REG_BUF_CONFIG1 0x26
112 #define INCLINOMETER4_REG_BUF_CONFIG2 0x27
113 #define INCLINOMETER4_REG_ORIENT_STATUS 0x28
114 #define INCLINOMETER4_REG_ORIENT_CONFIG 0x29
115 #define INCLINOMETER4_REG_ORIENT_DBCOUNT 0x2A
116 #define INCLINOMETER4_REG_ORIENT_BF_ZCOMP 0x2B
117 #define INCLINOMETER4_REG_ORIENT_THS_REG 0x2C
118 #define INCLINOMETER4_REG_SDCD_INT_SRC1 0x2D
119 #define INCLINOMETER4_REG_SDCD_INT_SRC2 0x2E
120 #define INCLINOMETER4_REG_SDCD_CONFIG1 0x2F
121 #define INCLINOMETER4_REG_SDCD_CONFIG2 0x30
122 #define INCLINOMETER4_REG_SDCD_OT_DBCNT 0x31
123 #define INCLINOMETER4_REG_SDCD_WT_DBCNT 0x32
124 #define INCLINOMETER4_REG_SDCD_LTHS_LSB 0x33
125 #define INCLINOMETER4_REG_SDCD_LTHS_MSB 0x34
126 #define INCLINOMETER4_REG_SDCD_UTHS_LSB 0x35
127 #define INCLINOMETER4_REG_SDCD_UTHS_MSB 0x36
128 #define INCLINOMETER4_REG_SELF_TEST_CONFIG1 0x37
129 #define INCLINOMETER4_REG_SELF_TEST_CONFIG2 0x38
130  // inclinometer4_reg
132 
147 #define INCLINOMETER4_INT_STATUS_SRC_DRDY 0x80
148 #define INCLINOMETER4_INT_STATUS_SRC_OVF 0x40
149 #define INCLINOMETER4_INT_STATUS_SRC_BUF 0x20
150 #define INCLINOMETER4_INT_STATUS_SRC_SDCD_OT 0x10
151 #define INCLINOMETER4_INT_STATUS_SRC_SDCD_WT 0x08
152 #define INCLINOMETER4_INT_STATUS_SRC_ORIENT 0x04
153 #define INCLINOMETER4_INT_STATUS_SRC_ASLP 0x02
154 #define INCLINOMETER4_INT_STATUS_SRC_BOOT 0x01
155 
160 #define INCLINOMETER4_WHO_AM_I 0x83
161 
166 #define INCLINOMETER4_SENS_CONFIG1_RST 0x80
167 #define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_DIS 0x00
168 #define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_X 0x20
169 #define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_Y 0x40
170 #define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_Z 0x60
171 #define INCLINOMETER4_SENS_CONFIG1_ST_AXIS_SEL_MASK 0x60
172 #define INCLINOMETER4_SENS_CONFIG1_ST_POL 0x10
173 #define INCLINOMETER4_SENS_CONFIG1_SPI_M_4_WIRE 0x00
174 #define INCLINOMETER4_SENS_CONFIG1_SPI_M_3_WIRE 0x08
175 #define INCLINOMETER4_SENS_CONFIG1_SPI_M_MASK 0x08
176 #define INCLINOMETER4_SENS_CONFIG1_FSR_2G 0x00
177 #define INCLINOMETER4_SENS_CONFIG1_FSR_4G 0x02
178 #define INCLINOMETER4_SENS_CONFIG1_FSR_8G 0x04
179 #define INCLINOMETER4_SENS_CONFIG1_FSR_16G 0x06
180 #define INCLINOMETER4_SENS_CONFIG1_FSR_MASK 0x06
181 #define INCLINOMETER4_SENS_CONFIG1_MODE_STANDBY 0x00
182 #define INCLINOMETER4_SENS_CONFIG1_MODE_ACTIVE 0x01
183 #define INCLINOMETER4_SENS_CONFIG1_MODE_MASK 0x01
184 
189 #define INCLINOMETER4_SENS_CONFIG3_WAKE_ODR_MASK 0xF0
190 #define INCLINOMETER4_SENS_CONFIG3_SLEEP_ODR_MASK 0x0F
191 
196 #define INCLINOMETER4_SENS_CONFIG4_EXT_TRIG_M 0x80
197 #define INCLINOMETER4_SENS_CONFIG4_WAKE_SDCD_WT 0x40
198 #define INCLINOMETER4_SENS_CONFIG4_WAKE_SDCD_OT 0x20
199 #define INCLINOMETER4_SENS_CONFIG4_WAKE_ORIENT 0x10
200 #define INCLINOMETER4_SENS_CONFIG4_DRDY_PUL 0x08
201 #define INCLINOMETER4_SENS_CONFIG4_INT2_FUNC 0x04
202 #define INCLINOMETER4_SENS_CONFIG4_INT_PP_OD 0x02
203 #define INCLINOMETER4_SENS_CONFIG4_INT_POL 0x01
204 
209 #define INCLINOMETER4_INT_EN_DRDY 0x80
210 #define INCLINOMETER4_INT_EN_BUF 0x40
211 #define INCLINOMETER4_INT_EN_SDCD_OT 0x20
212 #define INCLINOMETER4_INT_EN_SDCD_WT 0x10
213 #define INCLINOMETER4_INT_EN_ORIENT 0x08
214 #define INCLINOMETER4_INT_EN_ASLP 0x04
215 #define INCLINOMETER4_INT_EN_BOOT_DIS 0x02
216 #define INCLINOMETER4_INT_EN_WAKE_OUT 0x01
217 
222 #define INCLINOMETER4_INT_PIN_SEL_DRDY_INT2 0x80
223 #define INCLINOMETER4_INT_PIN_SEL_BUF_INT2 0x40
224 #define INCLINOMETER4_INT_PIN_SEL_SDCD_OT_INT2 0x20
225 #define INCLINOMETER4_INT_PIN_SEL_SDCD_WT_INT2 0x10
226 #define INCLINOMETER4_INT_PIN_SEL_ORIENT_INT2 0x08
227 #define INCLINOMETER4_INT_PIN_SEL_ASLP_INT2 0x04
228 #define INCLINOMETER4_INT_PIN_SEL_BOOT_INT2 0x02
229 #define INCLINOMETER4_INT_PIN_SEL_WAKE_OUT_INT2 0x01
230 
235 #define INCLINOMETER4_MODE_STANDBY 0
236 #define INCLINOMETER4_MODE_ACTIVE 1
237 
242 #define INCLINOMETER4_FSR_2G 0
243 #define INCLINOMETER4_FSR_4G 1
244 #define INCLINOMETER4_FSR_8G 2
245 #define INCLINOMETER4_FSR_16G 3
246 
251 #define INCLINOMETER4_ODR_3200_HZ 0
252 #define INCLINOMETER4_ODR_1600_HZ 1
253 #define INCLINOMETER4_ODR_800_HZ 2
254 #define INCLINOMETER4_ODR_400_HZ 3
255 #define INCLINOMETER4_ODR_200_HZ 4
256 #define INCLINOMETER4_ODR_100_HZ 5
257 #define INCLINOMETER4_ODR_50_HZ 6
258 #define INCLINOMETER4_ODR_25_HZ 7
259 #define INCLINOMETER4_ODR_12_5_HZ 8
260 #define INCLINOMETER4_ODR_6_25_HZ 9
261 #define INCLINOMETER4_ODR_3_125_HZ 10
262 #define INCLINOMETER4_ODR_1_563_HZ 11
263 #define INCLINOMETER4_ODR_0_781_HZ 12
264 
269 #define INCLINOMETER4_LSB_PER_G_FSR_2G 1024
270 #define INCLINOMETER4_LSB_PER_G_FSR_4G 512
271 #define INCLINOMETER4_LSB_PER_G_FSR_8G 256
272 #define INCLINOMETER4_LSB_PER_G_FSR_16G 128
273 
278 #define INCLINOMETER4_TEMP_OFFSET 25
279 
285 #define INCLINOMETER4_DEVICE_ADDRESS_0 0x18
286 #define INCLINOMETER4_DEVICE_ADDRESS_1 0x19
287 
296 #define INCLINOMETER4_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
297 #define INCLINOMETER4_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
298  // inclinometer4_set
300 
315 #define INCLINOMETER4_MAP_MIKROBUS( cfg, mikrobus ) \
316  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
317  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
318  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
319  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
320  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
321  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
322  cfg.int2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
323  cfg.int1 = MIKROBUS( mikrobus, MIKROBUS_INT )
324  // inclinometer4_map // inclinometer4
327 
332 typedef enum
333 {
338 
343 struct inclinometer4_s;
344 typedef err_t ( *inclinometer4_master_io_t )( struct inclinometer4_s*, uint8_t, uint8_t*, uint8_t );
350 typedef struct inclinometer4_s
351 {
352  digital_in_t int2;
353  digital_in_t int1;
355  i2c_master_t i2c;
356  spi_master_t spi;
358  uint8_t slave_address;
359  pin_name_t chip_select;
365  uint16_t lsb_per_g;
368 
373 typedef struct
374 {
375  pin_name_t scl;
376  pin_name_t sda;
377  pin_name_t miso;
378  pin_name_t mosi;
379  pin_name_t sck;
380  pin_name_t cs;
381  pin_name_t int2;
382  pin_name_t int1;
384  uint32_t i2c_speed;
385  uint8_t i2c_address;
387  uint32_t spi_speed;
388  spi_master_mode_t spi_mode;
389  spi_master_chip_select_polarity_t cs_polarity;
394 
399 typedef struct
400 {
401  float x;
402  float y;
403  float z;
404  int8_t temperature;
407 
412 typedef enum
413 {
416 
418 
435 
451 
466 
480 
495 err_t inclinometer4_write_regs ( inclinometer4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
496 
511 err_t inclinometer4_read_regs ( inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
512 
525 err_t inclinometer4_write_reg ( inclinometer4_t *ctx, uint8_t reg, uint8_t data_in );
526 
539 err_t inclinometer4_read_reg ( inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out );
540 
550 
560 
572 
584 err_t inclinometer4_get_status ( inclinometer4_t *ctx, uint8_t *status );
585 
597 
610 err_t inclinometer4_set_mode ( inclinometer4_t *ctx, uint8_t mode );
611 
626 err_t inclinometer4_set_fsr ( inclinometer4_t *ctx, uint8_t fsr );
627 
651 err_t inclinometer4_set_odr ( inclinometer4_t *ctx, uint8_t odr );
652 
666 
667 #ifdef __cplusplus
668 }
669 #endif
670 #endif // INCLINOMETER4_H
671  // inclinometer4
673 
674 // ------------------------------------------------------------------------ END
inclinometer4_s::int2
digital_in_t int2
Definition: inclinometer4.h:352
INCLINOMETER4_DRV_SEL_SPI
@ INCLINOMETER4_DRV_SEL_SPI
Definition: inclinometer4.h:334
inclinometer4_s::chip_select
pin_name_t chip_select
Definition: inclinometer4.h:359
inclinometer4_s
Inclinometer 4 Click context object.
Definition: inclinometer4.h:351
inclinometer4_cfg_t::cs
pin_name_t cs
Definition: inclinometer4.h:380
inclinometer4_cfg_t::i2c_address
uint8_t i2c_address
Definition: inclinometer4.h:385
inclinometer4_cfg_t::miso
pin_name_t miso
Definition: inclinometer4.h:377
inclinometer4_set_odr
err_t inclinometer4_set_odr(inclinometer4_t *ctx, uint8_t odr)
Inclinometer 4 set odr function.
inclinometer4_s::drv_sel
inclinometer4_drv_t drv_sel
Definition: inclinometer4.h:360
spi_specifics.h
This file contains SPI specific macros, functions, etc.
inclinometer4_cfg_t::sda
pin_name_t sda
Definition: inclinometer4.h:376
inclinometer4_data_t
Inclinometer 4 Click Axes data structure.
Definition: inclinometer4.h:400
inclinometer4_t
struct inclinometer4_s inclinometer4_t
Inclinometer 4 Click context object.
inclinometer4_set_mode
err_t inclinometer4_set_mode(inclinometer4_t *ctx, uint8_t mode)
Inclinometer 4 set mode function.
inclinometer4_data_t::z
float z
Definition: inclinometer4.h:403
inclinometer4_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: inclinometer4.h:389
INCLINOMETER4_OK
@ INCLINOMETER4_OK
Definition: inclinometer4.h:414
inclinometer4_read_regs
err_t inclinometer4_read_regs(inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Inclinometer 4 read regs function.
inclinometer4_get_int2_pin
uint8_t inclinometer4_get_int2_pin(inclinometer4_t *ctx)
Inclinometer 4 get int2 pin function.
inclinometer4_data_t::y
float y
Definition: inclinometer4.h:402
inclinometer4_cfg_t::int1
pin_name_t int1
Definition: inclinometer4.h:382
inclinometer4_data_t::temperature
int8_t temperature
Definition: inclinometer4.h:404
inclinometer4_return_value_t
inclinometer4_return_value_t
Inclinometer 4 Click return value data.
Definition: inclinometer4.h:413
inclinometer4_set_fsr
err_t inclinometer4_set_fsr(inclinometer4_t *ctx, uint8_t fsr)
Inclinometer 4 set fsr function.
inclinometer4_drv_interface_sel
void inclinometer4_drv_interface_sel(inclinometer4_cfg_t *cfg, inclinometer4_drv_t drv_sel)
Inclinometer 4 driver interface setup function.
INCLINOMETER4_DRV_SEL_I2C
@ INCLINOMETER4_DRV_SEL_I2C
Definition: inclinometer4.h:335
inclinometer4_s::read_f
inclinometer4_master_io_t read_f
Definition: inclinometer4.h:363
inclinometer4_get_int1_pin
uint8_t inclinometer4_get_int1_pin(inclinometer4_t *ctx)
Inclinometer 4 get int1 pin function.
inclinometer4_write_regs
err_t inclinometer4_write_regs(inclinometer4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Inclinometer 4 write regs function.
inclinometer4_read_reg
err_t inclinometer4_read_reg(inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out)
Inclinometer 4 read reg function.
inclinometer4_cfg_t::mosi
pin_name_t mosi
Definition: inclinometer4.h:378
inclinometer4_drv_t
inclinometer4_drv_t
Inclinometer 4 Click driver selector.
Definition: inclinometer4.h:333
inclinometer4_data_t::x
float x
Definition: inclinometer4.h:401
inclinometer4_cfg_t::scl
pin_name_t scl
Definition: inclinometer4.h:375
inclinometer4_get_status
err_t inclinometer4_get_status(inclinometer4_t *ctx, uint8_t *status)
Inclinometer 4 get status function.
inclinometer4_master_io_t
err_t(* inclinometer4_master_io_t)(struct inclinometer4_s *, uint8_t, uint8_t *, uint8_t)
Definition: inclinometer4.h:344
inclinometer4_s::i2c
i2c_master_t i2c
Definition: inclinometer4.h:355
inclinometer4_cfg_t
Inclinometer 4 Click configuration object.
Definition: inclinometer4.h:374
inclinometer4_write_reg
err_t inclinometer4_write_reg(inclinometer4_t *ctx, uint8_t reg, uint8_t data_in)
Inclinometer 4 write reg function.
inclinometer4_cfg_t::sck
pin_name_t sck
Definition: inclinometer4.h:379
inclinometer4_cfg_t::int2
pin_name_t int2
Definition: inclinometer4.h:381
inclinometer4_s::lsb_per_g
uint16_t lsb_per_g
Definition: inclinometer4.h:365
inclinometer4_default_cfg
err_t inclinometer4_default_cfg(inclinometer4_t *ctx)
Inclinometer 4 default configuration function.
inclinometer4_s::slave_address
uint8_t slave_address
Definition: inclinometer4.h:358
inclinometer4_init
err_t inclinometer4_init(inclinometer4_t *ctx, inclinometer4_cfg_t *cfg)
Inclinometer 4 initialization function.
inclinometer4_get_data
err_t inclinometer4_get_data(inclinometer4_t *ctx, inclinometer4_data_t *data_out)
Inclinometer 4 get data function.
inclinometer4_check_comm
err_t inclinometer4_check_comm(inclinometer4_t *ctx)
Inclinometer 4 check comm function.
inclinometer4_cfg_setup
void inclinometer4_cfg_setup(inclinometer4_cfg_t *cfg)
Inclinometer 4 configuration object setup function.
inclinometer4_cfg_t::drv_sel
inclinometer4_drv_t drv_sel
Definition: inclinometer4.h:391
INCLINOMETER4_ERROR
@ INCLINOMETER4_ERROR
Definition: inclinometer4.h:415
inclinometer4_s::spi
spi_master_t spi
Definition: inclinometer4.h:356
inclinometer4_cfg_t::spi_speed
uint32_t spi_speed
Definition: inclinometer4.h:387
inclinometer4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: inclinometer4.h:384
inclinometer4_s::int1
digital_in_t int1
Definition: inclinometer4.h:353
inclinometer4_sw_reset
err_t inclinometer4_sw_reset(inclinometer4_t *ctx)
Inclinometer 4 sw reset function.
inclinometer4_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: inclinometer4.h:388
inclinometer4_s::write_f
inclinometer4_master_io_t write_f
Definition: inclinometer4.h:362