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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_analog_in.h"
38 #include "drv_i2c_master.h"
39 
61 #define HUMIDITY_SET_DEV_ADDR 0x4D
62 
67 #define HUMIDITY_ADC_RESOLUTION 0x0FFF
68 #define HUMIDITY_VREF_3V3 3.3
69 #define HUMIDITY_VREF_5V 5.0
70 
75 #define HUMIDITY_DIVISOR 0.00636
76 #define HUMIDITY_SUBTRAHEND 0.1515
77  // humidity_set
79 
94 #define HUMIDITY_MAP_MIKROBUS( cfg, mikrobus ) \
95  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
96  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
97  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
98  // humidity_map // humidity
101 
106 typedef enum
107 {
112 
117 typedef struct
118 {
119  analog_in_t adc;
120  i2c_master_t i2c;
123  uint8_t slave_address;
124  float vref;
126 } humidity_t;
127 
132 typedef struct
133 {
134  pin_name_t an;
135  pin_name_t scl;
136  pin_name_t sda;
138  uint32_t i2c_speed;
139  uint8_t i2c_address;
142  analog_in_resolution_t resolution;
143  float vref;
146 
151 typedef enum
152 {
154  HUMIDITY_ERROR = -1
155 
157 
174 
190 
206 
219 err_t humidity_read_raw_adc ( humidity_t *ctx, uint16_t *raw_adc );
220 
233 err_t humidity_read_voltage ( humidity_t *ctx, float *voltage );
234 
245 err_t humidity_set_vref ( humidity_t *ctx, float vref );
246 
254 float humidity_voltage_to_rh ( humidity_t *ctx, float voltage );
255 
256 #ifdef __cplusplus
257 }
258 #endif
259 #endif // HUMIDITY_H
260  // humidity
262 
263 // ------------------------------------------------------------------------ END
humidity_t
Humidity Click context object.
Definition: humidity.h:118
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:138
humidity_t::i2c
i2c_master_t i2c
Definition: humidity.h:120
HUMIDITY_ERROR
@ HUMIDITY_ERROR
Definition: humidity.h:154
humidity_t::vref
float vref
Definition: humidity.h:124
humidity_cfg_t::vref
float vref
Definition: humidity.h:143
humidity_cfg_t::scl
pin_name_t scl
Definition: humidity.h:135
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:142
HUMIDITY_OK
@ HUMIDITY_OK
Definition: humidity.h:153
humidity_t::drv_sel
humidity_drv_t drv_sel
Definition: humidity.h:122
humidity_return_value_t
humidity_return_value_t
Humidity Click return value data.
Definition: humidity.h:152
humidity_t::adc
analog_in_t adc
Definition: humidity.h:119
HUMIDITY_DRV_SEL_ADC
@ HUMIDITY_DRV_SEL_ADC
Definition: humidity.h:108
humidity_cfg_t::i2c_address
uint8_t i2c_address
Definition: humidity.h:139
humidity_t::slave_address
uint8_t slave_address
Definition: humidity.h:123
humidity_drv_t
humidity_drv_t
Humidity Click driver selector.
Definition: humidity.h:107
HUMIDITY_DRV_SEL_I2C
@ HUMIDITY_DRV_SEL_I2C
Definition: humidity.h:109
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:133
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:141
humidity_cfg_t::an
pin_name_t an
Definition: humidity.h:134
humidity_cfg_t::sda
pin_name_t sda
Definition: humidity.h:136
humidity_cfg_setup
void humidity_cfg_setup(humidity_cfg_t *cfg)
Humidity configuration object setup function.