temphum8 2.0.0.0
temphum8.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 TEMPHUM8_H
36#define TEMPHUM8_H
37
38#include "drv_digital_out.h"
39#include "drv_i2c_master.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define TEMPHUM8_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
60#define TEMPHUM8_RETVAL uint8_t
61
62#define TEMPHUM8_OK 0x00
63#define TEMPHUM8_INIT_ERROR 0xFF
70#define TEMPHUM8_TEMP_MEASUREMENT_HOLD_MODE 0xE3
71#define TEMPHUM8_HUM_MEASUREMENT_HOLD_MODE 0xE5
72#define TEMPHUM8_TEMP_MEASUREMENT_NO_HOLD_MODE 0xF3
73#define TEMPHUM8_HUM_MEASUREMENT_NO_HOLD_MODE 0xF5
74#define TEMPHUM8_USER_REGISTER_WRITE 0xE6
75#define TEMPHUM8_USER_REGISTER_READ 0xE7
76#define TEMPHUM8_SOFT_RESET 0xFE
83#define TEMPHUM8_CFG_RESOLUTION_H12_T14 0x00
84#define TEMPHUM8_CFG_RESOLUTION_H8_T12 0x01
85#define TEMPHUM8_CFG_RESOLUTION_H10_T13 0x80
86#define TEMPHUM8_CFG_RESOLUTION_H11_T11 0x81
87#define TEMPHUM8_CFG_END_OF_BATTERY_LESS_THAN_2_25V 0x40
88#define TEMPHUM8_CFG_END_OF_BATTERY_BIGGER_THAN_2_25V 0x00
89#define TEMPHUM8_CFG_ENABLE_ON_CHIP_HEATER 0x00
90#define TEMPHUM8_CFG_DISABLE_OTP_RELOAD 0x02
97#define TEMPHUM8_DEVICE_SLAVE_ADDRESS 0x40
104#define TEMPHUM8_TEMPERATURE_IN_CELSIUS 0x00
105#define TEMPHUM8_TEMPERATURE_IN_KELVIN 0x01
106#define TEMPHUM8_TEMPERATURE_IN_FARENHAJT 0x02 // End group macro
110// --------------------------------------------------------------- PUBLIC TYPES
119typedef struct
120{
121 // Modules
122
123 i2c_master_t i2c;
124
125 // ctx variable
126
129
130} temphum8_t;
131
135typedef struct
136{
137 // Communication gpio pins
138
139 pin_name_t scl;
140 pin_name_t sda;
141
142 // static variable
143
144 uint32_t i2c_speed;
145 uint8_t i2c_address;
146 uint8_t measure_res;
147
149 // End types group
151
152// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
153
159#ifdef __cplusplus
160extern "C"{
161#endif
162
172
182
197
208void temphum8_generic_write ( temphum8_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
209
220void temphum8_generic_read ( temphum8_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
221
228
241void temphum8_set_cfg_register ( temphum8_t *ctx, uint8_t cfg );
242
251float temphum8_get_temperature_data ( temphum8_t *ctx, uint8_t temp_format );
252
261
262#ifdef __cplusplus
263}
264#endif
265#endif // _TEMPHUM8_H_
266 // End public_function group
269
270// ------------------------------------------------------------------------- END
#define TEMPHUM8_RETVAL
Definition: temphum8.h:60
void temphum8_generic_read(temphum8_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic read function.
void temphum8_default_cfg(temphum8_t *ctx)
Click Default Configuration function.
void temphum8_software_reset(temphum8_t *ctx)
Functions for device software reset.
void temphum8_generic_write(temphum8_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic write function.
TEMPHUM8_RETVAL temphum8_init(temphum8_t *ctx, temphum8_cfg_t *cfg)
Initialization function.
void temphum8_cfg_setup(temphum8_cfg_t *cfg)
Config Object Initialization function.
void temphum8_set_cfg_register(temphum8_t *ctx, uint8_t cfg)
Configuration device for measurement.
float temphum8_get_temperature_data(temphum8_t *ctx, uint8_t temp_format)
Temperature data.
float temphum8_get_humidity_data(temphum8_t *ctx)
Relative Huminidy data.
Click configuration structure definition.
Definition: temphum8.h:136
uint8_t measure_res
Definition: temphum8.h:146
uint32_t i2c_speed
Definition: temphum8.h:144
pin_name_t scl
Definition: temphum8.h:139
pin_name_t sda
Definition: temphum8.h:140
uint8_t i2c_address
Definition: temphum8.h:145
Click ctx object definition.
Definition: temphum8.h:120
uint8_t measure_resolution
Definition: temphum8.h:128
i2c_master_t i2c
Definition: temphum8.h:123
uint8_t slave_address
Definition: temphum8.h:127