temphum17  2.0.0.0
temphum17.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 TEMPHUM17_H
29 #define TEMPHUM17_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_i2c_master.h"
48 
69 #define TEMPHUM17_REG_HUMIDITY_SENSOR_RESOLUTION_READ 0x06
70 #define TEMPHUM17_REG_HUMIDITY_SENSOR_RESOLUTION_WRITE 0x46
71 #define TEMPHUM17_REG_TEMPERATURE_SENSOR_RESOLUTION_READ 0x11
72 #define TEMPHUM17_REG_TEMPERATURE_SENSOR_RESOLUTION_WRITE 0x51
73 #define TEMPHUM17_REG_SENSOR_ID_UPPER_READ 0x1E
74 #define TEMPHUM17_REG_SENSOR_ID_LOWER_READ 0x1F
75  // temphum17_reg
77 
92 #define TEMPHUM17_CMD_ENTER_PROGRAMMING_MODE 0xA0
93 #define TEMPHUM17_CMD_DUMMY 0x00
94 #define TEMPHUM17_CMD_ENTER_MEASUREMENTS_MODE 0x80
95  // temphum17_cmd
96 
111 #define TEMPHUM17_STATUS_VALID_DATA 0x00
112 #define TEMPHUM17_STATUS_STALE_DATA 0x01
113  // temphum17_status
114 
129 #define TEMPHUM17_RESOLUTION_8_BITS 0x00
130 #define TEMPHUM17_RESOLUTION_10_BITS 0x01
131 #define TEMPHUM17_RESOLUTION_12_BITS 0x02
132 #define TEMPHUM17_RESOLUTION_14_BITS 0x03
133 
139 #define TEMPHUM17_SET_DEV_ADDR 0x44
140  // temphum17_set
142 
157 #define TEMPHUM17_MAP_MIKROBUS( cfg, mikrobus ) \
158  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
159  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
160  // temphum17_map // temphum17
163 
168 typedef struct
169 {
170  // Modules
171 
172  i2c_master_t i2c;
174  // I2C slave address
175 
176  uint8_t slave_address;
178 } temphum17_t;
179 
184 typedef struct
185 {
186  pin_name_t scl;
187  pin_name_t sda;
190  uint32_t i2c_speed;
191  uint8_t i2c_address;
194 
199 typedef enum
200 {
202  TEMPHUM17_ERROR = -1
203 
205 
224 
242 
259 
277 err_t temphum17_generic_write ( temphum17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
278 
296 err_t temphum17_generic_read ( temphum17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
297 
313 
345 err_t temphum17_get_raw_data ( temphum17_t *ctx, uint8_t resolution, int16_t *temp, uint16_t *hum, uint8_t *status );
346 
377 err_t temphum17_get_temp_hum ( temphum17_t *ctx, uint8_t resolution, float *temperature, float *humidity );
378 
395 
412 
433 err_t temphum17_set_relative_humidity_resolution ( temphum17_t *ctx, uint8_t resolution );
434 
455 err_t temphum17_set_temperature_resolution ( temphum17_t *ctx, uint8_t resolution );
456 
457 #ifdef __cplusplus
458 }
459 #endif
460 #endif // TEMPHUM17_H
461  // temphum17
463 
464 // ------------------------------------------------------------------------ END
temphum17_enter_measurements_mode
err_t temphum17_enter_measurements_mode(temphum17_t *ctx)
Temp&Hum 17 enter measurements mode function.
temphum17_wake_up
err_t temphum17_wake_up(temphum17_t *ctx)
Temp&Hum 17 wake up function.
temphum17_cfg_t
Temp&Hum 17 Click configuration object.
Definition: temphum17.h:185
temphum17_init
err_t temphum17_init(temphum17_t *ctx, temphum17_cfg_t *cfg)
Temp&Hum 17 initialization function.
temphum17_get_raw_data
err_t temphum17_get_raw_data(temphum17_t *ctx, uint8_t resolution, int16_t *temp, uint16_t *hum, uint8_t *status)
Temp&Hum 17 get raw data function.
temphum17_set_relative_humidity_resolution
err_t temphum17_set_relative_humidity_resolution(temphum17_t *ctx, uint8_t resolution)
Temp&Hum 17 set relative humidity resolution function.
temphum17_t::slave_address
uint8_t slave_address
Definition: temphum17.h:176
temphum17_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum17.h:190
temphum17_cfg_t::scl
pin_name_t scl
Definition: temphum17.h:186
temphum17_cfg_t::sda
pin_name_t sda
Definition: temphum17.h:187
temphum17_cfg_setup
void temphum17_cfg_setup(temphum17_cfg_t *cfg)
Temp&Hum 17 configuration object setup function.
temphum17_enter_programming_mode
err_t temphum17_enter_programming_mode(temphum17_t *ctx)
Temp&Hum 17 enter programming mode function.
temphum17_t
Temp&Hum 17 Click context object.
Definition: temphum17.h:169
temphum17_generic_write
err_t temphum17_generic_write(temphum17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Temp&Hum 17 I2C writing function.
temphum17_default_cfg
err_t temphum17_default_cfg(temphum17_t *ctx)
Temp&Hum 17 default configuration function.
temphum17_t::i2c
i2c_master_t i2c
Definition: temphum17.h:172
temphum17_set_temperature_resolution
err_t temphum17_set_temperature_resolution(temphum17_t *ctx, uint8_t resolution)
Temp&Hum 17 set temperature resolution function.
temphum17_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum17.h:191
temphum17_get_temp_hum
err_t temphum17_get_temp_hum(temphum17_t *ctx, uint8_t resolution, float *temperature, float *humidity)
Temp&Hum 17 get temperature and humidity function.
TEMPHUM17_OK
@ TEMPHUM17_OK
Definition: temphum17.h:201
TEMPHUM17_ERROR
@ TEMPHUM17_ERROR
Definition: temphum17.h:202
temphum17_return_value_t
temphum17_return_value_t
Temp&Hum 17 Click return value data.
Definition: temphum17.h:200
temphum17_generic_read
err_t temphum17_generic_read(temphum17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Temp&Hum 17 I2C reading function.