compass7  2.0.0.0
compass7.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 COMPASS7_H
29 #define COMPASS7_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_i2c_master.h"
38 
59 #define COMPASS7_REG_XOUT0 0x00
60 #define COMPASS7_REG_XOUT1 0x01
61 #define COMPASS7_REG_YOUT0 0x02
62 #define COMPASS7_REG_YOUT1 0x03
63 #define COMPASS7_REG_ZOUT0 0x04
64 #define COMPASS7_REG_ZOUT1 0x05
65 #define COMPASS7_REG_XOUT2 0x06
66 #define COMPASS7_REG_YOUT2 0x07
67 #define COMPASS7_REG_ZOUT2 0x08
68 #define COMPASS7_REG_TOUT 0x09
69 #define COMPASS7_REG_TPH0 0x0A
70 #define COMPASS7_REG_TPH1 0x0B
71 #define COMPASS7_REG_TU 0x0C
72 #define COMPASS7_REG_STATUS1 0x18
73 #define COMPASS7_REG_STATUS0 0x19
74 #define COMPASS7_REG_ODR 0x1A
75 #define COMPASS7_REG_CONTROL0 0x1B
76 #define COMPASS7_REG_CONTROL1 0x1C
77 #define COMPASS7_REG_CONTROL2 0x1D
78 #define COMPASS7_REG_ST_X_TH 0x1E
79 #define COMPASS7_REG_ST_Y_TH 0x1F
80 #define COMPASS7_REG_ST_Z_TH 0x20
81 #define COMPASS7_REG_ST_X 0x27
82 #define COMPASS7_REG_ST_Y 0x28
83 #define COMPASS7_REG_ST_Z 0x29
84 #define COMPASS7_REG_PRODUCT_ID 0x39
85  // compass7_reg
87 
102 #define COMPASS7_STATUS1_MEAS_T_DONE 0x80
103 #define COMPASS7_STATUS1_MEAS_M_DONE 0x40
104 #define COMPASS7_STATUS1_SAT_SENSOR 0x20
105 #define COMPASS7_STATUS1_OTP_READ_DONE 0x10
106 #define COMPASS7_STATUS1_ST_FAIL 0x08
107 #define COMPASS7_STATUS1_MDT_FLAG_INT 0x04
108 #define COMPASS7_STATUS1_MEAS_T_DONE_INT 0x02
109 #define COMPASS7_STATUS1_MEAS_M_DONE_INT 0x01
110 
115 #define COMPASS7_CONTROL0_CMM_FREQ_EN 0x80
116 #define COMPASS7_CONTROL0_AUTO_ST_EN 0x40
117 #define COMPASS7_CONTROL0_AUTO_SR_EN 0x20
118 #define COMPASS7_CONTROL0_DO_RESET 0x10
119 #define COMPASS7_CONTROL0_DO_SET 0x08
120 #define COMPASS7_CONTROL0_START_MDT 0x04
121 #define COMPASS7_CONTROL0_TAKE_MEAS_T 0x02
122 #define COMPASS7_CONTROL0_TAKE_MEAS_M 0x01
123 
128 #define COMPASS7_CONTROL1_SW_RESET 0x80
129 #define COMPASS7_CONTROL1_ST_ENM 0x40
130 #define COMPASS7_CONTROL1_ST_ENP 0x20
131 #define COMPASS7_CONTROL1_Z_INHIBIT 0x10
132 #define COMPASS7_CONTROL1_Y_INHIBIT 0x08
133 #define COMPASS7_CONTROL1_X_INHIBIT 0x04
134 #define COMPASS7_CONTROL1_BW_6p6MS 0x00
135 #define COMPASS7_CONTROL1_BW_3p5MS 0x01
136 #define COMPASS7_CONTROL1_BW_2p0MS 0x02
137 #define COMPASS7_CONTROL1_BW_1p2MS 0x03
138 #define COMPASS7_CONTROL1_BW_BIT_MASK 0x03
139 
144 #define COMPASS7_CONTROL2_HPOWER 0x80
145 #define COMPASS7_CONTROL2_INT_MEAS_DONE_EN 0x40
146 #define COMPASS7_CONTROL2_INT_MDT_EN 0x20
147 #define COMPASS7_CONTROL2_CMM_EN 0x10
148 #define COMPASS7_CONTROL2_EN_PRD_SET 0x08
149 #define COMPASS7_CONTROL2_PRD_SET_1_SMPL 0x00
150 #define COMPASS7_CONTROL2_PRD_SET_25_SMPL 0x01
151 #define COMPASS7_CONTROL2_PRD_SET_75_SMPL 0x02
152 #define COMPASS7_CONTROL2_PRD_SET_100_SMPL 0x03
153 #define COMPASS7_CONTROL2_PRD_SET_250_SMPL 0x04
154 #define COMPASS7_CONTROL2_PRD_SET_500_SMPL 0x05
155 #define COMPASS7_CONTROL2_PRD_SET_1000_SMPL 0x06
156 #define COMPASS7_CONTROL2_PRD_SET_2000_SMPL 0x07
157 #define COMPASS7_CONTROL2_PRD_SET_BIT_MASK 0x07
158 
163 #define COMPASS7_ODR_DISABLE 0
164 #define COMPASS7_ODR_1HZ 1
165 #define COMPASS7_ODR_2HZ 2
166 #define COMPASS7_ODR_5HZ 5
167 #define COMPASS7_ODR_10HZ 10
168 #define COMPASS7_ODR_25HZ 25
169 #define COMPASS7_ODR_50HZ 50
170 #define COMPASS7_ODR_100HZ 100
171 
176 #define COMPASS7_MAGNETIC_OFFSET 0x080000l
177 #define COMPASS7_MAGNETIC_RESOLUTION 0.0625
178 #define COMPASS7_MILLIGAUSS_TO_GAUSS 0.001
179 #define COMPASS7_TEMPERATURE_OFFSET 75
180 #define COMPASS7_TEMPERATURE_RESOLUTION 0.8
181 #define COMPASS7_TIMEOUT 2000
182 
187 #define COMPASS7_MEAS_SINGLE_T 0
188 #define COMPASS7_MEAS_SINGLE_M 1
189 #define COMPASS7_MEAS_CONTINUOUS_M_1HZ 2
190 #define COMPASS7_MEAS_CONTINUOUS_M_2HZ 3
191 #define COMPASS7_MEAS_CONTINUOUS_M_5HZ 4
192 #define COMPASS7_MEAS_CONTINUOUS_M_10HZ 5
193 #define COMPASS7_MEAS_CONTINUOUS_M_25HZ 6
194 #define COMPASS7_MEAS_CONTINUOUS_M_50HZ 7
195 #define COMPASS7_MEAS_CONTINUOUS_M_100HZ 8
196 
201 #define COMPASS7_PRODUCT_ID 0x10
202 
208 #define COMPASS7_DEVICE_ADDRESS 0x30
209  // compass7_set
211 
226 #define COMPASS7_MAP_MIKROBUS( cfg, mikrobus ) \
227  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
228  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
229  // compass7_map // compass7
232 
237 typedef struct
238 {
239  // Modules
240  i2c_master_t i2c;
242  // I2C slave address
243  uint8_t slave_address;
245 } compass7_t;
246 
251 typedef struct
252 {
253  pin_name_t scl;
254  pin_name_t sda;
256  uint32_t i2c_speed;
257  uint8_t i2c_address;
260 
265 typedef struct
266 {
267  float x_axis;
268  float y_axis;
269  float z_axis;
270 
272 
277 typedef enum
278 {
280  COMPASS7_ERROR = -1
281 
283 
300 
315 
329 
344 err_t compass7_generic_write ( compass7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
345 
360 err_t compass7_generic_read ( compass7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
361 
374 err_t compass7_write_register ( compass7_t *ctx, uint8_t reg, uint8_t data_in );
375 
388 err_t compass7_read_register ( compass7_t *ctx, uint8_t reg, uint8_t *data_out );
389 
401 
413 
433 err_t compass7_set_measurement_mode ( compass7_t *ctx, uint8_t mode );
434 
449 
461 err_t compass7_get_temperature ( compass7_t *ctx, float *temperature );
462 
463 #ifdef __cplusplus
464 }
465 #endif
466 #endif // COMPASS7_H
467  // compass7
469 
470 // ------------------------------------------------------------------------ END
compass7_magnetic_flux_t::x_axis
float x_axis
Definition: compass7.h:267
compass7_generic_read
err_t compass7_generic_read(compass7_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Compass 7 I2C reading function.
compass7_cfg_t
Compass 7 Click configuration object.
Definition: compass7.h:252
compass7_default_cfg
err_t compass7_default_cfg(compass7_t *ctx)
Compass 7 default configuration function.
compass7_cfg_t::sda
pin_name_t sda
Definition: compass7.h:254
compass7_return_value_t
compass7_return_value_t
Compass 7 Click return value data.
Definition: compass7.h:278
compass7_get_temperature
err_t compass7_get_temperature(compass7_t *ctx, float *temperature)
Compass 7 get temperature function.
compass7_check_communication
err_t compass7_check_communication(compass7_t *ctx)
Compass 7 check communication function.
compass7_t::i2c
i2c_master_t i2c
Definition: compass7.h:240
COMPASS7_OK
@ COMPASS7_OK
Definition: compass7.h:279
compass7_write_register
err_t compass7_write_register(compass7_t *ctx, uint8_t reg, uint8_t data_in)
Compass 7 write register function.
compass7_magnetic_flux_t::z_axis
float z_axis
Definition: compass7.h:269
compass7_soft_reset
err_t compass7_soft_reset(compass7_t *ctx)
Compass 7 soft reset function.
compass7_init
err_t compass7_init(compass7_t *ctx, compass7_cfg_t *cfg)
Compass 7 initialization function.
compass7_generic_write
err_t compass7_generic_write(compass7_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Compass 7 I2C writing function.
compass7_get_magnetic_flux
err_t compass7_get_magnetic_flux(compass7_t *ctx, compass7_magnetic_flux_t *flux)
Compass 7 get magnetic flux function.
compass7_cfg_setup
void compass7_cfg_setup(compass7_cfg_t *cfg)
Compass 7 configuration object setup function.
compass7_magnetic_flux_t::y_axis
float y_axis
Definition: compass7.h:268
compass7_read_register
err_t compass7_read_register(compass7_t *ctx, uint8_t reg, uint8_t *data_out)
Compass 7 read register function.
compass7_t::slave_address
uint8_t slave_address
Definition: compass7.h:243
compass7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: compass7.h:256
compass7_cfg_t::i2c_address
uint8_t i2c_address
Definition: compass7.h:257
compass7_magnetic_flux_t
Compass 7 magnetic flux data object.
Definition: compass7.h:266
compass7_t
Compass 7 Click context object.
Definition: compass7.h:238
compass7_set_measurement_mode
err_t compass7_set_measurement_mode(compass7_t *ctx, uint8_t mode)
Compass 7 set measurement mode function.
COMPASS7_ERROR
@ COMPASS7_ERROR
Definition: compass7.h:280
compass7_cfg_t::scl
pin_name_t scl
Definition: compass7.h:253