ZMOD4510 Nitrogen Dioxide and Ozone Firmware Documentation
hs3xxx.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 HS3XXX_H
20 #define HS3XXX_H
21 
22 #include <stdbool.h>
23 #include "sensors/hsxxxx.h"
24 
28 typedef enum {
29  hteStaleData = 1
30 } HS3xxx_ErrorCodes_t;
31 
52 int
53 HS3xxx_Init ( HSxxxx_t* sensor, Interface_t* hal );
54 
55 
65 int
66 HS3xxx_ReadID ( HSxxxx_t* sensor, uint32_t* id );
67 
82 int
83 HS3xxx_Measure ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
84 
85 
94 int
95 HS3xxx_MeasureStart ( HSxxxx_t* sensor );
96 
97 
110 int
111 HS3xxx_MeasureRead ( HSxxxx_t* sensor, HSxxxx_Results_t* results );
112 
113 
114 #endif /* HS3XXX_H */
115 
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:36
HSxxxx_Results_t
Data structure holding humidity/temperature results.
Definition: hsxxxx.h:28
HS3xxx_ErrorCodes_t
HS3xxx_ErrorCodes_t
Error code definitions specific for the HS3xxx API.
Definition: hs3xxx.h:28
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:78
hteStaleData
Definition: hs3xxx.h:29
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.