moisture  2.0.0.0
moisture.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 MOISTURE_H
36 #define MOISTURE_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define MOISTURE_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
57 
63 #define MOISTURE_RETVAL uint8_t
64 
65 #define MOISTURE_OK 0x00
66 #define MOISTURE_INIT_ERROR 0xFF
67 
73 #define MOISTURE_DEV_ADR_GND 0x2A
74 #define MOISTURE_DEV_ADR_VCC 0x2B
75 
81 #define MOISTURE_DEFAULT_OFFSET 0x00AA
82 
88 #define MOISTURE_REG_DATA 0x00
89 #define MOISTURE_REG_RCNT 0x08
90 #define MOISTURE_REG_OFFSET 0x0C
91 #define MOISTURE_REG_SETTLE_CNT 0x10
92 #define MOISTURE_REG_CLOCK_DIVIDERS 0x14
93 #define MOISTURE_REG_STATUS 0x18
94 #define MOISTURE_REG_ERR_CFG 0x19
95 #define MOISTURE_REG_CFG 0x1A
96 #define MOISTURE_REG_MUX_CFG 0x1B
97 #define MOISTURE_REG_RESET_DEV 0x1C
98 #define MOISTURE_REG_DRIVE_CURR 0x1E
99 #define MOISTURE_REG_DEVICE_ID 0x7F
100 #define MOISTURE_REG_MFC_ID 0x7E
101 
107 #define MOISTURE_DRIVE_CURR_0_016mA 0x0000
108 #define MOISTURE_DRIVE_CURR_0_018mA 0x0800
109 #define MOISTURE_DRIVE_CURR_0_021mA 0x1000
110 #define MOISTURE_DRIVE_CURR_0_025mA 0x1800
111 #define MOISTURE_DRIVE_CURR_0_028mA 0x2000
112 #define MOISTURE_DRIVE_CURR_0_033mA 0x2800
113 #define MOISTURE_DRIVE_CURR_0_038mA 0x3000
114 #define MOISTURE_DRIVE_CURR_0_044mA 0x3800
115 #define MOISTURE_DRIVE_CURR_0_052mA 0x4000
116 #define MOISTURE_DRIVE_CURR_0_060mA 0x4800
117 #define MOISTURE_DRIVE_CURR_0_069mA 0x5000
118 #define MOISTURE_DRIVE_CURR_0_081mA 0x5800
119 #define MOISTURE_DRIVE_CURR_0_093mA 0x6000
120 #define MOISTURE_DRIVE_CURR_0_108mA 0x6800
121 #define MOISTURE_DRIVE_CURR_0_126mA 0x7000
122 #define MOISTURE_DRIVE_CURR_0_146mA 0x7800
123 #define MOISTURE_DRIVE_CURR_0_169mA 0x8000
124 #define MOISTURE_DRIVE_CURR_0_196mA 0x8800
125 #define MOISTURE_DRIVE_CURR_0_228mA 0x9000
126 #define MOISTURE_DRIVE_CURR_0_264mA 0x9800
127 #define MOISTURE_DRIVE_CURR_0_307mA 0xA000
128 #define MOISTURE_DRIVE_CURR_0_356mA 0xA800
129 #define MOISTURE_DRIVE_CURR_0_413mA 0xB000
130 #define MOISTURE_DRIVE_CURR_0_479mA 0xB800
131 #define MOISTURE_DRIVE_CURR_0_555mA 0xC000
132 #define MOISTURE_DRIVE_CURR_0_644mA 0xC800
133 #define MOISTURE_DRIVE_CURR_0_747mA 0xD000
134 #define MOISTURE_DRIVE_CURR_0_867mA 0xD800
135 #define MOISTURE_DRIVE_CURR_1_006mA 0xE000
136 #define MOISTURE_DRIVE_CURR_1_167mA 0xE800
137 #define MOISTURE_DRIVE_CURR_1_354mA 0xF000
138 #define MOISTURE_DRIVE_CURR_1_571mA 0xF800
139 
145 #define MOISTURE_RESET_DEVICE 0x8000
146 #define MOISTURE_OUTPUT_GAIN_x1 0x0000
147 #define MOISTURE_OUTPUT_GAIN_x4 0x0200
148 #define MOISTURE_OUTPUT_GAIN_x8 0x0400
149 #define MOISTURE_OUTPUT_GAIN_x16 0x0600
150 
156 #define MOISTURE_MUX_CFG_AUTOSCAN_MODE 0x8000
157 #define MOISTURE_MUX_CFG_CONTINUOUS_MODE 0x0000
158 #define MOISTURE_MUX_CFG_RR_SEQUENCE_CH_01 0x0000
159 #define MOISTURE_MUX_CFG_DEGLITCH_1MHz 0x0001
160 #define MOISTURE_MUX_CFG_DEGLITCH_3_3MHz 0x0004
161 #define MOISTURE_MUX_CFG_DEGLITCH_10MHz 0x0005
162 #define MOISTURE_MUX_CFG_DEGLITCH_33MHz 0x0007
163 
169 #define MOISTURE_CFG_ACTIVE_CHAN_CH0 0x0000
170 #define MOISTURE_CFG_DEVICE_ACTIVE 0x0000
171 #define MOISTURE_CFG_DEVICE_IN_SLEEP_MODE 0x2000
172 #define MOISTURE_CFG_FULL_CURRENT_MODE 0x0000
173 #define MOISTURE_CFG_LOW_POWER_MODE 0x0800
174 #define MOISTURE_CFG_INT_PIN_ENABLE 0x0000
175 #define MOISTURE_CFG_INT_PIN_DISABLE 0x0080
176 
182 #define MOISTURE_ERR_CFG_WATCHDOG_TIMEOUT 0x2000
183 #define MOISTURE_ERR_CFG_AMPLITUDE_HIGH 0x1000
184 #define MOISTURE_ERR_CFG_AMPLITUDE_LOW 0x0800
185 #define MOISTURE_ERR_CFG_DATA_RDY_IN_PIN 0x0001
186 
192 #define MOISTURE_STATUS_ERR_CHAN_0 0x0000
193 #define MOISTURE_STATUS_ERR_WD 0x0800
194 #define MOISTURE_STATUS_ERR_AHW 0x0400
195 #define MOISTURE_STATUS_ERR_AHL 0x0200
196 #define MOISTURE_STATUS_DATA_RDY 0x0040
197 #define MOISTURE_STATUS_CH0_UNREADCONV 0x0008
198 
204 #define MOISTURE_CLOCK_DIVIDERS_x1 0x00001
205 #define MOISTURE_CLOCK_DIVIDERS_x2 0x00002
206 #define MOISTURE_CLOCK_DIVIDERS_x3 0x00003
207 #define MOISTURE_CLOCK_DIVIDERS_x4 0x00004
208 #define MOISTURE_CLOCK_DIVIDERS_x5 0x00005
209 #define MOISTURE_CLOCK_DIVIDERS_x6 0x00006
210 #define MOISTURE_CLOCK_DIVIDERS_x7 0x00007
211 #define MOISTURE_CLOCK_DIVIDERS_x8 0x00008
212 #define MOISTURE_CLOCK_DIVIDERS_x9 0x00009
213 #define MOISTURE_CLOCK_DIVIDERS_x10 0x0000A
214 #define MOISTURE_CLOCK_DIVIDERS_x11 0x0000B
215 #define MOISTURE_CLOCK_DIVIDERS_x12 0x0000C
216 #define MOISTURE_CLOCK_DIVIDERS_x13 0x0000D
217 #define MOISTURE_CLOCK_DIVIDERS_x14 0x0000E
218 #define MOISTURE_CLOCK_DIVIDERS_x15 0x0000F
219 
225 #define MOISTURE_FDC2112_ID 0x3054
226 #define MOISTURE_FDC2212_ID 0x3055
227 
233 #define MOISTURE_SETTLE_CNT_CFG_DEFAULT 0x0064
234 #define MOISTURE_RCNT_CFG_DEFAULT 0x010F
235 #define MOISTURE_COMBINED_VAL_CH0_DIV 0x2001
236 #define MOISTURE_DRIVE_CURR_CH0 0x7C00
237 #define MOISTURE_ALL_ERR_ENABLED 0xFFFF
238 #define MOISTURE_REG_CFG_DEFAULT_SETTINGS 0x0000
239 #define MOISTURE_INPUT_DEGLITCH_FILT_BWDTH_33MHZ 0x0007
240  // End group macro
243 // --------------------------------------------------------------- PUBLIC TYPES
252 typedef struct
253 {
254  // Input pins
255 
256  digital_in_t int_pin;
257 
258  // Modules
259 
260  i2c_master_t i2c;
261 
262  // ctx variable
263 
264  hal_i2c_address_t slave_address;
265  uint16_t calib_air_data;
266 
267 } moisture_t;
268 
272 typedef struct
273 {
274  // Communication gpio pins
275 
276  pin_name_t scl;
277  pin_name_t sda;
278 
279  // Additional gpio pins
280 
281  pin_name_t int_pin;
282 
283  // static variable
284 
285  hal_i2c_speed_t i2c_speed;
286  hal_i2c_address_t i2c_address;
287 
289  // End types group
291 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
292 
298 #ifdef __cplusplus
299 extern "C"{
300 #endif
301 
310 void moisture_cfg_setup ( moisture_cfg_t *cfg );
311 
320 
383 void moisture_default_cfg ( moisture_t *ctx );
384 
395 void moisture_generic_write ( moisture_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
396 
408 void moisture_generic_read ( moisture_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
409 
419 void moisture_write_word ( moisture_t *ctx, uint8_t reg, uint16_t data_in );
420 
430 uint16_t moisture_read_word ( moisture_t *ctx, uint8_t reg );
431 
432 
440 void moisture_soft_reset ( moisture_t *ctx );
441 
506 void moisture_cfg( moisture_t *ctx, uint16_t gain, uint16_t offset, uint16_t clk_div );
507 
517 uint8_t moisture_get_data ( moisture_t *ctx );
518 
527 void moisture_cal ( moisture_t *ctx );
528 
537 uint8_t moisture_check_interrupt ( moisture_t *ctx );
538 
539 #ifdef __cplusplus
540 }
541 #endif
542 #endif // _MOISTURE_H_
543  // End public_function group
546 
547 // ------------------------------------------------------------------------- END
moisture_cal
void moisture_cal(moisture_t *ctx)
Chip calibration function.
moisture_t::calib_air_data
uint16_t calib_air_data
Definition: moisture.h:265
moisture_t::i2c
i2c_master_t i2c
Definition: moisture.h:260
moisture_check_interrupt
uint8_t moisture_check_interrupt(moisture_t *ctx)
Soft reset function.
MOISTURE_RETVAL
#define MOISTURE_RETVAL
Definition: moisture.h:63
moisture_cfg_setup
void moisture_cfg_setup(moisture_cfg_t *cfg)
Config Object Initialization function.
moisture_init
MOISTURE_RETVAL moisture_init(moisture_t *ctx, moisture_cfg_t *cfg)
Initialization function.
moisture_read_word
uint16_t moisture_read_word(moisture_t *ctx, uint8_t reg)
Read word function.
moisture_t::slave_address
hal_i2c_address_t slave_address
Definition: moisture.h:264
moisture_cfg_t::i2c_speed
hal_i2c_speed_t i2c_speed
Definition: moisture.h:285
moisture_cfg_t::int_pin
pin_name_t int_pin
Definition: moisture.h:281
moisture_default_cfg
void moisture_default_cfg(moisture_t *ctx)
Click Default Configuration function.
moisture_t::int_pin
digital_in_t int_pin
Definition: moisture.h:256
moisture_cfg_t
Click configuration structure definition.
Definition: moisture.h:272
moisture_generic_read
void moisture_generic_read(moisture_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
moisture_cfg_t::i2c_address
hal_i2c_address_t i2c_address
Definition: moisture.h:286
moisture_get_data
uint8_t moisture_get_data(moisture_t *ctx)
Measurement data function.
moisture_t
Click ctx object definition.
Definition: moisture.h:252
moisture_cfg_t::scl
pin_name_t scl
Definition: moisture.h:276
moisture_generic_write
void moisture_generic_write(moisture_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
moisture_cfg_t::sda
pin_name_t sda
Definition: moisture.h:277
moisture_soft_reset
void moisture_soft_reset(moisture_t *ctx)
Soft reset function.
moisture_write_word
void moisture_write_word(moisture_t *ctx, uint8_t reg, uint16_t data_in)
Write word function.
moisture_cfg
void moisture_cfg(moisture_t *ctx, uint16_t gain, uint16_t offset, uint16_t clk_div)
Configure device function.