magneto7  2.0.0.0
magneto7.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 MAGNETO7_H
36 #define MAGNETO7_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_in.h"
49 #include "drv_i2c_master.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define MAGNETO7_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
63  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
64  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
65 
71 #define MAGNETO7_RETVAL uint8_t
72 
73 #define MAGNETO7_OK 0x00
74 #define MAGNETO7_INIT_ERROR 0xFF
75 
81 #define MAGNETO7_DEV_ADDR_L 0x0E
82 #define MAGNETO7_DEV_ADDR_H 0x0F
83 
89 #define MAGNETO7_INFO_L 0x0D
90 #define MAGNETO7_INFO_H 0x0E
91 #define MAGNETO7_WIA 0x0F
92 #define MAGNETO7_DATA_X_L 0x10
93 #define MAGNETO7_DATA_X_H 0x11
94 #define MAGNETO7_DATA_Y_L 0x12
95 #define MAGNETO7_DATA_Y_H 0x13
96 #define MAGNETO7_DATA_Z_L 0x14
97 #define MAGNETO7_DATA_Z_H 0x15
98 #define MAGNETO7_STA1 0x18
99 #define MAGNETO7_CNTL_1 0x1B
100 #define MAGNETO7_CNTL_2 0x1C
101 #define MAGNETO7_CNTL_3 0x1D
102 #define MAGNETO7_AVE_A 0x40
103 #define MAGNETO7_CNTL_4_L 0x5C
104 #define MAGNETO7_CNTL_4_H 0x5D
105 #define MAGNETO7_TEMP_L 0x60
106 #define MAGNETO7_TEMP_H 0x61
107 #define MAGNETO7_OFF_X_L 0x6C
108 #define MAGNETO7_OFF_X_H 0x6D
109 #define MAGNETO7_OFF_Y_L 0x72
110 #define MAGNETO7_OFF_Y_H 0x73
111 #define MAGNETO7_OFF_Z_L 0x78
112 #define MAGNETO7_OFF_Z_H 0x79
113 #define MAGNETO7_FINEOUTPUTX_L 0x90
114 #define MAGNETO7_FINEOUTPUTX_H 0x91
115 #define MAGNETO7_FINEOUTPUTY_L 0x92
116 #define MAGNETO7_FINEOUTPUTY_H 0x93
117 #define MAGNETO7_FINEOUTPUTZ_L 0x94
118 #define MAGNETO7_FINEOUTPUTZ_H 0x95
119 #define MAGNETO7_GAIN_PARA_X_L 0x9C
120 #define MAGNETO7_GAIN_PARA_X_H 0x9D
121 #define MAGNETO7_GAIN_PARA_Y_L 0x9E
122 #define MAGNETO7_GAIN_PARA_Y_H 0x9F
123 #define MAGNETO7_GAIN_PARA_Z_L 0xA0
124 #define MAGNETO7_GAIN_PARA_Z_H 0xA1
125 
131 #define MAGNETO7_X_AXIS 0x00
132 #define MAGNETO7_Y_AXIS 0x01
133 #define MAGNETO7_Z_AXIS 0x02
134 
140 #define MAGNETO7_SENSOR_RES_12_BIT 0x00
141 #define MAGNETO7_SENSOR_RES_14_BIT 0x01
142  // End group macro
145 // --------------------------------------------------------------- PUBLIC TYPES
154 typedef struct
155 {
156  // Input pins
157 
158  digital_in_t int_pin;
159 
160  // Modules
161 
162  i2c_master_t i2c;
163 
164  // ctx variable
165 
166  uint8_t slave_address;
167 
168  float sensor_res;
169 
170 } magneto7_t;
171 
175 typedef struct
176 {
177  // Communication gpio pins
178 
179  pin_name_t scl;
180  pin_name_t sda;
181 
182  // Additional gpio pins
183 
184  pin_name_t int_pin;
185 
186  // static variable
187 
188  uint32_t i2c_speed;
189  uint8_t i2c_address;
190 
192  // End types group
194 
195 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
196 
202 #ifdef __cplusplus
203 extern "C"{
204 #endif
205 
215 
224 
233 
244 void magneto7_generic_write ( magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
245 
256 void magneto7_generic_read ( magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
257 
265 uint8_t magneto7_int_get ( magneto7_t *ctx );
266 
277 uint8_t magneto7_get_register ( magneto7_t *ctx, uint8_t register_address, uint8_t * data_buffer, uint8_t n_data );
278 
289 uint8_t magneto7_set_register ( magneto7_t *ctx, uint8_t register_address, uint8_t *data_buffer, uint8_t n_data );
290 
300 uint8_t magneto7_set_offset ( magneto7_t *ctx, uint8_t offset_axis, uint8_t offset_value );
301 
310 void magneto7_get_temperature ( magneto7_t *ctx, uint16_t *device_temperature );
311 
322 void magneto7_get_data ( magneto7_t *ctx, int16_t *x_axis, int16_t *y_axis, int16_t *z_axis );
323 
334 void magneto7_get_fine_data ( magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis );
335 
345 float magneto7_convert_to_ut ( magneto7_t *ctx, int16_t raw_data, uint8_t sensor_resolution );
346 
357 void magneto7_get_gain_para ( magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis );
358 
359 #ifdef __cplusplus
360 }
361 #endif
362 #endif // _MAGNETO7_H_
363  // End public_function group
366 
367 // ------------------------------------------------------------------------- END
magneto7_get_fine_data
void magneto7_get_fine_data(magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis)
Getting fine data function.
magneto7_convert_to_ut
float magneto7_convert_to_ut(magneto7_t *ctx, int16_t raw_data, uint8_t sensor_resolution)
Getting fine data function.
magneto7_set_register
uint8_t magneto7_set_register(magneto7_t *ctx, uint8_t register_address, uint8_t *data_buffer, uint8_t n_data)
Setting register value(s) function.
magneto7_t::slave_address
uint8_t slave_address
Definition: magneto7.h:166
magneto7_init
MAGNETO7_RETVAL magneto7_init(magneto7_t *ctx, magneto7_cfg_t *cfg)
Initialization function.
magneto7_get_register
uint8_t magneto7_get_register(magneto7_t *ctx, uint8_t register_address, uint8_t *data_buffer, uint8_t n_data)
Getting register value(s) function.
magneto7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: magneto7.h:188
magneto7_get_gain_para
void magneto7_get_gain_para(magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis)
Getting gain data function.
magneto7_t::i2c
i2c_master_t i2c
Definition: magneto7.h:162
magneto7_cfg_t::int_pin
pin_name_t int_pin
Definition: magneto7.h:184
magneto7_cfg_t::scl
pin_name_t scl
Definition: magneto7.h:179
MAGNETO7_RETVAL
#define MAGNETO7_RETVAL
Definition: magneto7.h:71
magneto7_t::sensor_res
float sensor_res
Definition: magneto7.h:168
magneto7_default_cfg
uint8_t magneto7_default_cfg(magneto7_t *ctx)
Click Default Configuration function.
magneto7_generic_write
void magneto7_generic_write(magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
magneto7_cfg_setup
void magneto7_cfg_setup(magneto7_cfg_t *cfg)
Config Object Initialization function.
magneto7_get_temperature
void magneto7_get_temperature(magneto7_t *ctx, uint16_t *device_temperature)
Getting raw device temperature value function.
magneto7_t::int_pin
digital_in_t int_pin
Definition: magneto7.h:158
magneto7_cfg_t
Click configuration structure definition.
Definition: magneto7.h:176
magneto7_set_offset
uint8_t magneto7_set_offset(magneto7_t *ctx, uint8_t offset_axis, uint8_t offset_value)
Setting offset values function.
magneto7_generic_read
void magneto7_generic_read(magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
magneto7_get_data
void magneto7_get_data(magneto7_t *ctx, int16_t *x_axis, int16_t *y_axis, int16_t *z_axis)
Getting data function.
magneto7_int_get
uint8_t magneto7_int_get(magneto7_t *ctx)
Getting INT pin state function.
magneto7_cfg_t::i2c_address
uint8_t i2c_address
Definition: magneto7.h:189
magneto7_t
Click ctx object definition.
Definition: magneto7.h:155
magneto7_cfg_t::sda
pin_name_t sda
Definition: magneto7.h:180