temphum6  2.0.0.0
temphum6.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 TEMPHUM6_H
36 #define TEMPHUM6_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define TEMPHUM6_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl= MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda= MIKROBUS( mikrobus, MIKROBUS_SDA )
56 
62 #define TEMPHUM6_RETVAL uint8_t
63 
64 #define TEMPHUM6_OK 0x00
65 #define TEMPHUM6_INIT_ERROR 0xFF
66 
72 #define TEMPHUM6_PART_ID 0x0210
73 #define TEMPHUM6_DEVICE_SLAVE_ADDRESS 0x43
74 
80 #define TEMPHUM6_REG_PART_ID 0x00
81 #define TEMPHUM6_REG_UNIQUE_IDENTIFIER 0x04
82 #define TEMPHUM6_REG_SYSTEM_CONTROL 0x10
83 #define TEMPHUM6_REG_SYSTEM_STATUS 0x11
84 #define TEMPHUM6_REG_SENS_RUN 0x21
85 #define TEMPHUM6_REG_SENS_START 0x22
86 #define TEMPHUM6_REG_SENS_STOP 0x23
87 #define TEMPHUM6_REG_SENS_STATUS 0x24
88 #define TEMPHUM6_REG_TEMPERATURE 0x30
89 #define TEMPHUM6_REG_RELATIVE_HUMIDITY 0x33
90 
96 #define TEMPHUM6_STATUS_I2C_ERROR 4
97 #define TEMPHUM6_STATUS_CRC_ERROR 3
98 #define TEMPHUM6_STATUS_INVALID 2
99 #define TEMPHUM6_STATUS_OK 1
100 
106 #define TEMPHUM6_TEMP_IN_FAHRENHEIT 2
107 #define TEMPHUM6_TEMP_IN_KELVIN 1
108 #define TEMPHUM6_TEMP_IN_CELSIUS 0
109 
115 #define TEMPHUM6_LOW_POWER_DISABLE 0x00
116 #define TEMPHUM6_LOW_POWER_ENABLE 0x01
117 
123 #define TEMPHUM6_SYSTEM_IS_IN_STANDBY_OR_BOOTING_STATE 0
124 #define TEMPHUM6_SYSTEM_IS_IN_ACTIVE_STATE 1
125 
131 #define TEMPHUM6_HUM_RUN_SINGLE_SHOT_MODE 0x00
132 #define TEMPHUM6_TEMP_RUN_SINGLE_SHOT_MODE 0x00
133 #define TEMPHUM6_HUM_RUN_CONTINUOUS_MODE 0x02
134 #define TEMPHUM6_TEMP_RUN_CONTINUOUS_MODE 0x01
135 
141 #define TEMPHUM6_HUM_START_MEASUREMENT 0x02
142 #define TEMPHUM6_TEMP_START_MEASUREMENT 0x01
143 #define TEMPHUM6_DISABLE_MEASUREMENT 0x00
144 
150 #define TEMPHUM6_HUM_STOP_CONTINUOUS_MEASUREMENT 0x02
151 #define TEMPHUM6_TEMP_STOP_CONTINUOUS_MEASUREMENT 0x01
152 #define TEMPHUM6_DISABLE_CONTINUOUS_MEASUREMENT 0x00
153  // End group macro
158 // --------------------------------------------------------------- PUBLIC TYPES
167 typedef struct
168 {
169  // Modules
170 
171  i2c_master_t i2c;
172 
173  // ctx variable
174 
175  uint8_t slave_address;
176 
177 } temphum6_t;
178 
182 typedef struct
183 {
184  // Communication gpio pins
185 
186  pin_name_t scl;
187  pin_name_t sda;
188 
189  // static variable
190 
191  uint32_t i2c_speed;
192  uint8_t i2c_address;
193 
195  // End types group
197 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
198 
204 #ifdef __cplusplus
205 extern "C"{
206 #endif
207 
216 void temphum6_cfg_setup ( temphum6_cfg_t *cfg );
217 
227 
238 void temphum6_generic_write ( temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
239 
250 void temphum6_generic_read ( temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
251 
259 void temphum6_reset ( temphum6_t *ctx );
260 
270 uint16_t temphum6_get_part_id ( temphum6_t *ctx );
271 
283 void temphum6_run ( temphum6_t *ctx );
284 
295 float temphum6_read_temperature ( temphum6_t *ctx, uint8_t temp_in );
296 
307 
308 #ifdef __cplusplus
309 }
310 #endif
311 #endif // _TEMPHUM6_H_
312  // End public_function group
315 
316 // ------------------------------------------------------------------------- END
temphum6_t::slave_address
uint8_t slave_address
Definition: temphum6.h:175
temphum6_get_part_id
uint16_t temphum6_get_part_id(temphum6_t *ctx)
Functions for get device PART ID.
temphum6_t::i2c
i2c_master_t i2c
Definition: temphum6.h:171
temphum6_init
TEMPHUM6_RETVAL temphum6_init(temphum6_t *ctx, temphum6_cfg_t *cfg)
Initialization function.
temphum6_generic_write
void temphum6_generic_write(temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
temphum6_run
void temphum6_run(temphum6_t *ctx)
Functions for RUN measurement.
TEMPHUM6_RETVAL
#define TEMPHUM6_RETVAL
Definition: temphum6.h:62
temphum6_read_temperature
float temphum6_read_temperature(temphum6_t *ctx, uint8_t temp_in)
Functions for read Temperature data.
temphum6_t
Click ctx object definition.
Definition: temphum6.h:167
temphum6_generic_read
void temphum6_generic_read(temphum6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
temphum6_read_relative_huminidy
float temphum6_read_relative_huminidy(temphum6_t *ctx)
Functions for read Relative Huminidy data.
temphum6_cfg_t
Click configuration structure definition.
Definition: temphum6.h:182
temphum6_cfg_t::scl
pin_name_t scl
Definition: temphum6.h:186
temphum6_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum6.h:192
temphum6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum6.h:191
temphum6_cfg_setup
void temphum6_cfg_setup(temphum6_cfg_t *cfg)
Config Object Initialization function.
temphum6_cfg_t::sda
pin_name_t sda
Definition: temphum6.h:187
temphum6_reset
void temphum6_reset(temphum6_t *ctx)
Functions for reset device.