inclinometer3  2.1.0.0
inclinometer3.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 INCLINOMETER3_H
29 #define INCLINOMETER3_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_spi_master.h"
52 #include "spi_specifics.h"
53 
74 #define INCLINOMETER3_REG_ACC_X 0x01
75 #define INCLINOMETER3_REG_ACC_Y 0x02
76 #define INCLINOMETER3_REG_TEMP 0x05
77 #define INCLINOMETER3_REG_STATUS 0x06
78 #define INCLINOMETER3_REG_ERR_FLAG1 0x07
79 #define INCLINOMETER3_REG_ERR_FLAG2 0x08
80 #define INCLINOMETER3_REG_MODE 0x0D
81 #define INCLINOMETER3_REG_WHOAMI 0x10
82 #define INCLINOMETER3_REG_SERIAL1 0x19
83 #define INCLINOMETER3_REG_SERIAL2 0x1A
84 #define INCLINOMETER3_REG_SELBANK 0x1F
85 
90 #define INCLINOMETER3_CMD_READ_ACC_X 0x040000F7ul
91 #define INCLINOMETER3_CMD_READ_ACC_Y 0x080000FDul
92 #define INCLINOMETER3_CMD_READ_TEMP 0x140000EFul
93 #define INCLINOMETER3_CMD_READ_STATUS 0x180000E5ul
94 #define INCLINOMETER3_CMD_READ_ERR_FLAG1 0x1C0000E3ul
95 #define INCLINOMETER3_CMD_READ_ERR_FLAG2 0x200000C1ul
96 #define INCLINOMETER3_CMD_READ_CMD 0x340000DFul
97 #define INCLINOMETER3_CMD_CHANGE_TO_MODE_A 0xB400001Ful
98 #define INCLINOMETER3_CMD_CHANGE_TO_MODE_B 0xB4000338ul
99 #define INCLINOMETER3_CMD_POWER_DOWN 0xB400046Bul
100 #define INCLINOMETER3_CMD_WAKE_UP 0xB400001Ful
101 #define INCLINOMETER3_CMD_SW_RESET 0xB4002098ul
102 #define INCLINOMETER3_CMD_READ_WHOAMI 0x40000091ul
103 #define INCLINOMETER3_CMD_READ_SERIAL1 0x640000A7ul
104 #define INCLINOMETER3_CMD_READ_SERIAL2 0x680000ADul
105 #define INCLINOMETER3_CMD_READ_CURRENT_BANK 0x7C0000B3ul
106 #define INCLINOMETER3_CMD_SWITCH_TO_BANK_0 0xFC000073ul
107 #define INCLINOMETER3_CMD_SWITCH_TO_BANK_1 0xFC00016Eul
108 
109  // inclinometer3_reg
111 
126 #define INCLINOMETER3_WHOAMI 0xE0
127 
132 #define INCLINOMETER3_SEL_BANK_0 0
133 #define INCLINOMETER3_SEL_BANK_1 1
134 #define INCLINOMETER3_SEL_MODE_A 0
135 #define INCLINOMETER3_SEL_MODE_B 1
136 
141 #define INCLINOMETER3_ACC_SENS_MODE_A 32.768f
142 #define INCLINOMETER3_ACC_SENS_MODE_B 16.384f
143 #define INCLINOMETER3_TEMP_SENS 18.9f
144 #define INCLINOMETER3_TEMP_CONVERT 273.0f
145 
150 #define INCLINOMETER3_RTN_STS_PROGRESS 0x00
151 #define INCLINOMETER3_RTN_STS_NORMAL 0x01
152 #define INCLINOMETER3_RTN_STS_ERROR 0x03
153 #define INCLINOMETER3_RTN_STS_BITMASK 0x03
154 
163 #define INCLINOMETER3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
164 #define INCLINOMETER3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
165  // inclinometer3_set
167 
182 #define INCLINOMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
183  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
184  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
185  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
186  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
187  // inclinometer3_map // inclinometer3
190 
195 typedef struct
196 {
197  // Modules
198  spi_master_t spi;
200  pin_name_t chip_select;
202  uint8_t rtn_sts;
203  float sensitivity;
206 
211 typedef struct
212 {
213  // Communication gpio pins
214  pin_name_t miso;
215  pin_name_t mosi;
216  pin_name_t sck;
217  pin_name_t cs;
219  // static variable
220  uint32_t spi_speed;
221  spi_master_mode_t spi_mode;
222  spi_master_chip_select_polarity_t cs_polarity;
225 
230 typedef enum
231 {
234 
236 
253 
268 
282 
296 err_t inclinometer3_reg_write ( inclinometer3_t *ctx, uint8_t reg, uint16_t data_in );
297 
311 err_t inclinometer3_reg_read ( inclinometer3_t *ctx, uint8_t reg, uint16_t *data_out );
312 
325 err_t inclinometer3_cmd_write ( inclinometer3_t *ctx, uint32_t op_cmd );
326 
339 err_t inclinometer3_cmd_read ( inclinometer3_t *ctx, uint32_t op_cmd, uint32_t *data_out );
340 
353 err_t inclinometer3_set_bank ( inclinometer3_t *ctx, uint8_t bank );
354 
367 
380 err_t inclinometer3_get_sensor_id ( inclinometer3_t *ctx, uint8_t *device_id );
381 
394 err_t inclinometer3_get_status ( inclinometer3_t *ctx, uint32_t *status );
395 
408 err_t inclinometer3_set_mode ( inclinometer3_t *ctx, uint8_t mode );
409 
423 err_t inclinometer3_get_axes_data ( inclinometer3_t *ctx, int16_t *x_data, int16_t *y_data );
424 
438 err_t inclinometer3_get_axes ( inclinometer3_t *ctx, float *x_axes, float *y_axes );
439 
452 err_t inclinometer3_get_temp_data ( inclinometer3_t *ctx, int16_t *temp_data );
453 
466 err_t inclinometer3_get_temperature ( inclinometer3_t *ctx, float *temperature );
467 
468 #ifdef __cplusplus
469 }
470 #endif
471 #endif // INCLINOMETER3_H
472  // inclinometer3
474 
475 // ------------------------------------------------------------------------ END
INCLINOMETER3_ERROR
@ INCLINOMETER3_ERROR
Definition: inclinometer3.h:233
inclinometer3_get_sensor_id
err_t inclinometer3_get_sensor_id(inclinometer3_t *ctx, uint8_t *device_id)
Inclinometer 3 get sensor ID function.
inclinometer3_get_axes_data
err_t inclinometer3_get_axes_data(inclinometer3_t *ctx, int16_t *x_data, int16_t *y_data)
Inclinometer 3 get the accel data function.
inclinometer3_reg_write
err_t inclinometer3_reg_write(inclinometer3_t *ctx, uint8_t reg, uint16_t data_in)
Inclinometer 3 data writing function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
inclinometer3_t::spi
spi_master_t spi
Definition: inclinometer3.h:198
inclinometer3_sw_reset
err_t inclinometer3_sw_reset(inclinometer3_t *ctx)
Inclinometer 3 software reset function.
inclinometer3_reg_read
err_t inclinometer3_reg_read(inclinometer3_t *ctx, uint8_t reg, uint16_t *data_out)
Inclinometer 3 data reading function.
inclinometer3_cfg_t::miso
pin_name_t miso
Definition: inclinometer3.h:214
inclinometer3_t
Inclinometer 3 Click context object.
Definition: inclinometer3.h:196
inclinometer3_cfg_t::mosi
pin_name_t mosi
Definition: inclinometer3.h:215
inclinometer3_get_temp_data
err_t inclinometer3_get_temp_data(inclinometer3_t *ctx, int16_t *temp_data)
Inclinometer 3 get the temperature data function.
inclinometer3_t::sensitivity
float sensitivity
Definition: inclinometer3.h:203
inclinometer3_set_bank
err_t inclinometer3_set_bank(inclinometer3_t *ctx, uint8_t bank)
Inclinometer 3 set bank function.
inclinometer3_cmd_write
err_t inclinometer3_cmd_write(inclinometer3_t *ctx, uint32_t op_cmd)
Inclinometer 3 command writing function.
inclinometer3_cfg_t::spi_speed
uint32_t spi_speed
Definition: inclinometer3.h:220
inclinometer3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: inclinometer3.h:222
inclinometer3_cmd_read
err_t inclinometer3_cmd_read(inclinometer3_t *ctx, uint32_t op_cmd, uint32_t *data_out)
Inclinometer 3 command reading function.
inclinometer3_set_mode
err_t inclinometer3_set_mode(inclinometer3_t *ctx, uint8_t mode)
Inclinometer 3 set mode function.
inclinometer3_init
err_t inclinometer3_init(inclinometer3_t *ctx, inclinometer3_cfg_t *cfg)
Inclinometer 3 initialization function.
inclinometer3_cfg_t::cs
pin_name_t cs
Definition: inclinometer3.h:217
inclinometer3_cfg_t
Inclinometer 3 Click configuration object.
Definition: inclinometer3.h:212
inclinometer3_default_cfg
err_t inclinometer3_default_cfg(inclinometer3_t *ctx)
Inclinometer 3 default configuration function.
inclinometer3_t::chip_select
pin_name_t chip_select
Definition: inclinometer3.h:200
inclinometer3_get_axes
err_t inclinometer3_get_axes(inclinometer3_t *ctx, float *x_axes, float *y_axes)
Inclinometer 3 get the accel sensor axes function.
inclinometer3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: inclinometer3.h:221
inclinometer3_t::rtn_sts
uint8_t rtn_sts
Definition: inclinometer3.h:202
inclinometer3_get_status
err_t inclinometer3_get_status(inclinometer3_t *ctx, uint32_t *status)
Inclinometer 3 get status function.
inclinometer3_cfg_setup
void inclinometer3_cfg_setup(inclinometer3_cfg_t *cfg)
Inclinometer 3 configuration object setup function.
inclinometer3_return_value_t
inclinometer3_return_value_t
Inclinometer 3 Click return value data.
Definition: inclinometer3.h:231
inclinometer3_cfg_t::sck
pin_name_t sck
Definition: inclinometer3.h:216
inclinometer3_get_temperature
err_t inclinometer3_get_temperature(inclinometer3_t *ctx, float *temperature)
Inclinometer 3 get the temperature function.
INCLINOMETER3_OK
@ INCLINOMETER3_OK
Definition: inclinometer3.h:232