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 #include "spi_specifics.h"
39 
60 #define INCLINOMETER_REG_ACC_X 0x01
61 #define INCLINOMETER_REG_ACC_Y 0x02
62 #define INCLINOMETER_REG_ACC_Z 0x03
63 #define INCLINOMETER_REG_STO 0x04
64 #define INCLINOMETER_REG_TEMP 0x05
65 #define INCLINOMETER_REG_STATUS 0x06
66 #define INCLINOMETER_REG_ERR_FLAG1 0x07
67 #define INCLINOMETER_REG_ERR_FLAG2 0x08
68 #define INCLINOMETER_REG_ANG_X 0x09
69 #define INCLINOMETER_REG_ANG_Y 0x0A
70 #define INCLINOMETER_REG_ANG_Z 0x0B
71 #define INCLINOMETER_REG_ANG_CTRL 0x0C
72 #define INCLINOMETER_REG_MODE 0x0D
73 #define INCLINOMETER_REG_WHOAMI 0x10
74 #define INCLINOMETER_REG_SERIAL1 0x19
75 #define INCLINOMETER_REG_SERIAL2 0x1A
76 #define INCLINOMETER_REG_SELBANK 0x1F
77  // inclinometer_reg
79 
94 #define INCLINOMETER_CMD_READ_ACC_X 0x040000F7
95 #define INCLINOMETER_CMD_READ_ACC_Y 0x080000FD
96 #define INCLINOMETER_CMD_READ_ACC_Z 0x0C0000FB
97 #define INCLINOMETER_CMD_READ_STO 0x100000E9
98 #define INCLINOMETER_CMD_EN_ANGLE_OUT 0xB0001F6F
99 #define INCLINOMETER_CMD_READ_ANG_X 0x240000C7
100 #define INCLINOMETER_CMD_READ_ANG_Y 0x280000CD
101 #define INCLINOMETER_CMD_READ_ANG_Z 0x2C0000CB
102 #define INCLINOMETER_CMD_READ_TEMP 0x140000EF
103 #define INCLINOMETER_CMD_READ_STATUS 0x180000E5
104 #define INCLINOMETER_CMD_READ_ERR_FLAG1 0x1C0000E3
105 #define INCLINOMETER_CMD_READ_ERR_FLAG2 0x200000C1
106 #define INCLINOMETER_CMD_READ_MODE 0x340000DF
107 #define INCLINOMETER_CMD_CHANGE_TO_MODE1 0xB400001F
108 #define INCLINOMETER_CMD_CHANGE_TO_MODE2 0xB4000102
109 #define INCLINOMETER_CMD_CHANGE_TO_MODE3 0xB4000225
110 #define INCLINOMETER_CMD_CHANGE_TO_MODE4 0xB4000338
111 #define INCLINOMETER_CMD_POWER_DOWN 0xB400046B
112 #define INCLINOMETER_CMD_WAKE_UP 0xB400001F
113 #define INCLINOMETER_CMD_SW_RESET 0xB4002098
114 #define INCLINOMETER_CMD_READ_WHOAMI 0x40000091
115 #define INCLINOMETER_CMD_READ_SERIAL1 0x640000A7
116 #define INCLINOMETER_CMD_READ_SERIAL2 0x680000AD
117 #define INCLINOMETER_CMD_READ_CURRENT_BANK 0x7C0000B3
118 #define INCLINOMETER_CMD_SWITCH_TO_BANK0 0xFC000073
119 #define INCLINOMETER_CMD_SWITCH_TO_BANK1 0xFC00016E
120  // inclinometer_cmd
122 
137 #define INCLINOMETER_MAP_MIKROBUS( cfg, mikrobus ) \
138  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
139  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
140  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
141  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
142  // inclinometer_map // inclinometer
145 
150 typedef struct
151 {
152  // Modules
153  spi_master_t spi;
155  pin_name_t chip_select;
157  uint8_t rs;
158  float resolution;
161 
166 typedef struct
167 {
168  // Communication gpio pins
169  pin_name_t miso;
170  pin_name_t mosi;
171  pin_name_t sck;
172  pin_name_t cs;
174  // static variable
175  uint32_t spi_speed;
176  spi_master_mode_t spi_mode;
177  spi_master_chip_select_polarity_t cs_polarity;
180 
185 typedef struct
186 {
187  float x;
188  float y;
189  float z;
192 
197 typedef enum
198 {
202 
204 
221 
237 
252 
265 err_t inclinometer_generic_write ( inclinometer_t *ctx, uint8_t reg, uint16_t data_in );
266 
279 err_t inclinometer_generic_read ( inclinometer_t *ctx, uint8_t reg, uint16_t *data_out );
280 
293 err_t inclinometer_cmd_write ( inclinometer_t *ctx, uint32_t cmd );
294 
308 err_t inclinometer_cmd_read ( inclinometer_t *ctx, uint32_t cmd, uint16_t *cmd_data );
309 
321 err_t inclinometer_get_temperature ( inclinometer_t *ctx, float *temperature );
322 
336 
350 
351 #ifdef __cplusplus
352 }
353 #endif
354 #endif // INCLINOMETER_H
355  // inclinometer
357 
358 // ------------------------------------------------------------------------ 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:155
inclinometer_cfg_t::sck
pin_name_t sck
Definition: inclinometer.h:171
inclinometer_accel_t::y
float y
Definition: inclinometer.h:188
inclinometer_default_cfg
err_t inclinometer_default_cfg(inclinometer_t *ctx)
Inclinometer default configuration function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
inclinometer_accel_t::z
float z
Definition: inclinometer.h:189
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:158
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:177
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:176
inclinometer_cfg_t::miso
pin_name_t miso
Definition: inclinometer.h:169
inclinometer_t::spi
spi_master_t spi
Definition: inclinometer.h:153
INCLINOMETER_OK
Definition: inclinometer.h:199
inclinometer_accel_t::x
float x
Definition: inclinometer.h:187
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:170
inclinometer_cfg_t::spi_speed
uint32_t spi_speed
Definition: inclinometer.h:175
inclinometer_cfg_t
Inclinometer Click configuration object.
Definition: inclinometer.h:166
inclinometer_cfg_t::cs
pin_name_t cs
Definition: inclinometer.h:172
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:157
inclinometer_get_axes
err_t inclinometer_get_axes(inclinometer_t *ctx, inclinometer_accel_t *axes_data)
Axes reading.
INCLINOMETER_ERROR
Definition: inclinometer.h:200
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
Definition: inclinometer.h:201