IoT Drivers  v3.3.0 (S2022)
Engineering in Software Technology
hih8120.h
Go to the documentation of this file.
1 
30 #ifndef HIH8120_H_
31 #define HIH8120_H_
32 #include <stdbool.h>
33 
40 typedef enum hih8120_driverReturnCodes {
41  HIH8120_OK
42  ,HIH8120_OUT_OF_HEAP
43  ,HIH8120_DRIVER_NOT_INITIALISED
44  ,HIH8120_TWI_BUSY
45 } hih8120_driverReturnCode_t;
46 
47 /* ======================================================================================================================= */
60 hih8120_driverReturnCode_t hih8120_initialise(void);
61 
62 /* ======================================================================================================================= */
75 hih8120_driverReturnCode_t hih8120_destroy(void);
76 
77 /* ======================================================================================================================= */
86 bool hih8120_isReady(void);
87 
88 /* ======================================================================================================================= */
101 hih8120_driverReturnCode_t hih8120_wakeup(void);
102 
103 /* ======================================================================================================================= */
120 hih8120_driverReturnCode_t hih8120_measure(void);
121 
122 /* ======================================================================================================================= */
129 uint16_t hih8120_getHumidityPercent_x10(void);
130 
131 /* ======================================================================================================================= */
138 int16_t hih8120_getTemperature_x10(void);
139 
140 /* ======================================================================================================================= */
147 float hih8120_getHumidity(void);
148 
149 /* ======================================================================================================================= */
156 float hih8120_getTemperature(void);
157 
237 #endif /* HIH8120_H_ */
hih8120_getHumidityPercent_x10
uint16_t hih8120_getHumidityPercent_x10(void)
Get latest measured relative humidity percent in tenths of %.
hih8120_destroy
hih8120_driverReturnCode_t hih8120_destroy(void)
Destroy the HIH8120 driver.
hih8120_getHumidity
float hih8120_getHumidity(void)
Get latest measured relative humidity percent.
HIH8120_OUT_OF_HEAP
@ HIH8120_OUT_OF_HEAP
Definition: hih8120.h:42
hih8120_getTemperature
float hih8120_getTemperature(void)
Get latest measured temperature in C.
hih8120_driverReturnCodes
hih8120_driverReturnCodes
HIH8120 Driver return codes.
Definition: hih8120.h:40
hih8120_measure
hih8120_driverReturnCode_t hih8120_measure(void)
Fetch the latest results from the HIH8180 sensor.
hih8120_initialise
hih8120_driverReturnCode_t hih8120_initialise(void)
Initialise the HIH8120 driver.
HIH8120_TWI_BUSY
@ HIH8120_TWI_BUSY
Definition: hih8120.h:44
HIH8120_OK
@ HIH8120_OK
Definition: hih8120.h:41
hih8120_wakeup
hih8120_driverReturnCode_t hih8120_wakeup(void)
Wakes up the HIH8180 sensor.
hih8120_getTemperature_x10
int16_t hih8120_getTemperature_x10(void)
Get latest measured temperature in tenths of C.
HIH8120_DRIVER_NOT_INITIALISED
@ HIH8120_DRIVER_NOT_INITIALISED
Definition: hih8120.h:43
hih8120_driverReturnCode_t
enum hih8120_driverReturnCodes hih8120_driverReturnCode_t
HIH8120 Driver return codes.
hih8120_isReady
bool hih8120_isReady(void)
Test if result is ready.