temphum  2.0.0.0
temphum.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 TEMPHIM_H
36 #define TEMPHIM_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define TEMPHIM_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
71 
77 #define TEMPHIM_RETVAL uint8_t
78 
79 #define TEMPHIM_OK 0x00
80 #define TEMPHIM_INIT_ERROR 0xFF
81 
87 #define TEMPANDHUM_I2C_ADDRESS 0x5F
88 
94 #define TEMPANDHUM_WHO_AM_I 0x0F
95 #define TEMPANDHUM_AV_CONF 0x10
96 #define TEMPANDHUM_CTRL_REG1 0x20
97 #define TEMPANDHUM_CTRL_REG2 0x21
98 #define TEMPANDHUM_CTRL_REG3 0x22
99 #define TEMPANDHUM_STATUS_REG 0x27
100 #define TEMPANDHUM_HUMIDITY_OUT_L 0x28
101 #define TEMPANDHUM_HUMIDITY_OUT_H 0x29
102 #define TEMPANDHUM_TEMP_OUT_L 0x2A
103 #define TEMPANDHUM_TEMP_OUT_H 0x2B
104 #define TEMPANDHUM_H0_RH_X2 0x30
105 #define TEMPANDHUM_H1_RH_X2 0x31
106 #define TEMPANDHUM_T0_DEGC_X8 0x32
107 #define TEMPANDHUM_T1_DEGC_X8 0x33
108 #define TEMPANDHUM_T1_T0_MSB 0x35
109 #define TEMPANDHUM_H0_T0_OUT_L 0x36
110 #define TEMPANDHUM_H0_T0_OUT_H 0x37
111 #define TEMPANDHUM_H1_T0_OUT_L 0x3A
112 #define TEMPANDHUM_H1_T0_OUT_H 0x3B
113 #define TEMPANDHUM_T0_OUT_L 0x3C
114 #define TEMPANDHUM_T0_OUT_H 0x3D
115 #define TEMPANDHUM_T1_OUT_L 0x3E
116 #define TEMPANDHUM_T1_OUT_H 0x3F
117 
123 #define TEMPANDHUM_AV_CONF_DEFAULT_VALUE 0x1B
124 #define TEMPANDHUM_CTRL_REG1_DEFAULT_VALUE 0x85
125 #define TEMPANDHUM_CTRL_REG2_DEFAULT_VALUE 0x00
126 #define TEMPANDHUM_CTRL_REG3_DEFAULT_VALUE 0x00
127  // End group macro
130 // --------------------------------------------------------------- PUBLIC TYPES
139 typedef struct
140 {
141  // Input pins
142 
143  digital_in_t int_pin;
144 
145  // Modules
146 
147  i2c_master_t i2c;
148 
149  // ctx variable
150 
151  uint8_t slave_address;
152 
153  float float_h_out;
154  float float_t_out;
155  uint8_t h0_rh_x2;
156  uint8_t h1_rh_x2;
157  uint8_t t0_deg_c_x8;
158  uint8_t t1_deg_c_x8;
159  int16_t h0_t0_out;
160  int16_t h1_t0_out;
161  int16_t t0_out;
162  int16_t t1_out;
165  float h0_rh_cal;
166  float h1_rh_cal;
167 
168 } temphum_t;
169 
173 typedef struct
174 {
175  // Communication gpio pins
176 
177  pin_name_t scl;
178  pin_name_t sda;
179 
180  // Additional gpio pins
181 
182  pin_name_t int_pin;
183 
184  // static variable
185 
186  uint32_t i2c_speed;
187  uint8_t i2c_address;
188 
189 } temphum_cfg_t;
190  // End types group
192 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
193 
199 #ifdef __cplusplus
200 extern "C"{
201 #endif
202 
212 
222 
231 
242 void temphum_generic_write ( temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
243 
254 void temphum_generic_read ( temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
255 
266 uint16_t temphum_get_hum_data ( temphum_t *ctx );
267 
279 
292 void temphum_get_temp_hum ( temphum_t *ctx, float *temperature, float *humidity );
293 
305 
317 
318 #ifdef __cplusplus
319 }
320 #endif
321 #endif // _TEMPHIM_H_
322  // End public_function group
325 
326 // ------------------------------------------------------------------------- END
temphum_default_cfg
void temphum_default_cfg(temphum_t *ctx)
Click Default Configuration function.
temphum_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum.h:187
temphum_t::h1_t0_out
int16_t h1_t0_out
Definition: temphum.h:160
temphum_t::t1_deg_c_x8
uint8_t t1_deg_c_x8
Definition: temphum.h:158
temphum_get_temp_hum
void temphum_get_temp_hum(temphum_t *ctx, float *temperature, float *humidity)
Gets temperature and humidity function.
temphum_t::t1_deg_c_cal
float t1_deg_c_cal
Definition: temphum.h:164
temphum_t::t0_deg_c_x8
uint8_t t0_deg_c_x8
Definition: temphum.h:157
TEMPHIM_RETVAL
#define TEMPHIM_RETVAL
Definition: temphum.h:77
temphum_cfg_t::sda
pin_name_t sda
Definition: temphum.h:178
temphum_get_temperature
float temphum_get_temperature(temphum_t *ctx)
Gets temperature in degrees Celsius function.
temphum_t::i2c
i2c_master_t i2c
Definition: temphum.h:147
temphum_t::t1_out
int16_t t1_out
Definition: temphum.h:162
temphum_t::float_t_out
float float_t_out
Definition: temphum.h:154
temphum_t::h0_rh_cal
float h0_rh_cal
Definition: temphum.h:165
temphum_cfg_t
Click configuration structure definition.
Definition: temphum.h:174
temphum_t::h0_rh_x2
uint8_t h0_rh_x2
Definition: temphum.h:155
temphum_t::float_h_out
float float_h_out
Definition: temphum.h:153
temphum_get_humidity
float temphum_get_humidity(temphum_t *ctx)
Gets humidity in degrees Celsius function.
temphum_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum.h:186
temphum_cfg_t::int_pin
pin_name_t int_pin
Definition: temphum.h:182
temphum_cfg_setup
void temphum_cfg_setup(temphum_cfg_t *cfg)
Config Object Initialization function.
temphum_get_temp_data
uint16_t temphum_get_temp_data(temphum_t *ctx)
Gets temperature data function.
temphum_generic_read
void temphum_generic_read(temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
temphum_get_hum_data
uint16_t temphum_get_hum_data(temphum_t *ctx)
Gets humidity data function.
temphum_t::slave_address
uint8_t slave_address
Definition: temphum.h:151
temphum_generic_write
void temphum_generic_write(temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
temphum_t::h1_rh_cal
float h1_rh_cal
Definition: temphum.h:166
temphum_t::h1_rh_x2
uint8_t h1_rh_x2
Definition: temphum.h:156
temphum_init
TEMPHIM_RETVAL temphum_init(temphum_t *ctx, temphum_cfg_t *cfg)
Initialization function.
temphum_t::h0_t0_out
int16_t h0_t0_out
Definition: temphum.h:159
temphum_t::t0_out
int16_t t0_out
Definition: temphum.h:161
temphum_t::int_pin
digital_in_t int_pin
Definition: temphum.h:143
temphum_t
Click ctx object definition.
Definition: temphum.h:140
temphum_cfg_t::scl
pin_name_t scl
Definition: temphum.h:177
temphum_t::t0_deg_c_cal
float t0_deg_c_cal
Definition: temphum.h:163