c3dhall9  2.0.0.0
c3dhall9.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 C3DHALL9_H
29 #define C3DHALL9_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 C3DHALL9_REG_EEPROM_02 0x02
60 #define C3DHALL9_REG_EEPROM_03 0x03
61 #define C3DHALL9_REG_EEPROM_0D 0x0D
62 #define C3DHALL9_REG_EEPROM_0E 0x0E
63 #define C3DHALL9_REG_EEPROM_0F 0x0F
64 #define C3DHALL9_REG_VOLATILE_27 0x27
65 #define C3DHALL9_REG_VOLATILE_28 0x28
66 #define C3DHALL9_REG_VOLATILE_29 0x29
67  // c3dhall9_reg
69 
84 #define C3DHALL9_EEPROM_02_ENABLE_Z 0x00000100ul
85 #define C3DHALL9_EEPROM_02_ENABLE_Y 0x00000080ul
86 #define C3DHALL9_EEPROM_02_ENABLE_X 0x00000040ul
87 #define C3DHALL9_VOLATILE_27_ACTIVE_MODE 0x00000000ul
88 #define C3DHALL9_VOLATILE_27_SLEEP_MODE 0x00000001ul
89 #define C3DHALL9_VOLATILE_27_LOW_POWER_MODE 0x00000002ul
90 #define C3DHALL9_VOLATILE_27_I2C_SINGLE 0x00000000ul
91 #define C3DHALL9_VOLATILE_27_I2C_FAST_LOOP 0x00000004ul
92 #define C3DHALL9_VOLATILE_27_I2C_FULL_LOOP 0x00000008ul
93 
98 #define C3DHALL9_12BIT_RESOLUTION 0x1000
99 #define C3DHALL9_SIGN_BIT 0x0800
100 #define C3DHALL9_DATA_READY_BIT 0x0080
101 #define C3DHALL9_GAUSS_RESOLUTION 4
102 #define C3DHALL9_TEMPERATURE_MULTIPLIER 302
103 #define C3DHALL9_TEMPERATURE_SUBTRACTOR 1702
104 #define C3DHALL9_TEMPERATURE_SUBTRACTOR 1702
105 #define C3DHALL9_HALF_CICRLE_DEGREES 180.0
106 
112 #define C3DHALL9_SET_DEV_ADDR 0x60
113  // c3dhall9_set
115 
130 #define C3DHALL9_MAP_MIKROBUS( cfg, mikrobus ) \
131  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
132  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
133  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
134  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
135  // c3dhall9_map // c3dhall9
138 
143 typedef struct
144 {
145  // Output pins
146  digital_out_t en;
148  // Input pins
149  digital_in_t int_pin;
151  // Modules
152  i2c_master_t i2c;
154  // I2C slave address
155  uint8_t slave_address;
157 } c3dhall9_t;
158 
163 typedef struct
164 {
165  pin_name_t scl;
166  pin_name_t sda;
168  pin_name_t en;
169  pin_name_t int_pin;
171  uint32_t i2c_speed;
172  uint8_t i2c_address;
175 
180 typedef enum
181 {
183  C3DHALL9_ERROR = -1
184 
186 
191 typedef struct
192 {
193  float x_axis;
194  float y_axis;
195  float z_axis;
196  float angle_xy;
197  float angle_xz;
198  float angle_yz;
199  float temperature;
200 
202 
219 
235 
250 
264 err_t c3dhall9_write_register ( c3dhall9_t *ctx, uint8_t reg, uint32_t data_in );
265 
279 err_t c3dhall9_read_register ( c3dhall9_t *ctx, uint8_t reg, uint32_t *data_out );
280 
290 
300 
310 
327 
328 #ifdef __cplusplus
329 }
330 #endif
331 #endif // C3DHALL9_H
332  // c3dhall9
334 
335 // ------------------------------------------------------------------------ END
c3dhall9_default_cfg
err_t c3dhall9_default_cfg(c3dhall9_t *ctx)
3D Hall 9 default configuration function.
c3dhall9_data_t::temperature
float temperature
Definition: c3dhall9.h:199
c3dhall9_enable_chip
void c3dhall9_enable_chip(c3dhall9_t *ctx)
3D Hall 9 enable chip function.
c3dhall9_get_int_pin
uint8_t c3dhall9_get_int_pin(c3dhall9_t *ctx)
3D Hall 9 get int pin function.
c3dhall9_data_t::x_axis
float x_axis
Definition: c3dhall9.h:193
C3DHALL9_OK
@ C3DHALL9_OK
Definition: c3dhall9.h:182
c3dhall9_t
3D Hall 9 Click context object.
Definition: c3dhall9.h:144
c3dhall9_write_register
err_t c3dhall9_write_register(c3dhall9_t *ctx, uint8_t reg, uint32_t data_in)
3D Hall 9 I2C writing function.
c3dhall9_data_t::z_axis
float z_axis
Definition: c3dhall9.h:195
c3dhall9_data_t::angle_xy
float angle_xy
Definition: c3dhall9.h:196
c3dhall9_return_value_t
c3dhall9_return_value_t
3D Hall 9 Click return value data.
Definition: c3dhall9.h:181
c3dhall9_data_t::angle_yz
float angle_yz
Definition: c3dhall9.h:198
c3dhall9_cfg_setup
void c3dhall9_cfg_setup(c3dhall9_cfg_t *cfg)
3D Hall 9 configuration object setup function.
c3dhall9_t::en
digital_out_t en
Definition: c3dhall9.h:146
c3dhall9_t::i2c
i2c_master_t i2c
Definition: c3dhall9.h:152
c3dhall9_t::int_pin
digital_in_t int_pin
Definition: c3dhall9.h:149
C3DHALL9_ERROR
@ C3DHALL9_ERROR
Definition: c3dhall9.h:183
c3dhall9_data_t::y_axis
float y_axis
Definition: c3dhall9.h:194
c3dhall9_t::slave_address
uint8_t slave_address
Definition: c3dhall9.h:155
c3dhall9_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: c3dhall9.h:171
c3dhall9_data_t::angle_xz
float angle_xz
Definition: c3dhall9.h:197
c3dhall9_cfg_t
3D Hall 9 Click configuration object.
Definition: c3dhall9.h:164
c3dhall9_data_t
3D Hall 9 Click data object.
Definition: c3dhall9.h:192
c3dhall9_init
err_t c3dhall9_init(c3dhall9_t *ctx, c3dhall9_cfg_t *cfg)
3D Hall 9 initialization function.
c3dhall9_cfg_t::int_pin
pin_name_t int_pin
Definition: c3dhall9.h:169
c3dhall9_read_data
err_t c3dhall9_read_data(c3dhall9_t *ctx, c3dhall9_data_t *data_out)
3D Hall 9 read data function.
c3dhall9_cfg_t::en
pin_name_t en
Definition: c3dhall9.h:168
c3dhall9_cfg_t::i2c_address
uint8_t i2c_address
Definition: c3dhall9.h:172
c3dhall9_disable_chip
void c3dhall9_disable_chip(c3dhall9_t *ctx)
3D Hall 9 disable chip function.
c3dhall9_cfg_t::sda
pin_name_t sda
Definition: c3dhall9.h:166
c3dhall9_cfg_t::scl
pin_name_t scl
Definition: c3dhall9.h:165
c3dhall9_read_register
err_t c3dhall9_read_register(c3dhall9_t *ctx, uint8_t reg, uint32_t *data_out)
3D Hall 9 I2C reading function.