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 "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define MAGNETO7_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
55 
61 #define MAGNETO7_RETVAL uint8_t
62 
63 #define MAGNETO7_OK 0x00
64 #define MAGNETO7_INIT_ERROR 0xFF
65 
71 #define MAGNETO7_DEV_ADDR_L 0x0E
72 #define MAGNETO7_DEV_ADDR_H 0x0F
73 
79 #define MAGNETO7_INFO_L 0x0D
80 #define MAGNETO7_INFO_H 0x0E
81 #define MAGNETO7_WIA 0x0F
82 #define MAGNETO7_DATA_X_L 0x10
83 #define MAGNETO7_DATA_X_H 0x11
84 #define MAGNETO7_DATA_Y_L 0x12
85 #define MAGNETO7_DATA_Y_H 0x13
86 #define MAGNETO7_DATA_Z_L 0x14
87 #define MAGNETO7_DATA_Z_H 0x15
88 #define MAGNETO7_STA1 0x18
89 #define MAGNETO7_CNTL_1 0x1B
90 #define MAGNETO7_CNTL_2 0x1C
91 #define MAGNETO7_CNTL_3 0x1D
92 #define MAGNETO7_AVE_A 0x40
93 #define MAGNETO7_CNTL_4_L 0x5C
94 #define MAGNETO7_CNTL_4_H 0x5D
95 #define MAGNETO7_TEMP_L 0x60
96 #define MAGNETO7_TEMP_H 0x61
97 #define MAGNETO7_OFF_X_L 0x6C
98 #define MAGNETO7_OFF_X_H 0x6D
99 #define MAGNETO7_OFF_Y_L 0x72
100 #define MAGNETO7_OFF_Y_H 0x73
101 #define MAGNETO7_OFF_Z_L 0x78
102 #define MAGNETO7_OFF_Z_H 0x79
103 #define MAGNETO7_FINEOUTPUTX_L 0x90
104 #define MAGNETO7_FINEOUTPUTX_H 0x91
105 #define MAGNETO7_FINEOUTPUTY_L 0x92
106 #define MAGNETO7_FINEOUTPUTY_H 0x93
107 #define MAGNETO7_FINEOUTPUTZ_L 0x94
108 #define MAGNETO7_FINEOUTPUTZ_H 0x95
109 #define MAGNETO7_GAIN_PARA_X_L 0x9C
110 #define MAGNETO7_GAIN_PARA_X_H 0x9D
111 #define MAGNETO7_GAIN_PARA_Y_L 0x9E
112 #define MAGNETO7_GAIN_PARA_Y_H 0x9F
113 #define MAGNETO7_GAIN_PARA_Z_L 0xA0
114 #define MAGNETO7_GAIN_PARA_Z_H 0xA1
115 
121 #define MAGNETO7_X_AXIS 0x00
122 #define MAGNETO7_Y_AXIS 0x01
123 #define MAGNETO7_Z_AXIS 0x02
124 
130 #define MAGNETO7_SENSOR_RES_12_BIT 0x00
131 #define MAGNETO7_SENSOR_RES_14_BIT 0x01
132  // End group macro
135 // --------------------------------------------------------------- PUBLIC TYPES
144 typedef struct
145 {
146  // Input pins
147 
148  digital_in_t int_pin;
149 
150  // Modules
151 
152  i2c_master_t i2c;
153 
154  // ctx variable
155 
156  uint8_t slave_address;
157 
158  float sensor_res;
159 
160 } magneto7_t;
161 
165 typedef struct
166 {
167  // Communication gpio pins
168 
169  pin_name_t scl;
170  pin_name_t sda;
171 
172  // Additional gpio pins
173 
174  pin_name_t int_pin;
175 
176  // static variable
177 
178  uint32_t i2c_speed;
179  uint8_t i2c_address;
180 
182  // End types group
184 
185 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
186 
192 #ifdef __cplusplus
193 extern "C"{
194 #endif
195 
205 
214 
223 
234 void magneto7_generic_write ( magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
235 
246 void magneto7_generic_read ( magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
247 
255 uint8_t magneto7_int_get ( magneto7_t *ctx );
256 
267 uint8_t magneto7_get_register ( magneto7_t *ctx, uint8_t register_address, uint8_t * data_buffer, uint8_t n_data );
268 
279 uint8_t magneto7_set_register ( magneto7_t *ctx, uint8_t register_address, uint8_t *data_buffer, uint8_t n_data );
280 
290 uint8_t magneto7_set_offset ( magneto7_t *ctx, uint8_t offset_axis, uint8_t offset_value );
291 
300 void magneto7_get_temperature ( magneto7_t *ctx, uint16_t *device_temperature );
301 
312 void magneto7_get_data ( magneto7_t *ctx, int16_t *x_axis, int16_t *y_axis, int16_t *z_axis );
313 
324 void magneto7_get_fine_data ( magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis );
325 
335 float magneto7_convert_to_ut ( magneto7_t *ctx, int16_t raw_data, uint8_t sensor_resolution );
336 
347 void magneto7_get_gain_para ( magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis );
348 
349 #ifdef __cplusplus
350 }
351 #endif
352 #endif // _MAGNETO7_H_
353  // End public_function group
356 
357 // ------------------------------------------------------------------------- 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:156
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:178
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:152
magneto7_cfg_t::int_pin
pin_name_t int_pin
Definition: magneto7.h:174
magneto7_cfg_t::scl
pin_name_t scl
Definition: magneto7.h:169
MAGNETO7_RETVAL
#define MAGNETO7_RETVAL
Definition: magneto7.h:61
magneto7_t::sensor_res
float sensor_res
Definition: magneto7.h:158
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:148
magneto7_cfg_t
Click configuration structure definition.
Definition: magneto7.h:166
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:179
magneto7_t
Click ctx object definition.
Definition: magneto7.h:145
magneto7_cfg_t::sda
pin_name_t sda
Definition: magneto7.h:170