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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define TEMPHUM11_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define TEMPHUM11_RETVAL uint8_t
62 
63 #define TEMPHUM11_OK 0x00
64 #define TEMPHUM11_INIT_ERROR 0xFF
65 
71 #define TEMPHUM11_REG_TEMPERATURE 0x00
72 #define TEMPHUM11_REG_HUMIDITY 0x01
73 #define TEMPHUM11_REG_CONFIGURATION 0x02
74 #define TEMPHUM11_REG_SERIAL_ID_0 0xFB
75 #define TEMPHUM11_REG_SERIAL_ID_1 0xFC
76 #define TEMPHUM11_REG_SERIAL_ID_2 0xFD
77 #define TEMPHUM11_REG_MANUFACTURER_ID 0xFE
78 #define TEMPHUM11_REG_DEVICE_ID 0xFF
79 
85 #define TEMPHUM11_NORMAL_OPERATION 0x0000
86 #define TEMPHUM11_SOFTWARE_RESET 0x8000
87 #define TEMPHUM11_HEATER_DISABLED 0x0000
88 #define TEMPHUM11_HEATER_ENABLED 0x2000
89 #define TEMPHUM11_TEMP_HUM_ACQUIRED 0x0000
90 #define TEMPHUM11_TEMP_FIRST 0x1000
91 #define TEMPHUM11_BAT_VOLT_BIGGER_THAN_2p8 0x0000
92 #define TEMPHUM11_BAT_VOLT_SMALLER_THAN_2p8 0x0800
93 #define TEMPHUM11_TEMP_RESOLUTION_14bit 0x0000
94 #define TEMPHUM11_TEMP_RESOLUTION_11bit 0x0400
95 #define TEMPHUM11_HUM_RESOLUTION_14bit 0x0000
96 #define TEMPHUM11_HUM_RESOLUTION_11bit 0x0100
97 #define TEMPHUM11_HUM_RESOLUTION_8bit 0x0200
98 
104 #define TEMPHUM11_DEVICE_SLAVE_ADDR 0x40
105 
111 #define TEMPHUM11_DEVICE_ID 0x1050
112 #define TEMPHUM11_MANUFACTURER_ID 0x5449
113 
119 #define TEMPHUM11_TEMP_IN_CELSIUS 0x00
120 #define TEMPHUM11_TEMP_IN_KELVIN 0x01
121 #define TEMPHUM11_TEMP_IN_FAHRENHEIT 0x02
122  // End group macro
124 // --------------------------------------------------------------- PUBLIC TYPES
133 typedef struct
134 {
135  // Modules
136 
137  i2c_master_t i2c;
138 
139  // ctx variable
140 
141  uint8_t slave_address;
142 
143 } temphum11_t;
144 
148 typedef struct
149 {
150  // Communication gpio pins
151 
152  pin_name_t scl;
153  pin_name_t sda;
154 
155  // Static variable
156 
157  uint32_t i2c_speed;
158  uint8_t i2c_address;
159 
161  // End types group
163 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
164 
170 #ifdef __cplusplus
171 extern "C"{
172 #endif
173 
183 
192 
200 void temphum11_default_cfg ( temphum11_t *ctx );
201 
210 void temphum11_write_config ( temphum11_t *ctx, uint16_t config );
211 
222 uint16_t temphum11_read_data ( temphum11_t *ctx, uint8_t reg );
223 
234 float temphum11_get_temperature ( temphum11_t *ctx, uint8_t temp_in );
235 
245 float temphum11_get_humidity ( temphum11_t *ctx );
246 
247 #ifdef __cplusplus
248 }
249 #endif
250 #endif // _TEMPHUM11_H_
251  // End public_function group
254 
255 // ------------------------------------------------------------------------- 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:148
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:157
temphum11_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum11.h:158
temphum11_t::i2c
i2c_master_t i2c
Definition: temphum11.h:137
TEMPHUM11_RETVAL
#define TEMPHUM11_RETVAL
Definition: temphum11.h:61
temphum11_t::slave_address
uint8_t slave_address
Definition: temphum11.h:141
temphum11_cfg_t::sda
pin_name_t sda
Definition: temphum11.h:153
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:152
temphum11_t
Click ctx object definition.
Definition: temphum11.h:133
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.