RRH46410 Firmware Documentation
hs4xxx.h
Go to the documentation of this file.
1 
10 #ifndef HS4XXX_H
11 #define HS4XXX_H
12 
13 #include <stdbool.h>
14 #include "sensors/hsxxxx.h"
15 
19 typedef enum {
20  hteHS4xxxCRCError = 1
21 } HS4xxx_ErrorCodes_t;
22 
23 
43 int
44 HS4xxx_Init ( HSxxxx_t* sensor, Interface_t* hal );
45 
55 int
56 HS4xxx_ReadID ( HSxxxx_t* sensor, uint32_t* id );
57 
80 int
81 HS4xxx_Measure ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
82 
83 
101 int
102 HS4xxx_MeasureHold ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
103 
104 
113 int
114 HS4xxx_MeasureStart ( HSxxxx_t* sensor );
115 
116 
132 int
133 HS4xxx_MeasureRead ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
134 
135 #endif /* HS4XXX_H */
136 
HS4xxx_Measure
int HS4xxx_Measure(HSxxxx_t *sensor, HSxxxx_Results_t *results)
Perform a temperature/humidity measurement cycle.
HS4xxx_MeasureStart
int HS4xxx_MeasureStart(HSxxxx_t *sensor)
Start a temperature/humidity measurement cycle in non-hold mode.
hsxxxx.h
Renesas humidity sensors (HS3xxx, HS4xxx) abstraction.
HS4xxx_ReadID
int HS4xxx_ReadID(HSxxxx_t *sensor, uint32_t *id)
Read the unique sensor ID of the HS4xxx.
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
HS4xxx_ErrorCodes_t
HS4xxx_ErrorCodes_t
Error code definitions specific for the HS4xxx API.
Definition: hs4xxx.h:19
HS4xxx_MeasureRead
int HS4xxx_MeasureRead(HSxxxx_t *sensor, HSxxxx_Results_t *results)
Read temperature/humidity results in non-hold mode.
HS4xxx_MeasureHold
int HS4xxx_MeasureHold(HSxxxx_t *sensor, HSxxxx_Results_t *results)
Perform a temperature/humidity measurement cycle using hold mode.
hteHS4xxxCRCError
Definition: hs4xxx.h:20
Interface_t
A structure of pointers to hardware specific functions.
Definition: hal.h:69
HS4xxx_Init
int HS4xxx_Init(HSxxxx_t *sensor, Interface_t *hal)
Initialize the sensor object.