humidity  2.0.0.0
humidity.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef HUMIDITY_H
29 #define HUMIDITY_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_analog_in.h"
48 #include "drv_i2c_master.h"
49 
71 #define HUMIDITY_SET_DEV_ADDR 0x4D
72 
77 #define HUMIDITY_ADC_RESOLUTION 0x0FFF
78 #define HUMIDITY_VREF_3V3 3.3
79 #define HUMIDITY_VREF_5V 5.0
80 
85 #define HUMIDITY_DIVISOR 0.00636
86 #define HUMIDITY_SUBTRAHEND 0.1515
87  // humidity_set
89 
104 #define HUMIDITY_MAP_MIKROBUS( cfg, mikrobus ) \
105  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
106  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
107  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
108  // humidity_map // humidity
111 
116 typedef enum
117 {
122 
127 typedef struct
128 {
129  analog_in_t adc;
130  i2c_master_t i2c;
133  uint8_t slave_address;
134  float vref;
136 } humidity_t;
137 
142 typedef struct
143 {
144  pin_name_t an;
145  pin_name_t scl;
146  pin_name_t sda;
148  uint32_t i2c_speed;
149  uint8_t i2c_address;
152  analog_in_resolution_t resolution;
153  float vref;
156 
161 typedef enum
162 {
164  HUMIDITY_ERROR = -1
165 
167 
184 
200 
216 
229 err_t humidity_read_raw_adc ( humidity_t *ctx, uint16_t *raw_adc );
230 
243 err_t humidity_read_voltage ( humidity_t *ctx, float *voltage );
244 
257 err_t humidity_set_vref ( humidity_t *ctx, float vref );
258 
268 float humidity_voltage_to_rh ( humidity_t *ctx, float voltage );
269 
270 #ifdef __cplusplus
271 }
272 #endif
273 #endif // HUMIDITY_H
274  // humidity
276 
277 // ------------------------------------------------------------------------ END
humidity_t
Humidity Click context object.
Definition: humidity.h:128
humidity_voltage_to_rh
float humidity_voltage_to_rh(humidity_t *ctx, float voltage)
Humidity voltage to relative humidity function.
humidity_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: humidity.h:148
humidity_t::i2c
i2c_master_t i2c
Definition: humidity.h:130
HUMIDITY_ERROR
@ HUMIDITY_ERROR
Definition: humidity.h:164
humidity_t::vref
float vref
Definition: humidity.h:134
humidity_cfg_t::vref
float vref
Definition: humidity.h:153
humidity_cfg_t::scl
pin_name_t scl
Definition: humidity.h:145
humidity_init
err_t humidity_init(humidity_t *ctx, humidity_cfg_t *cfg)
Humidity initialization function.
humidity_cfg_t::resolution
analog_in_resolution_t resolution
Definition: humidity.h:152
HUMIDITY_OK
@ HUMIDITY_OK
Definition: humidity.h:163
humidity_t::drv_sel
humidity_drv_t drv_sel
Definition: humidity.h:132
humidity_return_value_t
humidity_return_value_t
Humidity Click return value data.
Definition: humidity.h:162
humidity_t::adc
analog_in_t adc
Definition: humidity.h:129
HUMIDITY_DRV_SEL_ADC
@ HUMIDITY_DRV_SEL_ADC
Definition: humidity.h:118
humidity_cfg_t::i2c_address
uint8_t i2c_address
Definition: humidity.h:149
humidity_t::slave_address
uint8_t slave_address
Definition: humidity.h:133
humidity_drv_t
humidity_drv_t
Humidity Click driver selector.
Definition: humidity.h:117
HUMIDITY_DRV_SEL_I2C
@ HUMIDITY_DRV_SEL_I2C
Definition: humidity.h:119
humidity_read_raw_adc
err_t humidity_read_raw_adc(humidity_t *ctx, uint16_t *raw_adc)
Humidity read raw ADC value function.
humidity_read_voltage
err_t humidity_read_voltage(humidity_t *ctx, float *voltage)
Humidity read voltage level function.
humidity_cfg_t
Humidity Click configuration object.
Definition: humidity.h:143
humidity_drv_interface_selection
void humidity_drv_interface_selection(humidity_cfg_t *cfg, humidity_drv_t drv_sel)
Humidity driver interface setup function.
humidity_set_vref
err_t humidity_set_vref(humidity_t *ctx, float vref)
Humidity set vref function.
humidity_cfg_t::drv_sel
humidity_drv_t drv_sel
Definition: humidity.h:151
humidity_cfg_t::an
pin_name_t an
Definition: humidity.h:144
humidity_cfg_t::sda
pin_name_t sda
Definition: humidity.h:146
humidity_cfg_setup
void humidity_cfg_setup(humidity_cfg_t *cfg)
Humidity configuration object setup function.