temphum7  2.0.0.0
temphum7.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 TEMPHUM7_H
36 #define TEMPHUM7_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_i2c_master.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define TEMPHUM7_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.scl = MIKROBUS ( mikrobus, MIKROBUS_SCL ); \
63  cfg.sda = MIKROBUS ( mikrobus, MIKROBUS_SDA )
64 
70 #define TEMPHUM7_RETVAL uint8_t
71 
72 #define TEMPHUM7_OK 0x00
73 #define TEMPHUM7_INIT_ERROR 0xFF
74 
80 #define TEMPHUM7_DEVICE_ADDRESS 0x40
81 
87 #define TEMPHUM7_HOLD_MASTER_MODE 0x00
88 #define TEMPHUM7_NOHOLD_MASTER_MODE 0x01
89 #define TEMPHUM7_DATA_FROM_PREVIOUS_RH_MEASUREMENT 0x02
90 
96 #define TEMPHUM7_RESET 0xFE
97 #define TEMPHUM7_WRITE_RHT_USER_REGISTER_1 0xE6
98 #define TEMPHUM7_READ_RHT_USER_REGISTER_1 0xE7
99 #define TEMPHUM7_WRITE_HEATER_CONTROL_REGISTER 0x51
100 #define TEMPHUM7_READ_HEATER_CONTROL_REGISTER 0x11
101 
107 #define TEMPHUM7_RESOLUTION_12_BIT 0x00
108 #define TEMPHUM7_RESOLUTION_8_BIT 0x01
109 #define TEMPHUM7_RESOLUTION_10_BIT 0x80
110 #define TEMPHUM7_RESOLUTION_11_BIT 0x81
111 #define TEMPHUM7_HEATER_ENABLE 0x04
112 #define TEMPHUM7_HEATER_DISABLE 0x00
113 
119 #define TEMPHUM7_HEATER_CURRENT_3p09 0x00
120 #define TEMPHUM7_HEATER_CURRENT_9p17 0x01
121 #define TEMPHUM7_HEATER_CURRENT_15p24 0x02
122 #define TEMPHUM7_HEATER_CURRENT_21p31 0x03
123 #define TEMPHUM7_HEATER_CURRENT_27p39 0x04
124 #define TEMPHUM7_HEATER_CURRENT_33p46 0x05
125 #define TEMPHUM7_HEATER_CURRENT_39p53 0x06
126 #define TEMPHUM7_HEATER_CURRENT_45p61 0x07
127 #define TEMPHUM7_HEATER_CURRENT_51p68 0x08
128 #define TEMPHUM7_HEATER_CURRENT_57p76 0x09
129 #define TEMPHUM7_HEATER_CURRENT_63p83 0x0A
130 #define TEMPHUM7_HEATER_CURRENT_69p90 0x0B
131 #define TEMPHUM7_HEATER_CURRENT_75p98 0x0C
132 #define TEMPHUM7_HEATER_CURRENT_82p05 0x0D
133 #define TEMPHUM7_HEATER_CURRENT_88p13 0x0E
134 #define TEMPHUM7_HEATER_CURRENT_94p20 0x0F
135  // End group macro
138 // --------------------------------------------------------------- PUBLIC TYPES
147 typedef struct
148 {
149  // Modules
150 
151  i2c_master_t i2c;
152 
153  // ctx variable
154 
155  uint8_t slave_address;
156 
157 } temphum7_t;
158 
162 typedef struct
163 {
164  // Communication gpio pins
165 
166  pin_name_t scl;
167  pin_name_t sda;
168 
169  // static variable
170 
171  uint32_t i2c_speed;
172  uint8_t i2c_address;
173 
175  // End types group
177 
178 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
179 
185 #ifdef __cplusplus
186 extern "C"{
187 #endif
188 
198 
208 
223 
234 void temphum7_generic_write ( temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
235 
246 void temphum7_generic_read ( temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
247 
256 float temphum7_get_relative_humidity ( temphum7_t *ctx, uint8_t mode_data );
257 
266 float temphum7_get_temperature ( temphum7_t *ctx, uint8_t mode_data );
267 
276 void temphum7_get_electronic_serial_number ( temphum7_t *ctx, uint8_t *esn_buffer );
277 
286 
295 
304 
305 
306 #ifdef __cplusplus
307 }
308 #endif
309 #endif // _TEMPHUM7_H_
310  // End public_function group
313 
314 // ------------------------------------------------------------------------- END
temphum7_cfg_setup
void temphum7_cfg_setup(temphum7_cfg_t *cfg)
Config Object Initialization function.
temphum7_cfg_t::sda
pin_name_t sda
Definition: temphum7.h:167
temphum7_init
TEMPHUM7_RETVAL temphum7_init(temphum7_t *ctx, temphum7_cfg_t *cfg)
Initialization function.
temphum7_cfg_t::scl
pin_name_t scl
Definition: temphum7.h:166
temphum7_generic_read
void temphum7_generic_read(temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
TEMPHUM7_RETVAL
#define TEMPHUM7_RETVAL
Definition: temphum7.h:70
temphum7_t::slave_address
uint8_t slave_address
Definition: temphum7.h:155
temphum7_default_cfg
void temphum7_default_cfg(temphum7_t *ctx)
Click Default Configuration function.
temphum7_get_electronic_serial_number
void temphum7_get_electronic_serial_number(temphum7_t *ctx, uint8_t *esn_buffer)
Electronic serial number.
temphum7_get_heater_current
float temphum7_get_heater_current(temphum7_t *ctx)
Heater current.
temphum7_t
Click ctx object definition.
Definition: temphum7.h:148
temphum7_generic_write
void temphum7_generic_write(temphum7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
temphum7_get_temperature
float temphum7_get_temperature(temphum7_t *ctx, uint8_t mode_data)
Temerature.
temphum7_cfg_t
Click configuration structure definition.
Definition: temphum7.h:163
temphum7_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum7.h:172
temphum7_t::i2c
i2c_master_t i2c
Definition: temphum7.h:151
temphum7_get_firmware_revision
uint8_t temphum7_get_firmware_revision(temphum7_t *ctx)
Firmware revision.
temphum7_get_relative_humidity
float temphum7_get_relative_humidity(temphum7_t *ctx, uint8_t mode_data)
Relative humidity.
temphum7_reset
void temphum7_reset(temphum7_t *ctx)
Reset.
temphum7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum7.h:171