inclinometer  2.0.0.0
inclinometer.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 INCLINOMETER_H
29 #define INCLINOMETER_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 
59 #define INCLINOMETER_REG_ACC_X 0x01
60 #define INCLINOMETER_REG_ACC_Y 0x02
61 #define INCLINOMETER_REG_ACC_Z 0x03
62 #define INCLINOMETER_REG_STO 0x04
63 #define INCLINOMETER_REG_TEMP 0x05
64 #define INCLINOMETER_REG_STATUS 0x06
65 #define INCLINOMETER_REG_ERR_FLAG1 0x07
66 #define INCLINOMETER_REG_ERR_FLAG2 0x08
67 #define INCLINOMETER_REG_ANG_X 0x09
68 #define INCLINOMETER_REG_ANG_Y 0x0A
69 #define INCLINOMETER_REG_ANG_Z 0x0B
70 #define INCLINOMETER_REG_ANG_CTRL 0x0C
71 #define INCLINOMETER_REG_MODE 0x0D
72 #define INCLINOMETER_REG_WHOAMI 0x10
73 #define INCLINOMETER_REG_SERIAL1 0x19
74 #define INCLINOMETER_REG_SERIAL2 0x1A
75 #define INCLINOMETER_REG_SELBANK 0x1F
76  // inclinometer_reg
78 
93 #define INCLINOMETER_CMD_READ_ACC_X 0x040000F7
94 #define INCLINOMETER_CMD_READ_ACC_Y 0x080000FD
95 #define INCLINOMETER_CMD_READ_ACC_Z 0x0C0000FB
96 #define INCLINOMETER_CMD_READ_STO 0x100000E9
97 #define INCLINOMETER_CMD_EN_ANGLE_OUT 0xB0001F6F
98 #define INCLINOMETER_CMD_READ_ANG_X 0x240000C7
99 #define INCLINOMETER_CMD_READ_ANG_Y 0x280000CD
100 #define INCLINOMETER_CMD_READ_ANG_Z 0x2C0000CB
101 #define INCLINOMETER_CMD_READ_TEMP 0x140000EF
102 #define INCLINOMETER_CMD_READ_STATUS 0x180000E5
103 #define INCLINOMETER_CMD_READ_ERR_FLAG1 0x1C0000E3
104 #define INCLINOMETER_CMD_READ_ERR_FLAG2 0x200000C1
105 #define INCLINOMETER_CMD_READ_MODE 0x340000DF
106 #define INCLINOMETER_CMD_CHANGE_TO_MODE1 0xB400001F
107 #define INCLINOMETER_CMD_CHANGE_TO_MODE2 0xB4000102
108 #define INCLINOMETER_CMD_CHANGE_TO_MODE3 0xB4000225
109 #define INCLINOMETER_CMD_CHANGE_TO_MODE4 0xB4000338
110 #define INCLINOMETER_CMD_POWER_DOWN 0xB400046B
111 #define INCLINOMETER_CMD_WAKE_UP 0xB400001F
112 #define INCLINOMETER_CMD_SW_RESET 0xB4002098
113 #define INCLINOMETER_CMD_READ_WHOAMI 0x40000091
114 #define INCLINOMETER_CMD_READ_SERIAL1 0x640000A7
115 #define INCLINOMETER_CMD_READ_SERIAL2 0x680000AD
116 #define INCLINOMETER_CMD_READ_CURRENT_BANK 0x7C0000B3
117 #define INCLINOMETER_CMD_SWITCH_TO_BANK0 0xFC000073
118 #define INCLINOMETER_CMD_SWITCH_TO_BANK1 0xFC00016E
119  // inclinometer_cmd
121 
136 #define INCLINOMETER_MAP_MIKROBUS( cfg, mikrobus ) \
137  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
138  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
139  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
140  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
141  // inclinometer_map // inclinometer
144 
149 typedef struct
150 {
151  // Modules
152  spi_master_t spi;
154  pin_name_t chip_select;
156  uint8_t rs;
157  float resolution;
160 
165 typedef struct
166 {
167  // Communication gpio pins
168  pin_name_t miso;
169  pin_name_t mosi;
170  pin_name_t sck;
171  pin_name_t cs;
173  // static variable
174  uint32_t spi_speed;
175  spi_master_mode_t spi_mode;
176  spi_master_chip_select_polarity_t cs_polarity;
179 
184 typedef struct
185 {
186  float x;
187  float y;
188  float z;
191 
196 typedef enum
197 {
201 
203 
220 
236 
251 
264 err_t inclinometer_generic_write ( inclinometer_t *ctx, uint8_t reg, uint16_t data_in );
265 
278 err_t inclinometer_generic_read ( inclinometer_t *ctx, uint8_t reg, uint16_t *data_out );
279 
292 err_t inclinometer_cmd_write ( inclinometer_t *ctx, uint32_t cmd );
293 
307 err_t inclinometer_cmd_read ( inclinometer_t *ctx, uint32_t cmd, uint16_t *cmd_data );
308 
320 err_t inclinometer_get_temperature ( inclinometer_t *ctx, float *temperature );
321 
335 
349 
350 #ifdef __cplusplus
351 }
352 #endif
353 #endif // INCLINOMETER_H
354  // inclinometer
356 
357 // ------------------------------------------------------------------------ END
inclinometer_get_angle
err_t inclinometer_get_angle(inclinometer_t *ctx, inclinometer_accel_t *angle_data)
Angle reading.
inclinometer_t::chip_select
pin_name_t chip_select
Definition: inclinometer.h:154
inclinometer_cfg_t::sck
pin_name_t sck
Definition: inclinometer.h:170
inclinometer_accel_t::y
float y
Definition: inclinometer.h:187
inclinometer_default_cfg
err_t inclinometer_default_cfg(inclinometer_t *ctx)
Inclinometer default configuration function.
inclinometer_accel_t::z
float z
Definition: inclinometer.h:188
inclinometer_cmd_write
err_t inclinometer_cmd_write(inclinometer_t *ctx, uint32_t cmd)
CMD writing function.
inclinometer_t::resolution
float resolution
Definition: inclinometer.h:157
inclinometer_generic_read
err_t inclinometer_generic_read(inclinometer_t *ctx, uint8_t reg, uint16_t *data_out)
Data reading function.
inclinometer_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: inclinometer.h:176
inclinometer_get_temperature
err_t inclinometer_get_temperature(inclinometer_t *ctx, float *temperature)
Temperature reading.
inclinometer_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: inclinometer.h:175
inclinometer_cfg_t::miso
pin_name_t miso
Definition: inclinometer.h:168
inclinometer_t::spi
spi_master_t spi
Definition: inclinometer.h:152
INCLINOMETER_OK
@ INCLINOMETER_OK
Definition: inclinometer.h:198
inclinometer_accel_t::x
float x
Definition: inclinometer.h:186
inclinometer_return_value_t
inclinometer_return_value_t
Inclinometer Click return value data.
Definition: inclinometer.h:197
inclinometer_cfg_t::mosi
pin_name_t mosi
Definition: inclinometer.h:169
inclinometer_cfg_t::spi_speed
uint32_t spi_speed
Definition: inclinometer.h:174
inclinometer_cfg_t
Inclinometer Click configuration object.
Definition: inclinometer.h:166
inclinometer_cfg_t::cs
pin_name_t cs
Definition: inclinometer.h:171
inclinometer_init
err_t inclinometer_init(inclinometer_t *ctx, inclinometer_cfg_t *cfg)
Inclinometer initialization function.
inclinometer_t::rs
uint8_t rs
Definition: inclinometer.h:156
inclinometer_get_axes
err_t inclinometer_get_axes(inclinometer_t *ctx, inclinometer_accel_t *axes_data)
Axes reading.
INCLINOMETER_ERROR
@ INCLINOMETER_ERROR
Definition: inclinometer.h:199
inclinometer_generic_write
err_t inclinometer_generic_write(inclinometer_t *ctx, uint8_t reg, uint16_t data_in)
Data writing function.
inclinometer_t
Inclinometer Click context object.
Definition: inclinometer.h:150
inclinometer_accel_t
Inclinometer Click axis/angle data object.
Definition: inclinometer.h:185
inclinometer_cmd_read
err_t inclinometer_cmd_read(inclinometer_t *ctx, uint32_t cmd, uint16_t *cmd_data)
CMD reading function.
inclinometer_cfg_setup
void inclinometer_cfg_setup(inclinometer_cfg_t *cfg)
Inclinometer configuration object setup function.
INCLINOMETER_CRC_ERROR
@ INCLINOMETER_CRC_ERROR
Definition: inclinometer.h:200