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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_in.h"
53 #include "drv_i2c_master.h"
54 
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define COMPASS3_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define COMPASS3_RETVAL uint8_t
77 
78 #define COMPASS3_OK 0x00
79 #define COMPASS3_INIT_ERROR 0xFF
80 
86 #define COMPASS3_SLAVE_ADR 0x30
87 
93 #define COMPASS3_XOUT_LSB 0x00
94 #define COMPASS3_XOUT_MSB 0x01
95 #define COMPASS3_YOUT_LSB 0x02
96 #define COMPASS3_YOUT_MSB 0x03
97 #define COMPASS3_ZOUT_LSB 0x04
98 #define COMPASS3_ZOUT_MSB 0x05
99 #define COMPASS3_TEMP 0x06
100 #define COMPASS3_STAT 0x07
101 #define COMPASS3_INTERNAL_CTRL_0 0x08
102 #define COMPASS3_INTERNAL_CTRL_1 0x09
103 #define COMPASS3_INTERNAL_CTRL_2 0x0A
104 #define COMPASS3_X_TRSH 0x0B
105 #define COMPASS3_Y_TRSH 0x0C
106 #define COMPASS3_Z_TRSH 0x0D
107 #define COMPASS3_DEVICE_ID 0x2F
108 
114 #define COMPASS3_MEAS_M_DONE 0x01
115 #define COMPASS3_MEAS_T_DONE 0x02
116 #define COMPASS3_MOTION_DCT 0x04
117 #define COMPASS3_PUMP_ON 0x08
118 #define COMPASS3_OTP_RD_DONE 0x10
119 
125 #define COMPASS3_TEST_PIN_SEL 0x80
126 #define COMPASS3_OTP_RD 0x40
127 #define COMPASS3_RSRVD 0x20
128 #define COMPASS3_RESET 0x10
129 #define COMPASS3_SET 0x08
130 #define COMPASS3_START_MD_T 0x04
131 #define COMPASS3_TM_T 0x02
132 #define COMPASS3_TM_M 0x01
133 
139 #define COMPASS3_SW_RST 0x80
140 #define COMPASS3_OTP_BL_SEL1 0x40
141 #define COMPASS3_OTP_BL_SEL0 0x20
142 #define COMPASS3_Z_INH 0x10
143 #define COMPASS3_Y_INH 0x08
144 #define COMPASS3_X_INH 0x04
145 #define COMPASS3_BW_ODR_600 0x03
146 #define COMPASS3_BW_ODR_400 0x02
147 #define COMPASS3_BW_ODR_200 0x01
148 #define COMPASS3_BW_ODR_100 0x00
149 
155 #define COMPASS3_ULP_SEL 0x80
156 #define COMPASS3_INT_MEAS_DONE_EN 0x40
157 #define COMPASS3_INT_MDT_EN 0x20
158 #define COMPASS3_Force_VDDL_STBY 0x10
159 #define COMPASS3_CM_FREQ_0_015625HZ 0x0A
160 #define COMPASS3_CM_FREQ_0_03125HZ 0x09
161 #define COMPASS3_CM_FREQ_0_0625HZ 0x08
162 #define COMPASS3_CM_FREQ_0_125HZ 0x07
163 #define COMPASS3_CM_FREQ_0_25HZ 0x06
164 #define COMPASS3_CM_FREQ_0_5HZ 0x05
165 #define COMPASS3_CM_FREQ_1HZ 0x04
166 #define COMPASS3_CM_FREQ_2_2HZ 0x03
167 #define COMPASS3_CM_FREQ_5HZ 0x02
168 #define COMPASS3_CM_FREQ_14HZ 0x01
169 #define COMPASS3_CM_FREQ_CONT 0x00
170 
176 #define COMPASS3_DYNAMIC_RANGE 16
177 #define COMPASS3_MAG_LSB_VALUE 0.25
178 #define COMPASS3_TEMP_LSB_VALUE 0.7
179 #define COMPASS3_MAG_RANGE_VALUE 8000
180 #define COMPASS3_TEMP_RANGE_VALUE 75
181 #define COMPASS3_RESOLUTION 65536
182 
188 #define COMPASS3_INTERRUPT 0x01
189 #define COMPASS3_NO_INTERRUPT 0x00
190 
196 #define COMPASS3_DEVICE_ID_NUM 0x0C
197  // End group macro
200 // --------------------------------------------------------------- PUBLIC TYPES
209 typedef struct
210 {
211  // Input pins
212 
213  digital_in_t int_pin;
214 
215  // Modules
216 
217  i2c_master_t i2c;
218 
219  // ctx variable
220 
221  uint8_t slave_address;
222 
223 } compass3_t;
224 
228 typedef struct
229 {
230  // Communication gpio pins
231 
232  pin_name_t scl;
233  pin_name_t sda;
234 
235  // Additional gpio pins
236 
237  pin_name_t int_pin;
238 
239  // static variable
240 
241  uint32_t i2c_speed;
242  uint8_t i2c_address;
243 
245  // End types group
247 // ------------------------------------------------------------------ CONSTANTS // End constants group
256 // ------------------------------------------------------------------ VARIABLES // End variable group
264 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
265 
271 #ifdef __cplusplus
272 extern "C"{
273 #endif
274 
285 
295 
304 
315 void compass3_generic_write ( compass3_t *ctx, uint8_t reg, uint8_t *data_buf,
316  uint8_t len );
317 
329 void compass3_generic_read ( compass3_t *ctx, uint8_t reg, uint8_t *data_buf,
330  uint8_t len );
331 
342 void compass3_full_measurement ( compass3_t *ctx, float *x_val, float *y_val,
343  float *z_val );
344 
355 
366 
367 #ifdef __cplusplus
368 }
369 #endif
370 #endif // _COMPASS3_H_
371  // End public_function group
374 
375 // ------------------------------------------------------------------------- END
compass3_t::int_pin
digital_in_t int_pin
Definition: compass3.h:213
compass3_cfg_t::sda
pin_name_t sda
Definition: compass3.h:233
compass3_cfg_t::i2c_address
uint8_t i2c_address
Definition: compass3.h:242
compass3_cfg_t
Click configuration structure definition.
Definition: compass3.h:229
compass3_t::slave_address
uint8_t slave_address
Definition: compass3.h:221
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:210
compass3_cfg_t::int_pin
pin_name_t int_pin
Definition: compass3.h:237
COMPASS3_RETVAL
#define COMPASS3_RETVAL
Definition: compass3.h:76
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:217
compass3_cfg_t::scl
pin_name_t scl
Definition: compass3.h:232
compass3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: compass3.h:241
compass3_check_int
uint8_t compass3_check_int(compass3_t *ctx)
Check interrupt function.