magneto5  2.0.0.0
magneto5.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 MAGNETO5_H
36 #define MAGNETO5_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_out.h"
53 #include "drv_i2c_master.h"
54 
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define MAGNETO5_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69 
75 #define MAGNETO5_RETVAL uint8_t
76 
77 #define MAGNETO5_OK 0x00
78 #define MAGNETO5_INIT_ERROR 0xFF
79 
85 #define MAGNETO5_REG_X_OUT_LOW 0x00
86 #define MAGNETO5_REG_X_OUT_HIGH 0x01
87 #define MAGNETO5_REG_Y_OUT_LOW 0x02
88 #define MAGNETO5_REG_Y_OUT_HIGH 0x03
89 #define MAGNETO5_REG_Z_OUT_LOW 0x04
90 #define MAGNETO5_REG_Z_OUT_HIGH 0x05
91 #define MAGNETO5_REG_STATUS 0x06
92 #define MAGNETO5_REG_INTERNAL_CONTROL_0 0x07
93 #define MAGNETO5_REG_INTERNAL_CONTROL_1 0x08
94 #define MAGNETO5_REG_PRODUCT_ID 0x20
95 
101 #define MAGNETO_STATUS_MEASUREMENT_DONE 0x01
102 #define MAGNETO_STATUS_PUMP_ON 0x02
103 #define MAGNETO_STATUS_READ_DONE 0x04
104 #define MAGNETO_STATUS_SELFTEST_OK 0x08
105 #define MAGNETO5_ERROR 0x00
106 #define MAGNETO5_PRODUCT_ID 0x06
107 
113 #define MAGNETO5_AXIS_X 0x00
114 #define MAGNETO5_AXIS_Y 0x02
115 #define MAGNETO5_AXIS_Z 0x04
116 
122 #define MAGNETO5_CR0_RESET 0x40
123 #define MAGNETO5_CR0_SET 0x20
124 #define MAGNETO5_CR0_REFILL_CAP 0x80
125 #define MAGNETO5_CR0_NO_BOOST 0x10
126 #define MAGNETO5_CR0_MEASUREMENT_MODE_0 0x00
127 #define MAGNETO5_CR0_MEASUREMENT_MODE_1 0x04
128 #define MAGNETO5_CR0_MEASUREMENT_MODE_2 0x08
129 #define MAGNETO5_CR0_MEASUREMENT_MODE_3 0x0C
130 #define MAGNETO5_CR0_CONTINUOUS_MODE 0x02
131 #define MAGNETO5_CR0_TAKE_MEASUREMENT 0x01
132 
138 #define MAGNETO5_CR1_SOFT_RESET 0x80
139 #define MAGNETO5_CR1_TEMP_TEST 0x40
140 #define MAGNETO5_CR1_SELFTEST_XYZ 0x20
141 #define MAGNETO5_CR1_FACTORY_USE_X 0x10
142 #define MAGNETO5_CR1_FACTORY_USE_Y 0x08
143 #define MAGNETO5_CR1_FACTORY_USE_Z 0x04
144 #define MAGNETO5_CH0_16bits_8ms 0x00
145 #define MAGNETO5_CH1_16bits_4ms 0x01
146 #define MAGNETO5_CH2_14bits_2ms 0x02
147 #define MAGNETO5_CH3_12bits_1ms 0x03
148  // End group macro
151 // --------------------------------------------------------------- PUBLIC TYPES
160 typedef struct
161 {
162 
163  // Modules
164 
165  i2c_master_t i2c;
166 
167  // ctx variable
168 
169  uint8_t slave_address;
170 
172  uint8_t data_flag;
173 
174 } magneto5_t;
175 
179 typedef struct
180 {
181  // Communication gpio pins
182 
183  pin_name_t scl;
184  pin_name_t sda;
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 magneto5_generic_write ( magneto5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
245 
257 void magneto5_generic_read ( magneto5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
258 
268 
278 
289 void magneto5_get_axis_data ( magneto5_t *ctx, int16_t *axis_buffer, uint8_t max_resolution );
290 
301 float magneto5_get_axis_value ( magneto5_t *ctx, uint8_t axis, uint8_t max_resolution );
302 
318 void magneto5_config_register_0 ( magneto5_t *ctx, uint8_t config_data );
319 
333 void magneto5_config_register_1 ( magneto5_t *ctx, uint8_t config_data );
334 
344 
345 #ifdef __cplusplus
346 }
347 #endif
348 #endif // _MAGNETO5_H_
349  // End public_function group
352 
353 // ------------------------------------------------------------------------- END
magneto5_t::slave_address
uint8_t slave_address
Definition: magneto5.h:169
magneto5_t
Click ctx object definition.
Definition: magneto5.h:161
magneto5_get_product_id
uint8_t magneto5_get_product_id(magneto5_t *ctx)
Functions reads product ID from register.
magneto5_config_register_1
void magneto5_config_register_1(magneto5_t *ctx, uint8_t config_data)
Functions sets configuration register 1.
magneto5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: magneto5.h:188
magneto5_cfg_t::sda
pin_name_t sda
Definition: magneto5.h:184
magneto5_t::i2c
i2c_master_t i2c
Definition: magneto5.h:165
magneto5_get_axis_data
void magneto5_get_axis_data(magneto5_t *ctx, int16_t *axis_buffer, uint8_t max_resolution)
Functions reads axis data.
magneto5_set_status_reg
uint8_t magneto5_set_status_reg(magneto5_t *ctx)
Functions reads status register.
magneto5_reset
void magneto5_reset(magneto5_t *ctx)
Functions for reset data.
magneto5_generic_read
void magneto5_generic_read(magneto5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
magneto5_cfg_t::scl
pin_name_t scl
Definition: magneto5.h:183
magneto5_default_cfg
void magneto5_default_cfg(magneto5_t *ctx)
Click Default Configuration function.
magneto5_cfg_t::i2c_address
uint8_t i2c_address
Definition: magneto5.h:189
magneto5_cfg_t
Click configuration structure definition.
Definition: magneto5.h:180
magneto5_t::max_resolution
float max_resolution
Definition: magneto5.h:171
magneto5_generic_write
void magneto5_generic_write(magneto5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
magneto5_cfg_setup
void magneto5_cfg_setup(magneto5_cfg_t *cfg)
Config Object Initialization function.
MAGNETO5_RETVAL
#define MAGNETO5_RETVAL
Definition: magneto5.h:75
magneto5_t::data_flag
uint8_t data_flag
Definition: magneto5.h:172
magneto5_init
MAGNETO5_RETVAL magneto5_init(magneto5_t *ctx, magneto5_cfg_t *cfg)
Initialization function.
magneto5_config_register_0
void magneto5_config_register_0(magneto5_t *ctx, uint8_t config_data)
Functions sets configuration register 0.
magneto5_get_axis_value
float magneto5_get_axis_value(magneto5_t *ctx, uint8_t axis, uint8_t max_resolution)
Functions reads axis data value.