Go to the documentation of this file.
35 #include "mikrosdk_version.h"
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
49 #include "drv_analog_in.h"
71 #define C3DHALL4_REG_0 0x00
72 #define C3DHALL4_REG_1 0x01
73 #define C3DHALL4_REG_2 0x02
74 #define C3DHALL4_REG_3 0x03
75 #define C3DHALL4_REG_4 0x04
76 #define C3DHALL4_REG_5 0x05
77 #define C3DHALL4_REG_6 0x06
78 #define C3DHALL4_REG_7 0x07
79 #define C3DHALL4_REG_PWM_CTRL 0x08
80 #define C3DHALL4_REG_CHANNEL_CTRL 0x09
81 #define C3DHALL4_REG_OSC_TRIM 0x0A
82 #define C3DHALL4_REG_THRES_X 0x0B
83 #define C3DHALL4_REG_THRES_Z 0x0C
84 #define C3DHALL4_REG_THRES_Y 0x0D
85 #define C3DHALL4_REG_G_CTRL_X 0x0E
86 #define C3DHALL4_REG_G_CTRL_Z 0x0F
87 #define C3DHALL4_REG_G_CTRL_Y 0x10
88 #define C3DHALL4_REG_DAC_X 0x11
89 #define C3DHALL4_REG_DAC_Z 0x12
90 #define C3DHALL4_REG_DAC_Y 0x13
91 #define C3DHALL4_REG_SENS_X 0x14
92 #define C3DHALL4_REG_SENS_Z 0x15
93 #define C3DHALL4_REG_SENS_Y 0x16
94 #define C3DHALL4_REG_SENS_TC_X 0x17
95 #define C3DHALL4_REG_SENS_TC_Z 0x18
96 #define C3DHALL4_REG_SENS_TC_Y 0x19
97 #define C3DHALL4_REG_OFFSET_X 0x1A
98 #define C3DHALL4_REG_OFFSET_Z 0x1B
99 #define C3DHALL4_REG_OFFSET_Y 0x1C
100 #define C3DHALL4_REG_OFFSET_TC_X 0x1D
101 #define C3DHALL4_REG_OFFSET_TC_Z 0x1E
102 #define C3DHALL4_REG_OFFSET_TC_Y 0x1F
103 #define C3DHALL4_REG_STATUS 0x3F
104 #define C3DHALL4_REG_ADC_DATAXL 0x40
105 #define C3DHALL4_REG_ADC_DATAXH 0x41
106 #define C3DHALL4_REG_ADC_DATAZL 0x42
107 #define C3DHALL4_REG_ADC_DATAZH 0x43
108 #define C3DHALL4_REG_ADC_DATAYL 0x44
109 #define C3DHALL4_REG_ADC_DATAYH 0x45
110 #define C3DHALL4_REG_ADC_DATATL 0x46
111 #define C3DHALL4_REG_ADC_DATATH 0x47
117 #define C3DHALL4_EREG_0 0x00
118 #define C3DHALL4_EREG_1 0x01
119 #define C3DHALL4_EREG_2 0x02
120 #define C3DHALL4_EREG_3 0x03
121 #define C3DHALL4_EREG_4 0x04
122 #define C3DHALL4_EREG_5 0x05
123 #define C3DHALL4_EREG_6 0x06
124 #define C3DHALL4_EREG_7 0x07
125 #define C3DHALL4_EREG_PWM_CTRL 0x08
126 #define C3DHALL4_EREG_CHANNEL_CTRL 0x09
127 #define C3DHALL4_EREG_OSC_TRIM 0x0A
128 #define C3DHALL4_EREG_THRES_Y 0x0B
129 #define C3DHALL4_EREG_THRES_X 0x0C
130 #define C3DHALL4_EREG_THRES_Z 0x0D
131 #define C3DHALL4_EREG_GAIN_SEL 0x0E
132 #define C3DHALL4_EREG_DAC_Y_G0 0x40
133 #define C3DHALL4_EREG_DAC_X_G0 0x41
134 #define C3DHALL4_EREG_DAC_Z_G0 0x42
135 #define C3DHALL4_EREG_SENS_Y_G0 0x43
136 #define C3DHALL4_EREG_SENS_X_G0 0x44
137 #define C3DHALL4_EREG_SENS_Z_G0 0x45
138 #define C3DHALL4_EREG_SENS_TC_Y_G0 0x46
139 #define C3DHALL4_EREG_SENS_TC_X_G0 0x47
140 #define C3DHALL4_EREG_SENS_TC_Z_G0 0x48
141 #define C3DHALL4_EREG_OFFSET_Y_G0 0x49
142 #define C3DHALL4_EREG_OFFSET_X_G0 0x4A
143 #define C3DHALL4_EREG_OFFSET_Z_G0 0x4B
144 #define C3DHALL4_EREG_OFFSET_TC_Y_G0 0x4C
145 #define C3DHALL4_EREG_OFFSET_TC_X_G0 0x4D
146 #define C3DHALL4_EREG_OFFSET_TC_Z_G0 0x4E
147 #define C3DHALL4_EREG_DAC_Y_G1 0x50
148 #define C3DHALL4_EREG_DAC_X_G1 0x51
149 #define C3DHALL4_EREG_DAC_Z_G1 0x52
150 #define C3DHALL4_EREG_SENS_Y_G1 0x53
151 #define C3DHALL4_EREG_SENS_X_G1 0x54
152 #define C3DHALL4_EREG_SENS_Z_G1 0x55
153 #define C3DHALL4_EREG_SENS_TC_Y_G1 0x56
154 #define C3DHALL4_EREG_SENS_TC_X_G1 0x57
155 #define C3DHALL4_EREG_SENS_TC_Z_G1 0x58
156 #define C3DHALL4_EREG_OFFSET_Y_G1 0x59
157 #define C3DHALL4_EREG_OFFSET_X_G1 0x5A
158 #define C3DHALL4_EREG_OFFSET_Z_G1 0x5B
159 #define C3DHALL4_EREG_OFFSET_TC_Y_G1 0x5C
160 #define C3DHALL4_EREG_OFFSET_TC_X_G1 0x5D
161 #define C3DHALL4_EREG_OFFSET_TC_Z_G1 0x5E
162 #define C3DHALL4_EREG_DAC_Y_G2 0x60
163 #define C3DHALL4_EREG_DAC_X_G2 0x61
164 #define C3DHALL4_EREG_DAC_Z_G2 0x62
165 #define C3DHALL4_EREG_SENS_Y_G2 0x63
166 #define C3DHALL4_EREG_SENS_X_G2 0x64
167 #define C3DHALL4_EREG_SENS_Z_G2 0x65
168 #define C3DHALL4_EREG_SENS_TC_Y_G2 0x66
169 #define C3DHALL4_EREG_SENS_TC_X_G2 0x67
170 #define C3DHALL4_EREG_SENS_TC_Z_G2 0x68
171 #define C3DHALL4_EREG_OFFSET_Y_G2 0x69
172 #define C3DHALL4_EREG_OFFSET_X_G2 0x6A
173 #define C3DHALL4_EREG_OFFSET_Z_G2 0x6B
174 #define C3DHALL4_EREG_OFFSET_TC_Y_G2 0x6C
175 #define C3DHALL4_EREG_OFFSET_TC_X_G2 0x6D
176 #define C3DHALL4_EREG_OFFSET_TC_Z_G2 0x6E
177 #define C3DHALL4_EREG_DAC_Y_G3 0x70
178 #define C3DHALL4_EREG_DAC_X_G3 0x71
179 #define C3DHALL4_EREG_DAC_Z_G3 0x72
180 #define C3DHALL4_EREG_SENS_Y_G3 0x73
181 #define C3DHALL4_EREG_SENS_X_G3 0x74
182 #define C3DHALL4_EREG_SENS_Z_G3 0x75
183 #define C3DHALL4_EREG_SENS_TC_Y_G3 0x76
184 #define C3DHALL4_EREG_SENS_TC_X_G3 0x77
185 #define C3DHALL4_EREG_SENS_TC_Z_G3 0x78
186 #define C3DHALL4_EREG_OFFSET_Y_G3 0x79
187 #define C3DHALL4_EREG_OFFSET_X_G3 0x7A
188 #define C3DHALL4_EREG_OFFSET_Z_G3 0x7B
189 #define C3DHALL4_EREG_OFFSET_TC_Y_G3 0x7C
190 #define C3DHALL4_EREG_OFFSET_TC_X_G3 0x7D
191 #define C3DHALL4_EREG_OFFSET_TC_Z_G3 0x7E
192 #define C3DHALL4_EREG_KEY 0xFE
193 #define C3DHALL4_EREG_CHECKSUM 0xFF
211 #define C3DHALL4_CMD_REG_WRITE 0x00
212 #define C3DHALL4_CMD_REG_READ 0x80
213 #define C3DHALL4_CMD_EREG_WRITE 0x01
214 #define C3DHALL4_CMD_EREG_READ 0x81
215 #define C3DHALL4_CMD_SPECIAL_KEY 0xA5
221 #define C3DHALL4_ADC_VREF_3V3 3.3f
222 #define C3DHALL4_ADC_VREF_5V 5.0f
228 #define C3DHALL4_RANGE_20 0x00
229 #define C3DHALL4_RANGE_40 0x01
230 #define C3DHALL4_RANGE_350 0x02
231 #define C3DHALL4_RANGE_3000 0x03
232 #define C3DHALL4_RANGE_MASK 0x03
233 #define C3DHALL4_SENS_RANGE_3000 6.0f
234 #define C3DHALL4_SENS_RANGE_350 60.0f
235 #define C3DHALL4_SENS_RANGE_40 550.0f
236 #define C3DHALL4_SENS_RANGE_20 1000.0f
237 #define C3DHALL4_SENS_TEMPERATURE 168.0f
238 #define C3DHALL4_OFFSET_XYZ 32768
239 #define C3DHALL4_OFFSET_TEMPERATURE 19913
249 #define C3DHALL4_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
250 #define C3DHALL4_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
268 #define C3DHALL4_MAP_MIKROBUS( cfg, mikrobus ) \
269 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
270 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
271 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
272 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
273 cfg.tan = MIKROBUS( mikrobus, MIKROBUS_AN );
uint8_t status
Definition: c3dhall4.h:322
err_t c3dhall4_init(c3dhall4_t *ctx, c3dhall4_cfg_t *cfg)
3D Hall 4 initialization function.
pin_name_t sck
Definition: c3dhall4.h:303
float y_data
Definition: c3dhall4.h:324
err_t c3dhall4_reg_write(c3dhall4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
3D Hall 4 reg write function.
spi_master_t spi
Definition: c3dhall4.h:284
pin_name_t chip_select
Definition: c3dhall4.h:287
This file contains SPI specific macros, functions, etc.
err_t c3dhall4_default_cfg(c3dhall4_t *ctx)
3D Hall 4 default configuration function.
3D Hall 4 Click context object.
Definition: c3dhall4.h:283
err_t c3dhall4_read_an_pin_voltage(c3dhall4_t *ctx, float *data_out)
3D Hall 4 read AN pin voltage level function.
uint32_t spi_speed
Definition: c3dhall4.h:307
spi_master_chip_select_polarity_t cs_polarity
Definition: c3dhall4.h:309
pin_name_t cs
Definition: c3dhall4.h:304
void c3dhall4_cfg_setup(c3dhall4_cfg_t *cfg)
3D Hall 4 configuration object setup function.
c3dhall4_return_value_t
3D Hall 4 Click return value data.
Definition: c3dhall4.h:335
float z_data
Definition: c3dhall4.h:325
pin_name_t tan
Definition: c3dhall4.h:305
err_t c3dhall4_eeprom_write(c3dhall4_t *ctx, uint8_t address, uint8_t data_in)
3D Hall 4 EEPROM write function.
float y_sens
Definition: c3dhall4.h:290
float vref
Definition: c3dhall4.h:312
analog_in_resolution_t resolution
Definition: c3dhall4.h:311
err_t c3dhall4_reg_read(c3dhall4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
3D Hall 4 reg read function.
err_t c3dhall4_read_an_pin_value(c3dhall4_t *ctx, uint16_t *data_out)
3D Hall 4 read AN pin value function.
3D Hall 4 Click data object.
Definition: c3dhall4.h:321
float x_sens
Definition: c3dhall4.h:289
pin_name_t miso
Definition: c3dhall4.h:301
@ C3DHALL4_ERROR
Definition: c3dhall4.h:337
float chip_temp
Definition: c3dhall4.h:326
3D Hall 4 Click configuration object.
Definition: c3dhall4.h:300
@ C3DHALL4_OK
Definition: c3dhall4.h:336
float x_data
Definition: c3dhall4.h:323
err_t c3dhall4_eeprom_read(c3dhall4_t *ctx, uint8_t address, uint8_t *data_out)
3D Hall 4 EEPROM read function.
spi_master_mode_t spi_mode
Definition: c3dhall4.h:308
err_t c3dhall4_read_data(c3dhall4_t *ctx, c3dhall4_data_t *data_out)
3D Hall 4 read data function.
err_t c3dhall4_eeprom_update_cksum(c3dhall4_t *ctx)
3D Hall 4 EEPROM update cksum function.
analog_in_t adc
Definition: c3dhall4.h:285
pin_name_t mosi
Definition: c3dhall4.h:302
float z_sens
Definition: c3dhall4.h:291