gaussmeter 2.0.0.0
gaussmeter.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 GAUSSMETER_H
36#define GAUSSMETER_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41#include "drv_spi_master.h"
42
43// -------------------------------------------------------------- PUBLIC MACROS
54#define GAUSSMETER_MAP_MIKROBUS( cfg, mikrobus ) \
55 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
56 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
57 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
58 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
59 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
60 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
61 cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
62 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
69#define GAUSSMETER_MASTER_I2C 0
70#define GAUSSMETER_MASTER_SPI 1
77#define GAUSSMETER_RETVAL uint8_t
78
79#define GAUSSMETER_OK 0x00
80#define GAUSSMETER_INIT_ERROR 0xFF
87#define GAUSSMETER_CONFIG1_REG 0x00
88#define GAUSSMETER_CONFIG2_REG 0x01
89#define GAUSSMETER_CONFIG3_REG 0x02
90#define GAUSSMETER_CONFIG4_REG 0x03
91#define GAUSSMETER_OFFSET_X_REG 0x04
92#define GAUSSMETER_OFFSET_Y_REG 0x05
93#define GAUSSMETER_OFFSET_Z_REG 0x06
94#define GAUSSMETER_WOCXY_THRESHOLD_REG 0x07
95#define GAUSSMETER_WOCZ_THRESHOLD_REG 0x08
96#define GAUSSMETER_WOCT_THRESHOLD_REG 0x09
97
98#define GAUSSMETER_GAIN_0 0x0000
99#define GAUSSMETER_GAIN_1 0x0010
100#define GAUSSMETER_GAIN_2 0x0020
101#define GAUSSMETER_GAIN_3 0x0030
102#define GAUSSMETER_GAIN_4 0x0040
103#define GAUSSMETER_GAIN_5 0x0050
104#define GAUSSMETER_GAIN_6 0x0060
105#define GAUSSMETER_GAIN_7 0x0070
106#define GAUSSMETER_BUILT_IN_SELF_TEST_DIS 0x0000
107#define GAUSSMETER_BUILT_IN_SELF_TEST_EN 0x0100
108#define GAUSSMETER_DIS_Z_MEASURE_PLATES 0x0000
109#define GAUSSMETER_EN_Z_MEASURE_PLATES 0x0080
110#define GAUSSMETER_TRIG_MODE 0x0000
111#define GAUSSMETER_INT_MODE 0x8000
112#define GAUSSMETER_SPI_ONLY 0x4000
113#define GAUSSMETER_I2C_ONLY 0x0600
114#define GAUSSMETER_BOTH_DRIVER 0x0000
115#define GAUSSMETER_WOC_DIFF_DIS 0x0000
116#define GAUSSMETER_WOC_DIFF_EN 0x1000
117#define GAUSSMETER_EXT_TRIG_DIS 0x0000
118#define GAUSSMETER_EXT_TRIG_EN 0x0800
119#define GAUSSMETER_TCMP_DIS 0x0000
120#define GAUSSMETER_TCMP_EN 0x0400
121#define GAUSSMETER_RES_0 0x0000
122#define GAUSSMETER_RES_1 0x0020
123#define GAUSSMETER_RES_2 0x0040
124#define GAUSSMETER_RES_3 0x0060
125
126#define GAUSSMETER_START_BURST_MODE_COMM 0x10
127#define GAUSSMETER_START_WOC_MODE_COMM 0x20
128#define GAUSSMETER_START_SINGLE_MEAS_MODE_COMM 0x30
129#define GAUSSMETER_READ_MEAS_COMM 0x40
130#define GAUSSMETER_READ_REG_COMM 0x50
131#define GAUSSMETER_WRITE_REG_COMM 0x60
132#define GAUSSMETER_EXIT_MODE_COMM 0x80
133#define GAUSSMETER_MEM_RECALL_COMM 0xD0
134#define GAUSSMETER_MEM_STORE_COMM 0xE0
135#define GAUSSMETER_RESET_COMM 0xF0
136
137#define GAUSSMETER_EN_Z_AXIS 0x01
138#define GAUSSMETER_DIS_Z_AXIS 0x00
139#define GAUSSMETER_EN_Y_AXIS 0x01
140#define GAUSSMETER_DIS_Y_AXIS 0x00
141#define GAUSSMETER_EN_X_AXIS 0x01
142#define GAUSSMETER_DIS_X_AXIS 0x00
143#define GAUSSMETER_EN_TEMP_MEAS 0x01
144#define GAUSSMETER_DIS_TEMP_MEAS 0x00
145
146#define GAUSSMETER_EN_SPI_DRIVER 0x00
147#define GAUSSMETER_DIS_SPI_DRIVER 0x01 // End group macro
151// --------------------------------------------------------------- PUBLIC TYPES
160typedef uint8_t gaussmeter_select_t;
161
165typedef void ( *gaussmeter_master_io_t )( struct gaussmeter_s*, uint8_t*, uint8_t, uint8_t*, uint8_t );
166
170typedef struct
171{
172 uint8_t x;
173 uint8_t y;
174 uint8_t z;
175
177
181typedef struct
182{
184 uint16_t select_gain;
185 uint16_t select_res;
186
188
192 typedef struct gaussmeter_s
193{
194 // Output pins
195
196 digital_out_t cs;
197
198 // Input pins
199
200 digital_in_t trg;
201 digital_in_t int_pin;
202
203 // Modules
204
205 i2c_master_t i2c;
206 spi_master_t spi;
207
208 // ctx variable
209
211 pin_name_t chip_select;
214
217
219
223typedef struct
224{
225 // Communication gpio pins
226
227 pin_name_t scl;
228 pin_name_t sda;
229 pin_name_t miso;
230 pin_name_t mosi;
231 pin_name_t sck;
232 pin_name_t cs;
233
234 // Additional gpio pins
235
236 pin_name_t trg;
237 pin_name_t int_pin;
238
239 // static variable
240
241 uint32_t i2c_speed;
242 uint8_t i2c_address;
243
244 uint32_t spi_speed;
245 spi_master_mode_t spi_mode;
246 spi_master_chip_select_polarity_t cs_polarity;
247
250
252 // End types group
254// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
260#ifdef __cplusplus
261extern "C"{
262#endif
263
273
282
291
301uint8_t gaussmeter_write_reg ( gaussmeter_t *ctx, uint8_t reg_addr, uint16_t transfer_data );
302
312uint8_t gaussmeter_send_command ( gaussmeter_t *ctx, uint8_t command );
313
322void gaussmeter_enable_measure ( gaussmeter_t *ctx, uint8_t temp );
323
332uint8_t gaussmeter_get_data( gaussmeter_t *ctx, float *output_data );
333
345void gaussmeter_generic_data_transfer ( gaussmeter_t *ctx, uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf, uint8_t read_len );
346
355
364
365#ifdef __cplusplus
366}
367#endif
368#endif // _GAUSSMETER_H_
369 // End public_function group
372
373// ------------------------------------------------------------------------- END
#define GAUSSMETER_RETVAL
Definition: gaussmeter.h:77
void gaussmeter_default_cfg(gaussmeter_t *ctx)
Click Default Configuration function.
void gaussmeter_generic_data_transfer(gaussmeter_t *ctx, uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf, uint8_t read_len)
Generic read function.
uint8_t gaussmeter_get_data(gaussmeter_t *ctx, float *output_data)
Get data function.
uint8_t gaussmeter_digital_read_int(gaussmeter_t *ctx)
Digital read interrupt function.
uint8_t gaussmeter_write_reg(gaussmeter_t *ctx, uint8_t reg_addr, uint16_t transfer_data)
Write register function.
uint8_t gaussmeter_send_command(gaussmeter_t *ctx, uint8_t command)
Send command function.
uint8_t gaussmeter_digital_read_pwm(gaussmeter_t *ctx)
Digital read pwm function.
GAUSSMETER_RETVAL gaussmeter_init(gaussmeter_t *ctx, gaussmeter_cfg_t *cfg)
Initialization function.
void gaussmeter_enable_measure(gaussmeter_t *ctx, uint8_t temp)
Enable measure function.
void gaussmeter_cfg_setup(gaussmeter_cfg_t *cfg)
Config Object Initialization function.
uint8_t gaussmeter_select_t
Communication type.
Definition: gaussmeter.h:160
struct gaussmeter_s gaussmeter_t
Click ctx object definition.
void(* gaussmeter_master_io_t)(struct gaussmeter_s *, uint8_t *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: gaussmeter.h:165
Auxiliary object definition.
Definition: gaussmeter.h:182
uint8_t command_byte_low
Definition: gaussmeter.h:183
uint16_t select_res
Definition: gaussmeter.h:185
uint16_t select_gain
Definition: gaussmeter.h:184
Axis object definition.
Definition: gaussmeter.h:171
uint8_t x
Definition: gaussmeter.h:172
uint8_t y
Definition: gaussmeter.h:173
uint8_t z
Definition: gaussmeter.h:174
Click configuration structure definition.
Definition: gaussmeter.h:224
gaussmeter_select_t sel
Definition: gaussmeter.h:248
uint32_t i2c_speed
Definition: gaussmeter.h:241
spi_master_chip_select_polarity_t cs_polarity
Definition: gaussmeter.h:246
pin_name_t sck
Definition: gaussmeter.h:231
gaussmeter_aux_t aux
Definition: gaussmeter.h:249
spi_master_mode_t spi_mode
Definition: gaussmeter.h:245
pin_name_t mosi
Definition: gaussmeter.h:230
uint32_t spi_speed
Definition: gaussmeter.h:244
pin_name_t scl
Definition: gaussmeter.h:227
pin_name_t int_pin
Definition: gaussmeter.h:237
pin_name_t trg
Definition: gaussmeter.h:236
pin_name_t miso
Definition: gaussmeter.h:229
pin_name_t sda
Definition: gaussmeter.h:228
pin_name_t cs
Definition: gaussmeter.h:232
uint8_t i2c_address
Definition: gaussmeter.h:242
Click ctx object definition.
Definition: gaussmeter.h:193
digital_out_t cs
Definition: gaussmeter.h:196
digital_in_t trg
Definition: gaussmeter.h:200
spi_master_t spi
Definition: gaussmeter.h:206
gaussmeter_master_io_t data_transfer_f
Definition: gaussmeter.h:212
gaussmeter_aux_t aux
Definition: gaussmeter.h:215
digital_in_t int_pin
Definition: gaussmeter.h:201
i2c_master_t i2c
Definition: gaussmeter.h:205
gaussmeter_axis_t axis
Definition: gaussmeter.h:216
uint8_t slave_address
Definition: gaussmeter.h:210
gaussmeter_select_t master_sel
Definition: gaussmeter.h:213
pin_name_t chip_select
Definition: gaussmeter.h:211