hts221.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 HAW Hamburg
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
24 #ifndef HTS221_H
25 #define HTS221_H
26 
27 #include <stdint.h>
28 
29 #include "periph/i2c.h"
30 #include "hts221_regs.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
39 #ifndef HTS221_I2C_ADDRESS
40 #define HTS221_I2C_ADDRESS (0x5F)
41 #endif
42 
46 typedef struct {
48  uint8_t addr;
49  uint8_t avgx;
50  uint8_t rate;
52 
56 enum {
57  HTS221_OK = 0,
58  HTS221_ERROR,
59  HTS221_NOBUS,
60  HTS221_NODEV,
61 };
62 
66 typedef struct {
68  int16_t h0_rh;
69  int16_t h1_rh;
70  int16_t h0_t0_out;
71  int16_t h1_t0_out;
72  int16_t t0_degc;
73  int16_t t1_degc;
74  int16_t t0_out;
75  int16_t t1_out;
76 } hts221_t;
77 
88 int hts221_init(hts221_t *dev, const hts221_params_t *params);
89 
97 int hts221_reboot(const hts221_t *dev);
98 
106 int hts221_one_shot(const hts221_t *dev);
107 
116 int hts221_set_rate(const hts221_t *dev, const uint8_t rate);
117 
125 int hts221_power_on(const hts221_t *dev);
126 
134 int hts221_power_off(const hts221_t *dev);
135 
144 int hts221_get_state(const hts221_t *dev);
145 
154 int hts221_read_humidity(const hts221_t *dev, uint16_t *val);
155 
164 int hts221_read_temperature(const hts221_t *dev, int16_t *val);
165 
166 #ifdef __cplusplus
167 }
168 #endif
169 
170 #endif /* HTS221_H */
171 
i2c_t i2c
bus the device is connected to
Definition: hts221.h:47
uint8_t addr
address on that bus
Definition: hts221.h:48
int16_t h0_rh
lower humitidy reference
Definition: hts221.h:68
int16_t h1_rh
upper humitidy reference
Definition: hts221.h:69
int hts221_init(hts221_t *dev, const hts221_params_t *params)
Initialize the given HTS221 device.
unsigned int i2c_t
Default i2c_t type definition.
Definition: i2c.h:157
int16_t t0_out
lower temperature reference raw value
Definition: hts221.h:74
int hts221_one_shot(const hts221_t *dev)
Set device to one shot measurement.
int16_t t1_degc
upper temperature reference in degC
Definition: hts221.h:73
int hts221_set_rate(const hts221_t *dev, const uint8_t rate)
Set device to continuous measurements.
Register definitions for ST HTS221 devices.
int hts221_power_on(const hts221_t *dev)
Set device to active.
int hts221_read_temperature(const hts221_t *dev, int16_t *val)
Reading humidity and temperature.
Parameters needed for device initialization.
Definition: hts221.h:46
int hts221_get_state(const hts221_t *dev)
Set device to power down.
int hts221_read_humidity(const hts221_t *dev, uint16_t *val)
Reading humidity and temperature.
hts221_params_t p
Configuration parameters.
Definition: hts221.h:67
int16_t h1_t0_out
upper humitidy to temperature reference
Definition: hts221.h:71
int hts221_reboot(const hts221_t *dev)
Reboot device and reload base configuration.
int hts221_power_off(const hts221_t *dev)
Set device to power down.
uint8_t rate
output data rate
Definition: hts221.h:50
int16_t t0_degc
lower temperature reference in degC
Definition: hts221.h:72
int16_t h0_t0_out
lower humitidy to temperature reference
Definition: hts221.h:70
int16_t t1_out
upper temperature reference raw value
Definition: hts221.h:75
uint8_t avgx
average sampling of humidity and temperature
Definition: hts221.h:49
Low-level I2C peripheral driver interface definition.
Device descriptor for HTS221 sensors.
Definition: hts221.h:66