c3dhall6  2.0.0.0
c3dhall6.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 C3DHALL6_H
36 #define C3DHALL6_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_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define C3DHALL6_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
68 
74 #define C3DHALL6_OK 0
75 #define C3DHALL6_ERROR -1
76 
82 #define C3DHALL6_CHANNEL_0 0x00
83 #define C3DHALL6_CHANNEL_1 0x40
84 #define C3DHALL6_CHANNEL_2 0x80
85 #define C3DHALL6_CHANNEL_3 0xC0
86 
92 #define C3DHALL6_DIE_A 0x01
93 #define C3DHALL6_DIE_B 0x02
94 
100 #define SINGLE_PI_CONST 3.14
101 #define HALF_PI_CONST 1.57
102  // End group macro
105 // --------------------------------------------------------------- PUBLIC TYPES
111 typedef struct
112 {
113  uint16_t aux_ch0;
114  uint16_t aux_ch1;
115  uint16_t aux_ch2;
116  uint16_t aux_ch3;
117 
119 
120 typedef struct
121 {
126 
128 
129 typedef struct
130 {
136 
138 
142 typedef struct
143 {
144  // Modules
145  spi_master_t spi;
146  pin_name_t chip_select;
147 
151 
152 } c3dhall6_t;
153 
157 typedef struct
158 {
159  // Communication gpio pins
160  pin_name_t miso;
161  pin_name_t mosi;
162  pin_name_t sck;
163  pin_name_t cs;
164 
165  // static variable
166  uint32_t spi_speed;
167  spi_master_mode_t spi_mode;
168  spi_master_chip_select_polarity_t cs_polarity;
169 
171 
173  // End types group
175 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
176 
181 #ifdef __cplusplus
182 extern "C"{
183 #endif
184 
194 
204 
213 
227 
237 void c3dhall6_get_adc_value ( c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value );
238 
248 void c3dhall6_get_volt( c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage );
249 
259 void c3dhall6_get_angle_deg ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
260 
270 void c3dhall6_get_angle_rad ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 #endif // _C3DHALL6_H_
276  // End public_function group
279 
280 // ------------------------------------------------------------------------- END
c3dhall6_aux_ch_t::aux_ch1
uint16_t aux_ch1
Definition: c3dhall6.h:114
c3dhall6_t
Click ctx object definition.
Definition: c3dhall6.h:143
c3dhall6_t::chip_select
pin_name_t chip_select
Definition: c3dhall6.h:146
c3dhall6_aux_ch_t::aux_ch0
uint16_t aux_ch0
Definition: c3dhall6.h:113
c3dhall6_cfg_setup
void c3dhall6_cfg_setup(c3dhall6_cfg_t *cfg)
Config Object Initialization function.
c3dhall6_t::device_aux_ref
c3dhall6_aux_ref_t device_aux_ref
Definition: c3dhall6.h:148
c3dhall6_set_reference_values
void c3dhall6_set_reference_values(c3dhall6_t *ctx, c3dhall6_aux_ref_t ref_val)
Setting reference values function.
c3dhall6_aux_float_ch_t::aux_float_ch0
float aux_float_ch0
Definition: c3dhall6.h:122
c3dhall6_t::spi
spi_master_t spi
Definition: c3dhall6.h:145
c3dhall6_aux_ref_t::aux_ref_adc_ch0
float aux_ref_adc_ch0
Definition: c3dhall6.h:131
c3dhall6_aux_ch_t
Definition: c3dhall6.h:112
c3dhall6_get_angle_deg
void c3dhall6_get_angle_deg(c3dhall6_t *ctx, uint8_t die, float *angle_value)
GGetting angle value function.
c3dhall6_aux_ref_t::aux_ref_adc_ch1
float aux_ref_adc_ch1
Definition: c3dhall6.h:132
c3dhall6_aux_ch_t::aux_ch3
uint16_t aux_ch3
Definition: c3dhall6.h:116
c3dhall6_get_volt
void c3dhall6_get_volt(c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage)
Getting voltage on each channel function.
c3dhall6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: c3dhall6.h:167
c3dhall6_aux_float_ch_t::aux_float_ch1
float aux_float_ch1
Definition: c3dhall6.h:123
c3dhall6_aux_ref_t
Definition: c3dhall6.h:130
c3dhall6_cfg_t::sck
pin_name_t sck
Definition: c3dhall6.h:162
c3dhall6_default_cfg
void c3dhall6_default_cfg(c3dhall6_t *ctx)
Click Default Configuration function.
c3dhall6_cfg_t::mosi
pin_name_t mosi
Definition: c3dhall6.h:161
c3dhall6_aux_ref_t::aux_ref_adc_ch2
float aux_ref_adc_ch2
Definition: c3dhall6.h:133
c3dhall6_aux_float_ch_t::aux_float_ch2
float aux_float_ch2
Definition: c3dhall6.h:124
c3dhall6_t::device_float_ch
c3dhall6_aux_float_ch_t device_float_ch
Definition: c3dhall6.h:150
c3dhall6_cfg_t
Click configuration structure definition.
Definition: c3dhall6.h:158
c3dhall6_cfg_t::spi_speed
uint32_t spi_speed
Definition: c3dhall6.h:166
c3dhall6_aux_float_ch_t
Definition: c3dhall6.h:121
c3dhall6_cfg_t::cs
pin_name_t cs
Definition: c3dhall6.h:163
c3dhall6_aux_float_ch_t::aux_float_ch3
float aux_float_ch3
Definition: c3dhall6.h:125
c3dhall6_cfg_t::dev_aux_ref
c3dhall6_aux_ref_t dev_aux_ref
Definition: c3dhall6.h:170
c3dhall6_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: c3dhall6.h:168
c3dhall6_init
err_t c3dhall6_init(c3dhall6_t *ctx, c3dhall6_cfg_t *cfg)
Initialization function.
c3dhall6_t::device_aux_ch
c3dhall6_aux_ch_t device_aux_ch
Definition: c3dhall6.h:149
c3dhall6_aux_ch_t::aux_ch2
uint16_t aux_ch2
Definition: c3dhall6.h:115
c3dhall6_aux_ref_t::aux_ref_volt
float aux_ref_volt
Definition: c3dhall6.h:135
c3dhall6_aux_ref_t::aux_ref_adc_ch3
float aux_ref_adc_ch3
Definition: c3dhall6.h:134
c3dhall6_get_angle_rad
void c3dhall6_get_angle_rad(c3dhall6_t *ctx, uint8_t die, float *angle_value)
GGetting angle value function.
c3dhall6_get_adc_value
void c3dhall6_get_adc_value(c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value)
Getting ADC value on each channel function.
c3dhall6_cfg_t::miso
pin_name_t miso
Definition: c3dhall6.h:160