temphum11  2.0.0.0
temphum11.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 TEMPHUM11_H
36 #define TEMPHUM11_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define TEMPHUM11_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
75 #define TEMPHUM11_RETVAL uint8_t
76 
77 #define TEMPHUM11_OK 0x00
78 #define TEMPHUM11_INIT_ERROR 0xFF
79 
85 #define TEMPHUM11_REG_TEMPERATURE 0x00
86 #define TEMPHUM11_REG_HUMIDITY 0x01
87 #define TEMPHUM11_REG_CONFIGURATION 0x02
88 #define TEMPHUM11_REG_SERIAL_ID_0 0xFB
89 #define TEMPHUM11_REG_SERIAL_ID_1 0xFC
90 #define TEMPHUM11_REG_SERIAL_ID_2 0xFD
91 #define TEMPHUM11_REG_MANUFACTURER_ID 0xFE
92 #define TEMPHUM11_REG_DEVICE_ID 0xFF
93 
99 #define TEMPHUM11_NORMAL_OPERATION 0x0000
100 #define TEMPHUM11_SOFTWARE_RESET 0x8000
101 #define TEMPHUM11_HEATER_DISABLED 0x0000
102 #define TEMPHUM11_HEATER_ENABLED 0x2000
103 #define TEMPHUM11_TEMP_HUM_ACQUIRED 0x0000
104 #define TEMPHUM11_TEMP_FIRST 0x1000
105 #define TEMPHUM11_BAT_VOLT_BIGGER_THAN_2p8 0x0000
106 #define TEMPHUM11_BAT_VOLT_SMALLER_THAN_2p8 0x0800
107 #define TEMPHUM11_TEMP_RESOLUTION_14bit 0x0000
108 #define TEMPHUM11_TEMP_RESOLUTION_11bit 0x0400
109 #define TEMPHUM11_HUM_RESOLUTION_14bit 0x0000
110 #define TEMPHUM11_HUM_RESOLUTION_11bit 0x0100
111 #define TEMPHUM11_HUM_RESOLUTION_8bit 0x0200
112 
118 #define TEMPHUM11_DEVICE_SLAVE_ADDR 0x40
119 
125 #define TEMPHUM11_DEVICE_ID 0x1050
126 #define TEMPHUM11_MANUFACTURER_ID 0x5449
127 
133 #define TEMPHUM11_TEMP_IN_CELSIUS 0x00
134 #define TEMPHUM11_TEMP_IN_KELVIN 0x01
135 #define TEMPHUM11_TEMP_IN_FAHRENHEIT 0x02
136  // 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 } temphum11_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 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
178 
184 #ifdef __cplusplus
185 extern "C"{
186 #endif
187 
197 
206 
215 
224 void temphum11_write_config ( temphum11_t *ctx, uint16_t config );
225 
236 uint16_t temphum11_read_data ( temphum11_t *ctx, uint8_t reg );
237 
248 float temphum11_get_temperature ( temphum11_t *ctx, uint8_t temp_in );
249 
260 
261 #ifdef __cplusplus
262 }
263 #endif
264 #endif // _TEMPHUM11_H_
265  // End public_function group
268 
269 // ------------------------------------------------------------------------- END
temphum11_init
TEMPHUM11_RETVAL temphum11_init(temphum11_t *ctx, temphum11_cfg_t *cfg)
Initialization function.
temphum11_cfg_t
Click configuration structure definition.
Definition: temphum11.h:163
temphum11_write_config
void temphum11_write_config(temphum11_t *ctx, uint16_t config)
Function for writing configuration device for measurement.
temphum11_default_cfg
void temphum11_default_cfg(temphum11_t *ctx)
Click Default Configuration function.
temphum11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum11.h:171
temphum11_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum11.h:172
temphum11_t::i2c
i2c_master_t i2c
Definition: temphum11.h:151
TEMPHUM11_RETVAL
#define TEMPHUM11_RETVAL
Definition: temphum11.h:75
temphum11_t::slave_address
uint8_t slave_address
Definition: temphum11.h:155
temphum11_cfg_t::sda
pin_name_t sda
Definition: temphum11.h:167
temphum11_cfg_setup
void temphum11_cfg_setup(temphum11_cfg_t *cfg)
Config Object Initialization function.
temphum11_cfg_t::scl
pin_name_t scl
Definition: temphum11.h:166
temphum11_t
Click ctx object definition.
Definition: temphum11.h:148
temphum11_get_humidity
float temphum11_get_humidity(temphum11_t *ctx)
Functions for reading Relative Huminidy data.
temphum11_get_temperature
float temphum11_get_temperature(temphum11_t *ctx, uint8_t temp_in)
Functions for reading Temperature data.
temphum11_read_data
uint16_t temphum11_read_data(temphum11_t *ctx, uint8_t reg)
Functions for reading data from registers.