ZMOD4510 Ultra-Low Power Ozone Firmware Documentation
hs4xxx.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Copyright (c) 2024 Renesas Electronics Corporation
3  * All Rights Reserved.
4  *
5  * This code is proprietary to Renesas, and is license pursuant to the terms and
6  * conditions that may be accessed at:
7  * https://www.renesas.com/eu/en/document/msc/renesas-software-license-terms-gas-sensor-software
8  *****************************************************************************/
9 
19 #ifndef HS4XXX_H
20 #define HS4XXX_H
21 
22 #include <stdbool.h>
23 #include "sensors/hsxxxx.h"
24 
28 typedef enum {
29  hteHS4xxxCRCError = 1
30 } HS4xxx_ErrorCodes_t;
31 
32 
52 int
53 HS4xxx_Init ( HSxxxx_t* sensor, Interface_t* hal );
54 
64 int
65 HS4xxx_ReadID ( HSxxxx_t* sensor, uint32_t* id );
66 
89 int
90 HS4xxx_Measure ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
91 
92 
111 int
112 HS4xxx_MeasureHold ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
113 
114 
123 int
124 HS4xxx_MeasureStart ( HSxxxx_t* sensor );
125 
126 
142 int
143 HS4xxx_MeasureRead ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
144 
145 #endif /* HS4XXX_H */
146 
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:36
HSxxxx_Results_t
Data structure holding humidity/temperature results.
Definition: hsxxxx.h:28
HS4xxx_ErrorCodes_t
HS4xxx_ErrorCodes_t
Error code definitions specific for the HS4xxx API.
Definition: hs4xxx.h:28
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:29
Interface_t
A structure of pointers to hardware specific functions.
Definition: hal.h:78
HS4xxx_Init
int HS4xxx_Init(HSxxxx_t *sensor, Interface_t *hal)
Initialize the sensor object.