RRH46410 Firmware Documentation
hs3xxx.h
Go to the documentation of this file.
1 
10 #ifndef HS3XXX_H
11 #define HS3XXX_H
12 
13 #include <stdbool.h>
14 #include "sensors/hsxxxx.h"
15 
19 typedef enum {
20  hteStaleData = 1
21 } HTError_t;
22 
43 int
44 HS3xxx_Init ( HSxxxx_t* sensor, Interface_t* hal );
45 
46 
56 int
57 HS3xxx_ReadID ( HSxxxx_t* sensor, uint32_t* id );
58 
73 int
74 HS3xxx_Measure ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
75 
76 
85 int
86 HS3xxx_MeasureStart ( HSxxxx_t* sensor );
87 
88 
101 int
102 HS3xxx_MeasureRead ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
103 
104 
105 #endif /* HS3XXX_H */
106 
HS3xxx_MeasureStart
int HS3xxx_MeasureStart(HSxxxx_t *sensor)
Start a temperature/humidity measurement cycle.
HS3xxx_ReadID
int HS3xxx_ReadID(HSxxxx_t *sensor, uint32_t *id)
Read the unique sensor ID of the HS3xxx.
hsxxxx.h
Renesas humidity sensors (HS3xxx, HS4xxx) abstraction.
HSxxxx_t
Data structure holding information required for HSxxxx API operation.
Definition: hsxxxx.h:27
HSxxxx_Results_t
Data structure holding humidity/temperature results.
Definition: hsxxxx.h:19
HTError_t
HTError_t
Error code definitions specific for the HS3xxx API.
Definition: hs3xxx.h:19
hteStaleData
Definition: hs3xxx.h:20
HS3xxx_Measure
int HS3xxx_Measure(HSxxxx_t *sensor, HSxxxx_Results_t *results)
Execute a temperature/humidity measurement cycle.
Interface_t
A structure of pointers to hardware specific functions.
Definition: hal.h:69
HS3xxx_Init
int HS3xxx_Init(HSxxxx_t *sensor, Interface_t *hal)
Initialize the sensor object.
HS3xxx_MeasureRead
int HS3xxx_MeasureRead(HSxxxx_t *sensor, HSxxxx_Results_t *results)
Read temperature/humidity results.