c3dhall6  2.0.0.0
c3dhall6.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef C3DHALL6_H
36 #define C3DHALL6_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define C3DHALL6_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
58 
64 #define C3DHALL6_RETVAL uint8_t
65 
66 #define C3DHALL6_OK 0x00
67 #define C3DHALL6_INIT_ERROR 0xFF
68 
74 #define C3DHALL6_CHANNEL_0 0x00
75 #define C3DHALL6_CHANNEL_1 0x40
76 #define C3DHALL6_CHANNEL_2 0x80
77 #define C3DHALL6_CHANNEL_3 0xC0
78 
84 #define C3DHALL6_DIE_A 0x01
85 #define C3DHALL6_DIE_B 0x02
86 
92 #define SINGLE_PI_CONST 3.14
93 #define HALF_PI_CONST 1.57
94  // End group macro
97 // --------------------------------------------------------------- PUBLIC TYPES
103 typedef struct
104 {
105  uint16_t aux_ch0;
106  uint16_t aux_ch1;
107  uint16_t aux_ch2;
108  uint16_t aux_ch3;
110 
111 typedef struct
112 {
118 
119 typedef struct
120 {
127 
131 typedef struct
132 {
133  // Modules
134 
135  spi_master_t spi;
136 
137  uint8_t in_buf[10];
138  uint8_t out_buf[10];
139 
140  uint16_t aux_var;
141 
145 
146 } c3dhall6_t;
147 
151 typedef struct
152 {
153  // Communication gpio pins
154 
155  pin_name_t miso;
156  pin_name_t mosi;
157  pin_name_t sck;
158  pin_name_t cs;
159 
160  // static variable
161 
162  hal_spi_speed_t spi_speed;
163  hal_spi_mode_t spi_mode;
164 
166 
168  // End types group
170 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
171 
176 #ifdef __cplusplus
177 extern "C"{
178 #endif
179 
188 void c3dhall6_cfg_setup ( c3dhall6_cfg_t *cfg );
189 
198 
206 void c3dhall6_default_cfg ( c3dhall6_t *ctx );
207 
216 void c3dhall6_generic_transfer ( c3dhall6_t *ctx, spi_master_transfer_data_t *block );
217 
228 void c3dhall6_spi_get ( c3dhall6_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t n_bytes );
229 
242 void c3dhall6_set_reference_values ( c3dhall6_t *ctx, float reference_voltage, float ref_adc_ch0, float ref_adc_ch1, float ref_adc_ch2, float ref_adc_ch3 );
243 
253 void c3dhall6_get_adc_value ( c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value );
254 
264 void c3dhall6_get_volt( c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage );
265 
275 void c3dhall6_get_angle_deg ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
276 
286 void c3dhall6_get_angle_rad ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
287 
288 #ifdef __cplusplus
289 }
290 #endif
291 #endif // _C3DHALL6_H_
292  // End public_function group
295 
296 // ------------------------------------------------------------------------- END
void c3dhall6_default_cfg(c3dhall6_t *ctx)
Click Default Configuration function.
uint16_t aux_ch2
Definition: c3dhall6.h:107
float aux_ref_adc_ch2
Definition: c3dhall6.h:123
C3DHALL6_RETVAL c3dhall6_init(c3dhall6_t *ctx, c3dhall6_cfg_t *cfg)
Initialization function.
c3dhall6_aux_float_ch_t device_float_ch
Definition: c3dhall6.h:144
float aux_float_ch2
Definition: c3dhall6.h:115
hal_spi_speed_t spi_speed
Definition: c3dhall6.h:162
void c3dhall6_get_adc_value(c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value)
Getting ADC value on each channel function.
uint16_t aux_ch1
Definition: c3dhall6.h:106
Definition: c3dhall6.h:111
uint16_t aux_ch3
Definition: c3dhall6.h:108
Definition: c3dhall6.h:119
c3dhall6_aux_ref_t device_aux_ref
Definition: c3dhall6.h:142
void c3dhall6_get_volt(c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage)
Getting voltage on each channel function.
float aux_ref_volt
Definition: c3dhall6.h:125
float aux_ref_adc_ch3
Definition: c3dhall6.h:124
Click ctx object definition.
Definition: c3dhall6.h:131
spi_master_t spi
Definition: c3dhall6.h:135
Click configuration structure definition.
Definition: c3dhall6.h:151
#define C3DHALL6_RETVAL
Definition: c3dhall6.h:64
void c3dhall6_get_angle_rad(c3dhall6_t *ctx, uint8_t die, float *angle_value)
GGetting angle value function.
pin_name_t mosi
Definition: c3dhall6.h:156
Definition: c3dhall6.h:103
void c3dhall6_generic_transfer(c3dhall6_t *ctx, spi_master_transfer_data_t *block)
Generic transfer function.
pin_name_t sck
Definition: c3dhall6.h:157
float aux_float_ch3
Definition: c3dhall6.h:116
void c3dhall6_get_angle_deg(c3dhall6_t *ctx, uint8_t die, float *angle_value)
GGetting angle value function.
uint16_t aux_ch0
Definition: c3dhall6.h:105
uint16_t aux_var
Definition: c3dhall6.h:140
void c3dhall6_spi_get(c3dhall6_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t n_bytes)
Getting raw data function.
float aux_float_ch0
Definition: c3dhall6.h:113
hal_spi_mode_t spi_mode
Definition: c3dhall6.h:163
void c3dhall6_cfg_setup(c3dhall6_cfg_t *cfg)
Config Object Initialization function.
c3dhall6_aux_ref_t dev_aux_ref
Definition: c3dhall6.h:165
pin_name_t cs
Definition: c3dhall6.h:158
float aux_ref_adc_ch0
Definition: c3dhall6.h:121
float aux_ref_adc_ch1
Definition: c3dhall6.h:122
c3dhall6_aux_ch_t device_aux_ch
Definition: c3dhall6.h:143
float aux_float_ch1
Definition: c3dhall6.h:114
pin_name_t miso
Definition: c3dhall6.h:155
void c3dhall6_set_reference_values(c3dhall6_t *ctx, float reference_voltage, float ref_adc_ch0, float ref_adc_ch1, float ref_adc_ch2, float ref_adc_ch3)
Setting reference values function.