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 "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 )
64#define C3DHALL6_RETVAL uint8_t
65
66#define C3DHALL6_OK 0x00
67#define C3DHALL6_INIT_ERROR 0xFF
74#define C3DHALL6_CHANNEL_0 0x00
75#define C3DHALL6_CHANNEL_1 0x40
76#define C3DHALL6_CHANNEL_2 0x80
77#define C3DHALL6_CHANNEL_3 0xC0
84#define C3DHALL6_DIE_A 0x01
85#define C3DHALL6_DIE_B 0x02
92#define SINGLE_PI_CONST 3.14
93#define HALF_PI_CONST 1.57 // End group macro
97// --------------------------------------------------------------- PUBLIC TYPES
103typedef struct
104{
105 uint16_t aux_ch0;
106 uint16_t aux_ch1;
107 uint16_t aux_ch2;
108 uint16_t aux_ch3;
110
111typedef struct
112{
118
119typedef struct
120{
127
131typedef struct
132{
133 digital_out_t cs;
134 // Modules
135
136 spi_master_t spi;
137 pin_name_t chip_select;
138
139 uint8_t in_buf[ 10 ];
140 uint8_t out_buf[ 10 ];
141
142 uint16_t aux_var;
143
147
148} c3dhall6_t;
149
153typedef struct
154{
155 // Communication gpio pins
156
157 pin_name_t miso;
158 pin_name_t mosi;
159 pin_name_t sck;
160 pin_name_t cs;
161
162 // static variable
163
164 uint32_t spi_speed;
165 spi_master_mode_t spi_mode;
166 spi_master_chip_select_polarity_t cs_polarity;
167
169
171 // End types group
173// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
174
179#ifdef __cplusplus
180extern "C"{
181#endif
182
192
202
211
223void c3dhall6_generic_transfer ( c3dhall6_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
224
235void c3dhall6_spi_get ( c3dhall6_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t n_bytes );
236
249void 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 );
250
260void c3dhall6_get_adc_value ( c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value );
261
271void c3dhall6_get_volt( c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage );
272
282void c3dhall6_get_angle_deg ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
283
293void c3dhall6_get_angle_rad ( c3dhall6_t *ctx, uint8_t die, float *angle_value );
294
295#ifdef __cplusplus
296}
297#endif
298#endif // _C3DHALL6_H_
299 // End public_function group
302
303// ------------------------------------------------------------------------- END
#define C3DHALL6_RETVAL
Definition: c3dhall6.h:64
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.
void c3dhall6_default_cfg(c3dhall6_t *ctx)
Click Default Configuration function.
void c3dhall6_get_angle_rad(c3dhall6_t *ctx, uint8_t die, float *angle_value)
GGetting angle value function.
void c3dhall6_get_volt(c3dhall6_t *ctx, uint8_t channel_no, float *channel_voltage)
Getting voltage on each channel function.
C3DHALL6_RETVAL c3dhall6_init(c3dhall6_t *ctx, c3dhall6_cfg_t *cfg)
Initialization function.
void c3dhall6_generic_transfer(c3dhall6_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
void c3dhall6_spi_get(c3dhall6_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t n_bytes)
Getting raw data function.
void c3dhall6_get_adc_value(c3dhall6_t *ctx, uint8_t channel_no, uint16_t *adc_value)
Getting ADC value on each channel function.
void c3dhall6_get_angle_deg(c3dhall6_t *ctx, uint8_t die, float *angle_value)
GGetting angle value function.
void c3dhall6_cfg_setup(c3dhall6_cfg_t *cfg)
Config Object Initialization function.
Definition: c3dhall6.h:104
uint16_t aux_ch1
Definition: c3dhall6.h:106
uint16_t aux_ch2
Definition: c3dhall6.h:107
uint16_t aux_ch0
Definition: c3dhall6.h:105
uint16_t aux_ch3
Definition: c3dhall6.h:108
Definition: c3dhall6.h:112
float aux_float_ch1
Definition: c3dhall6.h:114
float aux_float_ch0
Definition: c3dhall6.h:113
float aux_float_ch3
Definition: c3dhall6.h:116
float aux_float_ch2
Definition: c3dhall6.h:115
Definition: c3dhall6.h:120
float aux_ref_adc_ch0
Definition: c3dhall6.h:121
float aux_ref_adc_ch2
Definition: c3dhall6.h:123
float aux_ref_adc_ch3
Definition: c3dhall6.h:124
float aux_ref_volt
Definition: c3dhall6.h:125
float aux_ref_adc_ch1
Definition: c3dhall6.h:122
Click configuration structure definition.
Definition: c3dhall6.h:154
spi_master_chip_select_polarity_t cs_polarity
Definition: c3dhall6.h:166
pin_name_t sck
Definition: c3dhall6.h:159
spi_master_mode_t spi_mode
Definition: c3dhall6.h:165
pin_name_t mosi
Definition: c3dhall6.h:158
uint32_t spi_speed
Definition: c3dhall6.h:164
pin_name_t miso
Definition: c3dhall6.h:157
c3dhall6_aux_ref_t dev_aux_ref
Definition: c3dhall6.h:168
pin_name_t cs
Definition: c3dhall6.h:160
Click ctx object definition.
Definition: c3dhall6.h:132
digital_out_t cs
Definition: c3dhall6.h:133
uint16_t aux_var
Definition: c3dhall6.h:142
spi_master_t spi
Definition: c3dhall6.h:136
c3dhall6_aux_ref_t device_aux_ref
Definition: c3dhall6.h:144
c3dhall6_aux_ch_t device_aux_ch
Definition: c3dhall6.h:145
c3dhall6_aux_float_ch_t device_float_ch
Definition: c3dhall6.h:146
pin_name_t chip_select
Definition: c3dhall6.h:137