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 "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_i2c_master.h"
51 #include "drv_spi_master.h"
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
64 #define GAUSSMETER_MAP_MIKROBUS( cfg, mikrobus ) \
65  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
66  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
70  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
71  cfg.trg = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
72  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
73 
79 #define GAUSSMETER_MASTER_I2C 0
80 #define GAUSSMETER_MASTER_SPI 1
81 
87 #define GAUSSMETER_RETVAL uint8_t
88 
89 #define GAUSSMETER_OK 0x00
90 #define GAUSSMETER_INIT_ERROR 0xFF
91 
97 #define GAUSSMETER_CONFIG1_REG 0x00
98 #define GAUSSMETER_CONFIG2_REG 0x01
99 #define GAUSSMETER_CONFIG3_REG 0x02
100 #define GAUSSMETER_CONFIG4_REG 0x03
101 #define GAUSSMETER_OFFSET_X_REG 0x04
102 #define GAUSSMETER_OFFSET_Y_REG 0x05
103 #define GAUSSMETER_OFFSET_Z_REG 0x06
104 #define GAUSSMETER_WOCXY_THRESHOLD_REG 0x07
105 #define GAUSSMETER_WOCZ_THRESHOLD_REG 0x08
106 #define GAUSSMETER_WOCT_THRESHOLD_REG 0x09
107 
108 #define GAUSSMETER_GAIN_0 0x0000
109 #define GAUSSMETER_GAIN_1 0x0010
110 #define GAUSSMETER_GAIN_2 0x0020
111 #define GAUSSMETER_GAIN_3 0x0030
112 #define GAUSSMETER_GAIN_4 0x0040
113 #define GAUSSMETER_GAIN_5 0x0050
114 #define GAUSSMETER_GAIN_6 0x0060
115 #define GAUSSMETER_GAIN_7 0x0070
116 #define GAUSSMETER_BUILT_IN_SELF_TEST_DIS 0x0000
117 #define GAUSSMETER_BUILT_IN_SELF_TEST_EN 0x0100
118 #define GAUSSMETER_DIS_Z_MEASURE_PLATES 0x0000
119 #define GAUSSMETER_EN_Z_MEASURE_PLATES 0x0080
120 #define GAUSSMETER_TRIG_MODE 0x0000
121 #define GAUSSMETER_INT_MODE 0x8000
122 #define GAUSSMETER_SPI_ONLY 0x4000
123 #define GAUSSMETER_I2C_ONLY 0x0600
124 #define GAUSSMETER_BOTH_DRIVER 0x0000
125 #define GAUSSMETER_WOC_DIFF_DIS 0x0000
126 #define GAUSSMETER_WOC_DIFF_EN 0x1000
127 #define GAUSSMETER_EXT_TRIG_DIS 0x0000
128 #define GAUSSMETER_EXT_TRIG_EN 0x0800
129 #define GAUSSMETER_TCMP_DIS 0x0000
130 #define GAUSSMETER_TCMP_EN 0x0400
131 #define GAUSSMETER_RES_0 0x0000
132 #define GAUSSMETER_RES_1 0x0020
133 #define GAUSSMETER_RES_2 0x0040
134 #define GAUSSMETER_RES_3 0x0060
135 
136 #define GAUSSMETER_START_BURST_MODE_COMM 0x10
137 #define GAUSSMETER_START_WOC_MODE_COMM 0x20
138 #define GAUSSMETER_START_SINGLE_MEAS_MODE_COMM 0x30
139 #define GAUSSMETER_READ_MEAS_COMM 0x40
140 #define GAUSSMETER_READ_REG_COMM 0x50
141 #define GAUSSMETER_WRITE_REG_COMM 0x60
142 #define GAUSSMETER_EXIT_MODE_COMM 0x80
143 #define GAUSSMETER_MEM_RECALL_COMM 0xD0
144 #define GAUSSMETER_MEM_STORE_COMM 0xE0
145 #define GAUSSMETER_RESET_COMM 0xF0
146 
147 #define GAUSSMETER_EN_Z_AXIS 0x01
148 #define GAUSSMETER_DIS_Z_AXIS 0x00
149 #define GAUSSMETER_EN_Y_AXIS 0x01
150 #define GAUSSMETER_DIS_Y_AXIS 0x00
151 #define GAUSSMETER_EN_X_AXIS 0x01
152 #define GAUSSMETER_DIS_X_AXIS 0x00
153 #define GAUSSMETER_EN_TEMP_MEAS 0x01
154 #define GAUSSMETER_DIS_TEMP_MEAS 0x00
155 
156 #define GAUSSMETER_EN_SPI_DRIVER 0x00
157 #define GAUSSMETER_DIS_SPI_DRIVER 0x01
158  // End group macro
161 // --------------------------------------------------------------- PUBLIC TYPES
170 typedef uint8_t gaussmeter_select_t;
171 
175 typedef void ( *gaussmeter_master_io_t )( struct gaussmeter_s*, uint8_t*, uint8_t, uint8_t*, uint8_t );
176 
180 typedef struct
181 {
182  uint8_t x;
183  uint8_t y;
184  uint8_t z;
185 
187 
191 typedef struct
192 {
194  uint16_t select_gain;
195  uint16_t select_res;
196 
198 
202  typedef struct gaussmeter_s
203 {
204  // Output pins
205 
206  digital_out_t cs;
207 
208  // Input pins
209 
210  digital_in_t trg;
211  digital_in_t int_pin;
212 
213  // Modules
214 
215  i2c_master_t i2c;
216  spi_master_t spi;
217 
218  // ctx variable
219 
220  uint8_t slave_address;
221  pin_name_t chip_select;
224 
227 
229 
233 typedef struct
234 {
235  // Communication gpio pins
236 
237  pin_name_t scl;
238  pin_name_t sda;
239  pin_name_t miso;
240  pin_name_t mosi;
241  pin_name_t sck;
242  pin_name_t cs;
243 
244  // Additional gpio pins
245 
246  pin_name_t trg;
247  pin_name_t int_pin;
248 
249  // static variable
250 
251  uint32_t i2c_speed;
252  uint8_t i2c_address;
253 
254  uint32_t spi_speed;
255  spi_master_mode_t spi_mode;
256  spi_master_chip_select_polarity_t cs_polarity;
257 
260 
262  // End types group
264 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
270 #ifdef __cplusplus
271 extern "C"{
272 #endif
273 
283 
292 
301 
311 uint8_t gaussmeter_write_reg ( gaussmeter_t *ctx, uint8_t reg_addr, uint16_t transfer_data );
312 
322 uint8_t gaussmeter_send_command ( gaussmeter_t *ctx, uint8_t command );
323 
332 void gaussmeter_enable_measure ( gaussmeter_t *ctx, uint8_t temp );
333 
342 uint8_t gaussmeter_get_data( gaussmeter_t *ctx, float *output_data );
343 
355 void gaussmeter_generic_data_transfer ( gaussmeter_t *ctx, uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf, uint8_t read_len );
356 
365 
374 
375 #ifdef __cplusplus
376 }
377 #endif
378 #endif // _GAUSSMETER_H_
379  // End public_function group
382 
383 // ------------------------------------------------------------------------- END
gaussmeter_cfg_t
Click configuration structure definition.
Definition: gaussmeter.h:234
gaussmeter_s::data_transfer_f
gaussmeter_master_io_t data_transfer_f
Definition: gaussmeter.h:222
GAUSSMETER_RETVAL
#define GAUSSMETER_RETVAL
Definition: gaussmeter.h:87
gaussmeter_s::aux
gaussmeter_aux_t aux
Definition: gaussmeter.h:225
gaussmeter_s::master_sel
gaussmeter_select_t master_sel
Definition: gaussmeter.h:223
gaussmeter_cfg_t::sda
pin_name_t sda
Definition: gaussmeter.h:238
gaussmeter_enable_measure
void gaussmeter_enable_measure(gaussmeter_t *ctx, uint8_t temp)
Enable measure function.
gaussmeter_write_reg
uint8_t gaussmeter_write_reg(gaussmeter_t *ctx, uint8_t reg_addr, uint16_t transfer_data)
Write register function.
gaussmeter_axis_t::z
uint8_t z
Definition: gaussmeter.h:184
gaussmeter_aux_t::select_res
uint16_t select_res
Definition: gaussmeter.h:195
gaussmeter_select_t
uint8_t gaussmeter_select_t
Communication type.
Definition: gaussmeter.h:170
gaussmeter_axis_t
Axis object definition.
Definition: gaussmeter.h:181
gaussmeter_master_io_t
void(* gaussmeter_master_io_t)(struct gaussmeter_s *, uint8_t *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: gaussmeter.h:175
gaussmeter_s::i2c
i2c_master_t i2c
Definition: gaussmeter.h:215
gaussmeter_aux_t::select_gain
uint16_t select_gain
Definition: gaussmeter.h:194
gaussmeter_cfg_t::scl
pin_name_t scl
Definition: gaussmeter.h:237
gaussmeter_cfg_t::trg
pin_name_t trg
Definition: gaussmeter.h:246
gaussmeter_s::chip_select
pin_name_t chip_select
Definition: gaussmeter.h:221
gaussmeter_digital_read_pwm
uint8_t gaussmeter_digital_read_pwm(gaussmeter_t *ctx)
Digital read pwm function.
gaussmeter_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gaussmeter.h:251
gaussmeter_cfg_t::aux
gaussmeter_aux_t aux
Definition: gaussmeter.h:259
gaussmeter_s
Click ctx object definition.
Definition: gaussmeter.h:203
gaussmeter_init
GAUSSMETER_RETVAL gaussmeter_init(gaussmeter_t *ctx, gaussmeter_cfg_t *cfg)
Initialization function.
gaussmeter_digital_read_int
uint8_t gaussmeter_digital_read_int(gaussmeter_t *ctx)
Digital read interrupt function.
gaussmeter_cfg_t::sck
pin_name_t sck
Definition: gaussmeter.h:241
gaussmeter_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gaussmeter.h:256
gaussmeter_t
struct gaussmeter_s gaussmeter_t
Click ctx object definition.
gaussmeter_cfg_t::i2c_address
uint8_t i2c_address
Definition: gaussmeter.h:252
gaussmeter_cfg_t::mosi
pin_name_t mosi
Definition: gaussmeter.h:240
gaussmeter_s::axis
gaussmeter_axis_t axis
Definition: gaussmeter.h:226
gaussmeter_get_data
uint8_t gaussmeter_get_data(gaussmeter_t *ctx, float *output_data)
Get data function.
gaussmeter_aux_t
Auxiliary object definition.
Definition: gaussmeter.h:192
gaussmeter_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gaussmeter.h:255
gaussmeter_generic_data_transfer
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.
gaussmeter_cfg_t::int_pin
pin_name_t int_pin
Definition: gaussmeter.h:247
gaussmeter_axis_t::y
uint8_t y
Definition: gaussmeter.h:183
gaussmeter_cfg_t::sel
gaussmeter_select_t sel
Definition: gaussmeter.h:258
gaussmeter_cfg_t::cs
pin_name_t cs
Definition: gaussmeter.h:242
gaussmeter_aux_t::command_byte_low
uint8_t command_byte_low
Definition: gaussmeter.h:193
gaussmeter_cfg_t::spi_speed
uint32_t spi_speed
Definition: gaussmeter.h:254
gaussmeter_s::int_pin
digital_in_t int_pin
Definition: gaussmeter.h:211
gaussmeter_s::slave_address
uint8_t slave_address
Definition: gaussmeter.h:220
gaussmeter_cfg_setup
void gaussmeter_cfg_setup(gaussmeter_cfg_t *cfg)
Config Object Initialization function.
gaussmeter_s::trg
digital_in_t trg
Definition: gaussmeter.h:210
gaussmeter_cfg_t::miso
pin_name_t miso
Definition: gaussmeter.h:239
gaussmeter_axis_t::x
uint8_t x
Definition: gaussmeter.h:182
gaussmeter_s::spi
spi_master_t spi
Definition: gaussmeter.h:216
gaussmeter_s::cs
digital_out_t cs
Definition: gaussmeter.h:206
gaussmeter_default_cfg
void gaussmeter_default_cfg(gaussmeter_t *ctx)
Click Default Configuration function.
gaussmeter_send_command
uint8_t gaussmeter_send_command(gaussmeter_t *ctx, uint8_t command)
Send command function.