temphum14 2.0.0.0
temphum14.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 TEMPHUM14_H
29#define TEMPHUM14_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
65#define TEMPHUM14_I2C_SLAVE_ADDR_GND 0x40
66#define TEMPHUM14_I2C_SLAVE_ADDR_VCC 0x41
67
72#define TEMPHUM14_CMD_RESET 0x1E
73#define TEMPHUM14_CMD_HEATER_ON 0x04
74#define TEMPHUM14_CMD_HEATER_OFF 0x02
75#define TEMPHUM14_CMD_READ_T_AND_RH 0x00
76#define TEMPHUM14_CMD_READ_RH 0x10
77#define TEMPHUM14_CMD_CONVERSION 0x40
78#define TEMPHUM14_CMD_READ_DIAGNOSTIC 0x08
79#define TEMPHUM14_CMD_READ_SERIAL_NUMBER 0x0A
80
85#define TEMPHUM14_CONVERSION_HUM_OSR_0_007 0x18
86#define TEMPHUM14_CONVERSION_HUM_OSR_0_010 0x10
87#define TEMPHUM14_CONVERSION_HUM_OSR_0_014 0x08
88#define TEMPHUM14_CONVERSION_HUM_OSR_0_020 0x00
89#define TEMPHUM14_CONVERSION_TEMP_0_012 0x06
90#define TEMPHUM14_CONVERSION_TEMP_0_016 0x04
91#define TEMPHUM14_CONVERSION_TEMP_0_025 0x02
92#define TEMPHUM14_CONVERSION_TEMP_0_040 0x00
93
98#define TEMPHUM14_BIT_MASK_HUM_OSR 0x18
99#define TEMPHUM14_BIT_MASK_TEMP_OSR 0x06
100
105#define TEMPHUM14_HEATER_DISABLE 0x00
106#define TEMPHUM14_HEATER_ENABLE 0x01
107
112#define TEMPHUM14_STATUS_OFF 0x00
113#define TEMPHUM14_STATUS_ON 0x01
114
115// Calculation
120#define TEMPHUM14_CALC_16_BIT_DIVIDER 65535.0
121#define TEMPHUM14_CALC_TEMP_MULTI_FACT 165.000
122#define TEMPHUM14_CALC_TEMP_SUB_FACT 40.0000
123#define TEMPHUM14_CALC_HUM_MULTI_FACT 100.000
124 // temphum14_reg
126
127
142#define TEMPHUM14_MAP_MIKROBUS( cfg, mikrobus ) \
143 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
144 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
145 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
146 // temphum14_map // temphum14
149
154typedef struct
155{
156 // Output pins
157 digital_out_t rst;
159 // Modules
160 i2c_master_t i2c;
162 // I2C slave address
166
171typedef struct
172{
173 pin_name_t scl;
174 pin_name_t sda;
176 pin_name_t rst;
178 uint32_t i2c_speed;
179 uint8_t i2c_address;
182
187typedef enum
188{
190 TEMPHUM14_ERROR = -1
191
193
194typedef struct
195{
196 uint8_t nvm_error;
197 uint8_t hum_un_over;
198 uint8_t hum_h_err;
199 uint8_t hum_l_err;
201 uint8_t temp_h_err;
202 uint8_t temp_l_err;
203 uint8_t heater_on;
205
222
237
253err_t temphum14_generic_write ( temphum14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
254
270err_t temphum14_generic_read ( temphum14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
271
282
293void temphum14_set_cmd ( temphum14_t *ctx, uint8_t cmd );
294
309void temphum14_set_conversion ( temphum14_t *ctx, uint8_t hum_osr, uint8_t temp_osr );
310
321void temphum14_read_t_and_rh ( temphum14_t *ctx, uint8_t *p_rx_data );
322
334void temphum14_get_temp_and_hum ( temphum14_t *ctx, float *temp, float *hum );
335
346void temphum14_read_rh ( temphum14_t *ctx, uint8_t *p_rx_data );
347
359
370
381void temphum14_set_heater ( temphum14_t *ctx, uint8_t en_heater );
382
394
405
406#ifdef __cplusplus
407}
408#endif
409#endif // TEMPHUM14_H
410 // temphum14
412
413// ------------------------------------------------------------------------ END
void temphum14_set_conversion(temphum14_t *ctx, uint8_t hum_osr, uint8_t temp_osr)
Set conversion function.
void temphum14_read_rh(temphum14_t *ctx, uint8_t *p_rx_data)
Read humidity data function.
err_t temphum14_init(temphum14_t *ctx, temphum14_cfg_t *cfg)
Temp Hum 14 initialization function.
void temphum14_read_t_and_rh(temphum14_t *ctx, uint8_t *p_rx_data)
Read temperature and humidity data function.
void temphum14_get_temp_and_hum(temphum14_t *ctx, float *temp, float *hum)
Get temperature and humidity data function.
uint32_t temphum14_get_serial_number(temphum14_t *ctx)
Get serial number function.
void temphum14_hw_reset(temphum14_t *ctx)
HW reset function.
void temphum14_get_diagnostic(temphum14_t *ctx, temphum14_diagn_t *diag_data)
Get diagnostic status function.
float temphum14_get_hum(temphum14_t *ctx)
Get humidity data function.
void temphum14_soft_reset(temphum14_t *ctx)
Soft reset function.
void temphum14_cfg_setup(temphum14_cfg_t *cfg)
Temp Hum 14 configuration object setup function.
void temphum14_set_heater(temphum14_t *ctx, uint8_t en_heater)
Enable heater function.
void temphum14_set_cmd(temphum14_t *ctx, uint8_t cmd)
Send command function.
err_t temphum14_generic_read(temphum14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Temp Hum 14 I2C reading function.
err_t temphum14_generic_write(temphum14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Temp Hum 14 I2C writing function.
Temp Hum 14 Click configuration object.
Definition: temphum14.h:172
uint32_t i2c_speed
Definition: temphum14.h:178
pin_name_t scl
Definition: temphum14.h:173
pin_name_t sda
Definition: temphum14.h:174
pin_name_t rst
Definition: temphum14.h:176
uint8_t i2c_address
Definition: temphum14.h:179
Definition: temphum14.h:195
uint8_t nvm_error
Definition: temphum14.h:196
uint8_t hum_un_over
Definition: temphum14.h:197
uint8_t hum_h_err
Definition: temphum14.h:198
uint8_t temp_un_over
Definition: temphum14.h:200
uint8_t temp_l_err
Definition: temphum14.h:202
uint8_t hum_l_err
Definition: temphum14.h:199
uint8_t temp_h_err
Definition: temphum14.h:201
uint8_t heater_on
Definition: temphum14.h:203
Temp Hum 14 Click context object.
Definition: temphum14.h:155
i2c_master_t i2c
Definition: temphum14.h:160
digital_out_t rst
Definition: temphum14.h:157
uint8_t slave_address
Definition: temphum14.h:163
temphum14_return_value_t
Temp Hum 14 Click return value data.
Definition: temphum14.h:188
@ TEMPHUM14_OK
Definition: temphum14.h:189
@ TEMPHUM14_ERROR
Definition: temphum14.h:190