pht  2.0.0.0
pht.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 PHT_H
29 #define PHT_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define PHT_RH_CMD_RESET 0xFE
74 #define PHT_RH_CMD_WRITE_USER_REG 0xE6
75 #define PHT_RH_CMD_READ_USER_REG 0xE7
76 #define PHT_RH_MEASURE_RH_HOLD 0xE5
77 #define PHT_RH_MEASURE_RH_NO_HOLD 0xF5
78 
83 #define PHT_PT_CMD_RESET 0x1E
84 #define PHT_PT_CMD_ADC_READ 0x00
85 #define PHT_PT_CMD_PROM_READ_P_T_START 0xA0
86 #define PHT_PT_CMD_PROM_READ_P_T_END 0xAE
87 
88 #define PHT_PT_CMD_RATIO_256 0x00
89 #define PHT_PT_CMD_RATIO_512 0x01
90 #define PHT_PT_CMD_RATIO_1024 0x02
91 #define PHT_PT_CMD_RATIO_2048 0x03
92 #define PHT_PT_CMD_RATIO_4096 0x04
93 #define PHT_PT_CMD_RATIO_8192 0x05
94 
99 #define PHT_PT_MANUFACTURER_RESERVED 0x00
100 #define PHT_PT_C1_SENS 0x01
101 #define PHT_PT_C2_OFF 0x02
102 #define PHT_PT_C3_TCS 0x03
103 #define PHT_PT_C4_TCO 0x04
104 #define PHT_PT_C5_TREF 0x05
105 #define PHT_PT_C6_TEMPSENS 0x06
106 #define PHT_PT_CRC 0x07
107 
112 #define PHT_SENSOR_TYPE_RH 0x00
113 #define PHT_SENSOR_TYPE_PT 0x01
114 
120 #define PHT_I2C_SLAVE_ADDR_RH 0x40
121 #define PHT_I2C_SLAVE_ADDR_P_AND_T 0x76
122 
123  // pht_set
125 
140 #define PHT_MAP_MIKROBUS( cfg, mikrobus ) \
141  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
142  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
143  // pht_map // pht
146 
151 typedef struct
152 {
153  // Modules
154  i2c_master_t i2c;
156  // I2C slave address
157  uint8_t slave_address;
159 } pht_t;
160 
165 typedef struct
166 {
167  pin_name_t scl;
168  pin_name_t sda;
170  uint32_t i2c_speed;
171  uint8_t i2c_address;
173 } pht_cfg_t;
174 
179 typedef enum
180 {
181  PHT_OK = 0,
182  PHT_ERROR = -1
183 
185 
201 void pht_cfg_setup ( pht_cfg_t *cfg );
202 
216 err_t pht_init ( pht_t *ctx, pht_cfg_t *cfg );
217 
232 err_t pht_generic_write ( pht_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
233 
248 err_t pht_generic_read ( pht_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
249 
250 
262 void pht_set_command ( pht_t *ctx, uint8_t sensor_type, uint8_t cmd );
263 
274 void pht_soft_reset ( pht_t *ctx, uint8_t sensor_type );
275 
290 uint8_t pht_get_prom ( pht_t *ctx, uint8_t sel_data, uint32_t *tx_data );
291 
307 uint8_t pht_set_ratio ( pht_t *ctx, uint8_t temp_ratio, uint8_t press_ratio );
308 
320 void pht_reset ( pht_t *ctx );
321 
332 void pht_write_user_register ( pht_t *ctx, uint8_t tx_data );
333 
343 uint8_t pht_read_user_register ( pht_t *ctx );
344 
355 uint8_t pht_measure_rh ( pht_t *ctx, uint16_t *rh_data );
356 
372 
386 
387 #ifdef __cplusplus
388 }
389 #endif
390 #endif // PHT_H
391  // pht
393 
394 // ------------------------------------------------------------------------ END
pht_get_temperature_pressure
void pht_get_temperature_pressure(pht_t *ctx, float *temperature, float *pressure)
Get temperature and pressure function.
pht_t::slave_address
uint8_t slave_address
Definition: pht.h:157
pht_cfg_t::scl
pin_name_t scl
Definition: pht.h:167
pht_set_ratio
uint8_t pht_set_ratio(pht_t *ctx, uint8_t temp_ratio, uint8_t press_ratio)
Set Ratio function.
pressure
float pressure
Definition: main.c:32
pht_generic_write
err_t pht_generic_write(pht_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
PHT I2C writing function.
pht_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pht.h:170
pht_generic_read
err_t pht_generic_read(pht_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
PHT I2C reading function.
humidity
float humidity
Definition: main.c:33
pht_measure_rh
uint8_t pht_measure_rh(pht_t *ctx, uint16_t *rh_data)
Measure RH function.
pht_return_value_t
pht_return_value_t
PHT Click return value data.
Definition: pht.h:180
temperature
float temperature
Definition: main.c:34
pht_cfg_t
PHT Click configuration object.
Definition: pht.h:166
pht_set_command
void pht_set_command(pht_t *ctx, uint8_t sensor_type, uint8_t cmd)
Set Command function.
pht_soft_reset
void pht_soft_reset(pht_t *ctx, uint8_t sensor_type)
Soft Reset function.
pht_cfg_setup
void pht_cfg_setup(pht_cfg_t *cfg)
PHT configuration object setup function.
pht_cfg_t::sda
pin_name_t sda
Definition: pht.h:168
pht_t::i2c
i2c_master_t i2c
Definition: pht.h:154
pht_read_user_register
uint8_t pht_read_user_register(pht_t *ctx)
Raed User Register function.
PHT_OK
@ PHT_OK
Definition: pht.h:181
pht_t
PHT Click context object.
Definition: pht.h:152
pht_get_relative_humidity
void pht_get_relative_humidity(pht_t *ctx, float *humidity)
Get humidity function.
pht_init
err_t pht_init(pht_t *ctx, pht_cfg_t *cfg)
PHT initialization function.
pht_get_prom
uint8_t pht_get_prom(pht_t *ctx, uint8_t sel_data, uint32_t *tx_data)
Calibration Data Read function.
pht_write_user_register
void pht_write_user_register(pht_t *ctx, uint8_t tx_data)
Write User Register function.
pht_reset
void pht_reset(pht_t *ctx)
Reset function.
pht_cfg_t::i2c_address
uint8_t i2c_address
Definition: pht.h:171
PHT_ERROR
@ PHT_ERROR
Definition: pht.h:182