temphum 2.0.0.0
temphum.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 TEMPHIM_H
36#define TEMPHIM_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 TEMPHIM_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
63#define TEMPHIM_RETVAL uint8_t
64
65#define TEMPHIM_OK 0x00
66#define TEMPHIM_INIT_ERROR 0xFF
73#define TEMPANDHUM_I2C_ADDRESS 0x5F
80#define TEMPANDHUM_WHO_AM_I 0x0F
81#define TEMPANDHUM_AV_CONF 0x10
82#define TEMPANDHUM_CTRL_REG1 0x20
83#define TEMPANDHUM_CTRL_REG2 0x21
84#define TEMPANDHUM_CTRL_REG3 0x22
85#define TEMPANDHUM_STATUS_REG 0x27
86#define TEMPANDHUM_HUMIDITY_OUT_L 0x28
87#define TEMPANDHUM_HUMIDITY_OUT_H 0x29
88#define TEMPANDHUM_TEMP_OUT_L 0x2A
89#define TEMPANDHUM_TEMP_OUT_H 0x2B
90#define TEMPANDHUM_H0_RH_X2 0x30
91#define TEMPANDHUM_H1_RH_X2 0x31
92#define TEMPANDHUM_T0_DEGC_X8 0x32
93#define TEMPANDHUM_T1_DEGC_X8 0x33
94#define TEMPANDHUM_T1_T0_MSB 0x35
95#define TEMPANDHUM_H0_T0_OUT_L 0x36
96#define TEMPANDHUM_H0_T0_OUT_H 0x37
97#define TEMPANDHUM_H1_T0_OUT_L 0x3A
98#define TEMPANDHUM_H1_T0_OUT_H 0x3B
99#define TEMPANDHUM_T0_OUT_L 0x3C
100#define TEMPANDHUM_T0_OUT_H 0x3D
101#define TEMPANDHUM_T1_OUT_L 0x3E
102#define TEMPANDHUM_T1_OUT_H 0x3F
109#define TEMPANDHUM_AV_CONF_DEFAULT_VALUE 0x1B
110#define TEMPANDHUM_CTRL_REG1_DEFAULT_VALUE 0x85
111#define TEMPANDHUM_CTRL_REG2_DEFAULT_VALUE 0x00
112#define TEMPANDHUM_CTRL_REG3_DEFAULT_VALUE 0x00 // End group macro
116// --------------------------------------------------------------- PUBLIC TYPES
125typedef struct
126{
127 // Input pins
128
129 digital_in_t int_pin;
130
131 // Modules
132
133 i2c_master_t i2c;
134
135 // ctx variable
136
138
141 uint8_t h0_rh_x2;
142 uint8_t h1_rh_x2;
143 uint8_t t0_deg_c_x8;
144 uint8_t t1_deg_c_x8;
145 int16_t h0_t0_out;
146 int16_t h1_t0_out;
147 int16_t t0_out;
148 int16_t t1_out;
153
154} temphum_t;
155
159typedef struct
160{
161 // Communication gpio pins
162
163 pin_name_t scl;
164 pin_name_t sda;
165
166 // Additional gpio pins
167
168 pin_name_t int_pin;
169
170 // static variable
171
172 uint32_t i2c_speed;
173 uint8_t i2c_address;
174
176 // End types group
178// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
179
185#ifdef __cplusplus
186extern "C"{
187#endif
188
198
208
217
228void temphum_generic_write ( temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
229
240void temphum_generic_read ( temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
241
253
265
278void temphum_get_temp_hum ( temphum_t *ctx, float *temperature, float *humidity );
279
291
303
304#ifdef __cplusplus
305}
306#endif
307#endif // _TEMPHIM_H_
308 // End public_function group
311
312// ------------------------------------------------------------------------- END
#define TEMPHIM_RETVAL
Definition: temphum.h:63
uint16_t temphum_get_hum_data(temphum_t *ctx)
Gets humidity data function.
void temphum_default_cfg(temphum_t *ctx)
Click Default Configuration function.
TEMPHIM_RETVAL temphum_init(temphum_t *ctx, temphum_cfg_t *cfg)
Initialization function.
void temphum_generic_read(temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void temphum_generic_write(temphum_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
float temphum_get_humidity(temphum_t *ctx)
Gets humidity in degrees Celsius function.
uint16_t temphum_get_temp_data(temphum_t *ctx)
Gets temperature data function.
void temphum_get_temp_hum(temphum_t *ctx, float *temperature, float *humidity)
Gets temperature and humidity function.
float temphum_get_temperature(temphum_t *ctx)
Gets temperature in degrees Celsius function.
void temphum_cfg_setup(temphum_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: temphum.h:160
uint32_t i2c_speed
Definition: temphum.h:172
pin_name_t scl
Definition: temphum.h:163
pin_name_t int_pin
Definition: temphum.h:168
pin_name_t sda
Definition: temphum.h:164
uint8_t i2c_address
Definition: temphum.h:173
Click ctx object definition.
Definition: temphum.h:126
int16_t t0_out
Definition: temphum.h:147
float float_h_out
Definition: temphum.h:139
uint8_t t1_deg_c_x8
Definition: temphum.h:144
uint8_t h0_rh_x2
Definition: temphum.h:141
int16_t t1_out
Definition: temphum.h:148
int16_t h0_t0_out
Definition: temphum.h:145
float h0_rh_cal
Definition: temphum.h:151
digital_in_t int_pin
Definition: temphum.h:129
uint8_t h1_rh_x2
Definition: temphum.h:142
i2c_master_t i2c
Definition: temphum.h:133
float t1_deg_c_cal
Definition: temphum.h:150
float t0_deg_c_cal
Definition: temphum.h:149
uint8_t slave_address
Definition: temphum.h:137
uint8_t t0_deg_c_x8
Definition: temphum.h:143
int16_t h1_t0_out
Definition: temphum.h:146
float float_t_out
Definition: temphum.h:140
float h1_rh_cal
Definition: temphum.h:152