c3dhall2  2.0.0.0
c3dhall2.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 C3DHALL2_H
36 #define C3DHALL2_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_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define C3DHALL2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
65 
72 #define C3DHALL2_DEVICE_ADDRESS 0x5E
73 
78 #define C3DHALL2_M1_I2C_SLAVE_ADDRESS_0 0x00
79 #define C3DHALL2_M1_I2C_SLAVE_ADDRESS_1 0x20
80 #define C3DHALL2_M1_I2C_SLAVE_ADDRESS_2 0x40
81 #define C3DHALL2_M1_I2C_SLAVE_ADDRESS_3 0x60
82 #define C3DHALL2_M1_INTERRUPT_ENABLE 0x04
83 #define C3DHALL2_M1_INTERRUPT_DISABLE 0x00
84 #define C3DHALL2_M1_FAST_MODE_ENABLE 0x02
85 #define C3DHALL2_M1_FAST_MODE_DISABLE 0x00
86 #define C3DHALL2_M1_LOW_POWER_MODE_ENABLE 0x01
87 #define C3DHALL2_M1_LOW_POWER_MODE_DISABLE 0x00
88 
94 #define C3DHALL2_M2_TEMPERATURE_ENABLE 0x00
95 #define C3DHALL2_M2_TEMPERATURE_DISABLE 0x80
96 #define C3DHALL2_M2_LOW_POWER_PERIOD_100MS 0x00
97 #define C3DHALL2_M2_LOW_POWER_PERIOD_12MS 0x40
98 #define C3DHALL2_M2_PARITY_TEST_ENABLE 0x00
99 #define C3DHALL2_M2_PARITY_TEST_DISABLE 0x20
100  // End group macro
103 // --------------------------------------------------------------- PUBLIC TYPES
112 typedef struct
113 {
114 
115  // Modules
116 
117  i2c_master_t i2c;
118 
119  // ctx variable
120 
121  uint8_t slave_address;
122 
123 } c3dhall2_t;
124 
128 typedef struct
129 {
130  // Communication gpio pins
131 
132  pin_name_t scl;
133  pin_name_t sda;
134 
135  // static variable
136 
137  uint32_t i2c_speed;
138  uint8_t i2c_address;
139 
141 
146 typedef enum
147 {
149  C3DHALL2_ERROR = -1
150 
152  // End types group
154 
155 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
156 
162 #ifdef __cplusplus
163 extern "C"{
164 #endif
165 
175 
185 
195 
205 err_t c3dhall2_write_data ( c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len );
206 
216 err_t c3dhall2_read_data ( c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len );
217 
227 err_t c3dhall2_get_axis_temp_data ( c3dhall2_t *ctx, float *axis_data, float *temp_data );
228 
251 err_t c3dhall2_configuration ( c3dhall2_t *ctx, uint8_t settings1, uint8_t settings2 );
252 
253 
254 #ifdef __cplusplus
255 }
256 #endif
257 #endif // _C3DHALL2_H_
258  // End public_function group
261 
262 // ------------------------------------------------------------------------- END
c3dhall2_t::i2c
i2c_master_t i2c
Definition: c3dhall2.h:117
c3dhall2_get_axis_temp_data
err_t c3dhall2_get_axis_temp_data(c3dhall2_t *ctx, float *axis_data, float *temp_data)
Functions for getting Hall axis data and Temperature data.
c3dhall2_write_data
err_t c3dhall2_write_data(c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len)
Generic write function.
c3dhall2_default_cfg
err_t c3dhall2_default_cfg(c3dhall2_t *ctx)
Default configuration initialization function.
c3dhall2_configuration
err_t c3dhall2_configuration(c3dhall2_t *ctx, uint8_t settings1, uint8_t settings2)
Functions for settings chip for measurement.
c3dhall2_cfg_t::i2c_address
uint8_t i2c_address
Definition: c3dhall2.h:138
c3dhall2_t
Click ctx object definition.
Definition: c3dhall2.h:113
c3dhall2_cfg_t::sda
pin_name_t sda
Definition: c3dhall2.h:133
c3dhall2_cfg_setup
void c3dhall2_cfg_setup(c3dhall2_cfg_t *cfg)
Config Object Initialization function.
C3DHALL2_OK
@ C3DHALL2_OK
Definition: c3dhall2.h:148
C3DHALL2_ERROR
@ C3DHALL2_ERROR
Definition: c3dhall2.h:149
c3dhall2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: c3dhall2.h:137
c3dhall2_read_data
err_t c3dhall2_read_data(c3dhall2_t *ctx, uint8_t *data_buf, uint16_t len)
Generic read function.
c3dhall2_init
err_t c3dhall2_init(c3dhall2_t *ctx, c3dhall2_cfg_t *cfg)
Initialization function.
c3dhall2_cfg_t
Click configuration structure definition.
Definition: c3dhall2.h:129
c3dhall2_t::slave_address
uint8_t slave_address
Definition: c3dhall2.h:121
c3dhall2_return_value_t
c3dhall2_return_value_t
3D Hall 2 Click return value data.
Definition: c3dhall2.h:147
c3dhall2_cfg_t::scl
pin_name_t scl
Definition: c3dhall2.h:132