compass3  2.0.0.0
compass3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef COMPASS3_H
36 #define COMPASS3_H
37 
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define COMPASS3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
56 
62 #define COMPASS3_RETVAL uint8_t
63 
64 #define COMPASS3_OK 0x00
65 #define COMPASS3_INIT_ERROR 0xFF
66 
72 #define COMPASS3_SLAVE_ADR 0x30
73 
79 #define COMPASS3_XOUT_LSB 0x00
80 #define COMPASS3_XOUT_MSB 0x01
81 #define COMPASS3_YOUT_LSB 0x02
82 #define COMPASS3_YOUT_MSB 0x03
83 #define COMPASS3_ZOUT_LSB 0x04
84 #define COMPASS3_ZOUT_MSB 0x05
85 #define COMPASS3_TEMP 0x06
86 #define COMPASS3_STAT 0x07
87 #define COMPASS3_INTERNAL_CTRL_0 0x08
88 #define COMPASS3_INTERNAL_CTRL_1 0x09
89 #define COMPASS3_INTERNAL_CTRL_2 0x0A
90 #define COMPASS3_X_TRSH 0x0B
91 #define COMPASS3_Y_TRSH 0x0C
92 #define COMPASS3_Z_TRSH 0x0D
93 #define COMPASS3_DEVICE_ID 0x2F
94 
100 #define COMPASS3_MEAS_M_DONE 0x01
101 #define COMPASS3_MEAS_T_DONE 0x02
102 #define COMPASS3_MOTION_DCT 0x04
103 #define COMPASS3_PUMP_ON 0x08
104 #define COMPASS3_OTP_RD_DONE 0x10
105 
111 #define COMPASS3_TEST_PIN_SEL 0x80
112 #define COMPASS3_OTP_RD 0x40
113 #define COMPASS3_RSRVD 0x20
114 #define COMPASS3_RESET 0x10
115 #define COMPASS3_SET 0x08
116 #define COMPASS3_START_MD_T 0x04
117 #define COMPASS3_TM_T 0x02
118 #define COMPASS3_TM_M 0x01
119 
125 #define COMPASS3_SW_RST 0x80
126 #define COMPASS3_OTP_BL_SEL1 0x40
127 #define COMPASS3_OTP_BL_SEL0 0x20
128 #define COMPASS3_Z_INH 0x10
129 #define COMPASS3_Y_INH 0x08
130 #define COMPASS3_X_INH 0x04
131 #define COMPASS3_BW_ODR_600 0x03
132 #define COMPASS3_BW_ODR_400 0x02
133 #define COMPASS3_BW_ODR_200 0x01
134 #define COMPASS3_BW_ODR_100 0x00
135 
141 #define COMPASS3_ULP_SEL 0x80
142 #define COMPASS3_INT_MEAS_DONE_EN 0x40
143 #define COMPASS3_INT_MDT_EN 0x20
144 #define COMPASS3_Force_VDDL_STBY 0x10
145 #define COMPASS3_CM_FREQ_0_015625HZ 0x0A
146 #define COMPASS3_CM_FREQ_0_03125HZ 0x09
147 #define COMPASS3_CM_FREQ_0_0625HZ 0x08
148 #define COMPASS3_CM_FREQ_0_125HZ 0x07
149 #define COMPASS3_CM_FREQ_0_25HZ 0x06
150 #define COMPASS3_CM_FREQ_0_5HZ 0x05
151 #define COMPASS3_CM_FREQ_1HZ 0x04
152 #define COMPASS3_CM_FREQ_2_2HZ 0x03
153 #define COMPASS3_CM_FREQ_5HZ 0x02
154 #define COMPASS3_CM_FREQ_14HZ 0x01
155 #define COMPASS3_CM_FREQ_CONT 0x00
156 
162 #define COMPASS3_DYNAMIC_RANGE 16
163 #define COMPASS3_MAG_LSB_VALUE 0.25
164 #define COMPASS3_TEMP_LSB_VALUE 0.7
165 #define COMPASS3_MAG_RANGE_VALUE 8000
166 #define COMPASS3_TEMP_RANGE_VALUE 75
167 #define COMPASS3_RESOLUTION 65536
168 
174 #define COMPASS3_INTERRUPT 0x01
175 #define COMPASS3_NO_INTERRUPT 0x00
176 
182 #define COMPASS3_DEVICE_ID_NUM 0x0C
183  // End group macro
186 // --------------------------------------------------------------- PUBLIC TYPES
195 typedef struct
196 {
197  // Input pins
198 
199  digital_in_t int_pin;
200 
201  // Modules
202 
203  i2c_master_t i2c;
204 
205  // ctx variable
206 
207  uint8_t slave_address;
208 
209 } compass3_t;
210 
214 typedef struct
215 {
216  // Communication gpio pins
217 
218  pin_name_t scl;
219  pin_name_t sda;
220 
221  // Additional gpio pins
222 
223  pin_name_t int_pin;
224 
225  // static variable
226 
227  uint32_t i2c_speed;
228  uint8_t i2c_address;
229 
231  // End types group
233 // ------------------------------------------------------------------ CONSTANTS // End constants group
242 // ------------------------------------------------------------------ VARIABLES // End variable group
250 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
251 
257 #ifdef __cplusplus
258 extern "C"{
259 #endif
260 
271 
281 
290 
301 void compass3_generic_write ( compass3_t *ctx, uint8_t reg, uint8_t *data_buf,
302  uint8_t len );
303 
315 void compass3_generic_read ( compass3_t *ctx, uint8_t reg, uint8_t *data_buf,
316  uint8_t len );
317 
328 void compass3_full_measurement ( compass3_t *ctx, float *x_val, float *y_val,
329  float *z_val );
330 
341 
352 
353 #ifdef __cplusplus
354 }
355 #endif
356 #endif // _COMPASS3_H_
357  // End public_function group
360 
361 // ------------------------------------------------------------------------- END
compass3_t::int_pin
digital_in_t int_pin
Definition: compass3.h:199
compass3_cfg_t::sda
pin_name_t sda
Definition: compass3.h:219
compass3_cfg_t::i2c_address
uint8_t i2c_address
Definition: compass3.h:228
compass3_cfg_t
Click configuration structure definition.
Definition: compass3.h:215
compass3_t::slave_address
uint8_t slave_address
Definition: compass3.h:207
compass3_read_temp
float compass3_read_temp(compass3_t *ctx)
Read temperature function.
compass3_full_measurement
void compass3_full_measurement(compass3_t *ctx, float *x_val, float *y_val, float *z_val)
Full measurement function.
compass3_init
COMPASS3_RETVAL compass3_init(compass3_t *ctx, compass3_cfg_t *cfg)
Initialization function.
compass3_default_cfg
void compass3_default_cfg(compass3_t *ctx)
Click Default Configuration function.
compass3_cfg_setup
void compass3_cfg_setup(compass3_cfg_t *cfg)
Config Object Initialization function.
compass3_t
Click ctx object definition.
Definition: compass3.h:196
compass3_cfg_t::int_pin
pin_name_t int_pin
Definition: compass3.h:223
COMPASS3_RETVAL
#define COMPASS3_RETVAL
Definition: compass3.h:62
compass3_generic_write
void compass3_generic_write(compass3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
compass3_generic_read
void compass3_generic_read(compass3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
compass3_t::i2c
i2c_master_t i2c
Definition: compass3.h:203
compass3_cfg_t::scl
pin_name_t scl
Definition: compass3.h:218
compass3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: compass3.h:227
compass3_check_int
uint8_t compass3_check_int(compass3_t *ctx)
Check interrupt function.