temphum18  2.0.0.0
temphum18.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 TEMPHUM18_H
29 #define TEMPHUM18_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 TEMPHUM18_REG_HUMIDITY_SENSOR_RESOLUTION_READ 0x06
74 #define TEMPHUM18_REG_HUMIDITY_SENSOR_RESOLUTION_WRITE 0x46
75 #define TEMPHUM18_REG_TEMPERATURE_SENSOR_RESOLUTION_READ 0x11
76 #define TEMPHUM18_REG_TEMPERATURE_SENSOR_RESOLUTION_WRITE 0x51
77 #define TEMPHUM18_REG_SENSOR_ID_UPPER_READ 0x1E
78 #define TEMPHUM18_REG_SENSOR_ID_LOWER_READ 0x1F
79  // temphum18_reg
81 
96 #define TEMPHUM18_CMD_ENTER_PROGRAMMING_MODE 0xA0
97 #define TEMPHUM18_CMD_DUMMY 0x00
98 #define TEMPHUM18_CMD_ENTER_MEASUREMENTS_MODE 0x80
99  // temphum18_cmd
100 
115 #define TEMPHUM18_STATUS_VALID_DATA 0x00
116 #define TEMPHUM18_STATUS_STALE_DATA 0x01
117  // temphum18_status
118 
133 #define TEMPHUM18_RESOLUTION_8_BITS 0x00
134 #define TEMPHUM18_RESOLUTION_10_BITS 0x01
135 #define TEMPHUM18_RESOLUTION_12_BITS 0x02
136 #define TEMPHUM18_RESOLUTION_14_BITS 0x03
137 
143 #define TEMPHUM18_SET_DEV_ADDR 0x44
144  // temphum18_set
146 
161 #define TEMPHUM18_MAP_MIKROBUS( cfg, mikrobus ) \
162  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
163  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
164  // temphum18_map // temphum18
167 
172 typedef struct
173 {
174  // Modules
175  i2c_master_t i2c;
177  // I2C slave address
178  uint8_t slave_address;
180 } temphum18_t;
181 
186 typedef struct
187 {
188  pin_name_t scl;
189  pin_name_t sda;
191  uint32_t i2c_speed;
192  uint8_t i2c_address;
195 
200 typedef enum
201 {
203  TEMPHUM18_ERROR = -1
204 
206 
223 
239 
254 
270 err_t temphum18_generic_write ( temphum18_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
271 
287 err_t temphum18_generic_read ( temphum18_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
288 
303 
333 err_t temphum18_get_raw_data ( temphum18_t *ctx, uint8_t resolution, int16_t *temp, uint16_t *hum, uint8_t *status );
334 
362 err_t temphum18_get_temp_hum ( temphum18_t *ctx, uint8_t resolution, float *temperature, float *humidity );
363 
378 
393 
411 err_t temphum18_set_relative_humidity_resolution ( temphum18_t *ctx, uint8_t resolution );
412 
430 err_t temphum18_set_temperature_resolution ( temphum18_t *ctx, uint8_t resolution );
431 
432 #ifdef __cplusplus
433 }
434 #endif
435 #endif // TEMPHUM18_H
436  // temphum18
438 
439 // ------------------------------------------------------------------------ END
temphum18_cfg_t::sda
pin_name_t sda
Definition: temphum18.h:189
temphum18_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum18.h:191
temphum18_default_cfg
err_t temphum18_default_cfg(temphum18_t *ctx)
Temp&Hum 18 default configuration function.
temphum18_set_temperature_resolution
err_t temphum18_set_temperature_resolution(temphum18_t *ctx, uint8_t resolution)
Temp&Hum 18 set relative temperature resolution function.
temphum18_generic_read
err_t temphum18_generic_read(temphum18_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Temp&Hum 18 I2C reading function.
temphum18_cfg_t
Temp&Hum 18 Click configuration object.
Definition: temphum18.h:187
temphum18_get_raw_data
err_t temphum18_get_raw_data(temphum18_t *ctx, uint8_t resolution, int16_t *temp, uint16_t *hum, uint8_t *status)
Temp&Hum 18 get raw data function.
temphum18_wake_up
err_t temphum18_wake_up(temphum18_t *ctx)
Temp&Hum 18 wake up function.
temphum18_get_temp_hum
err_t temphum18_get_temp_hum(temphum18_t *ctx, uint8_t resolution, float *temperature, float *humidity)
Temp&Hum 18 get temperature and humidity function.
TEMPHUM18_ERROR
@ TEMPHUM18_ERROR
Definition: temphum18.h:203
temphum18_cfg_setup
void temphum18_cfg_setup(temphum18_cfg_t *cfg)
Temp&Hum 18 configuration object setup function.
temphum18_t::i2c
i2c_master_t i2c
Definition: temphum18.h:175
temphum18_return_value_t
temphum18_return_value_t
Temp&Hum 18 Click return value data.
Definition: temphum18.h:201
TEMPHUM18_OK
@ TEMPHUM18_OK
Definition: temphum18.h:202
temphum18_t::slave_address
uint8_t slave_address
Definition: temphum18.h:178
temphum18_cfg_t::scl
pin_name_t scl
Definition: temphum18.h:188
temphum18_enter_measurements_mode
err_t temphum18_enter_measurements_mode(temphum18_t *ctx)
Temp&Hum 18 enter measurements mode function.
temphum18_t
Temp&Hum 18 Click context object.
Definition: temphum18.h:173
temphum18_enter_programming_mode
err_t temphum18_enter_programming_mode(temphum18_t *ctx)
Temp&Hum 18 enter programming mode function.
temphum18_generic_write
err_t temphum18_generic_write(temphum18_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Temp&Hum 18 I2C writing function.
temphum18_init
err_t temphum18_init(temphum18_t *ctx, temphum18_cfg_t *cfg)
Temp&Hum 18 initialization function.
temphum18_set_relative_humidity_resolution
err_t temphum18_set_relative_humidity_resolution(temphum18_t *ctx, uint8_t resolution)
Temp&Hum 18 set relative humidity resolution function.
temphum18_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum18.h:192