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 
21 #ifndef HTS221_H
22 #define HTS221_H
23 
24 #include <stdint.h>
25 
26 #include "periph/i2c.h"
27 #include "hts221_regs.h"
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
36 #ifndef HTS221_I2C_ADDRESS
37 #define HTS221_I2C_ADDRESS (0x5F)
38 #endif
39 
43 typedef struct {
45  uint8_t addr;
46  uint8_t avgx;
47  uint8_t rate;
49 
53 enum {
54  HTS221_OK = 0,
55  HTS221_ERROR,
56  HTS221_NOBUS,
57  HTS221_NODEV,
58 };
59 
63 typedef struct {
65  int16_t h0_rh;
66  int16_t h1_rh;
67  int16_t h0_t0_out;
68  int16_t h1_t0_out;
69  int16_t t0_degc;
70  int16_t t1_degc;
71  int16_t t0_out;
72  int16_t t1_out;
73 } hts221_t;
74 
85 int hts221_init(hts221_t *dev, const hts221_params_t *params);
86 
94 int hts221_reboot(const hts221_t *dev);
95 
103 int hts221_one_shot(const hts221_t *dev);
104 
113 int hts221_set_rate(const hts221_t *dev, const uint8_t rate);
114 
122 int hts221_power_on(const hts221_t *dev);
123 
131 int hts221_power_off(const hts221_t *dev);
132 
141 int hts221_get_state(const hts221_t *dev);
142 
151 int hts221_read_humidity(const hts221_t *dev, uint16_t *val);
152 
161 int hts221_read_temperature(const hts221_t *dev, int16_t *val);
162 
163 #ifdef __cplusplus
164 }
165 #endif
166 
167 #endif /* HTS221_H */
168 
i2c_t i2c
bus the device is connected to
Definition: hts221.h:44
uint8_t addr
address on that bus
Definition: hts221.h:45
int16_t h0_rh
lower humitidy reference
Definition: hts221.h:65
int16_t h1_rh
upper humitidy reference
Definition: hts221.h:66
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:108
int16_t t0_out
lower temperature reference raw value
Definition: hts221.h:71
int hts221_one_shot(const hts221_t *dev)
Set device to continues measurements.
int16_t t1_degc
upper temperature reference in degC
Definition: hts221.h:70
int hts221_set_rate(const hts221_t *dev, const uint8_t rate)
Set device to continues 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:43
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:64
int16_t h1_t0_out
upper humitidy to temperature reference
Definition: hts221.h:68
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:47
int16_t t0_degc
lower temperature reference in degC
Definition: hts221.h:69
int16_t h0_t0_out
lower humitidy to temperature reference
Definition: hts221.h:67
int16_t t1_out
upper temperature reference raw value
Definition: hts221.h:72
uint8_t avgx
average sampling of humidity and temperature
Definition: hts221.h:46
Low-level I2C peripheral driver interface definition.
Device descriptor for HTS221 sensors.
Definition: hts221.h:63