IoT Drivers  v3.3.0 (S2022)
Engineering in Software Technology
mh_z19.h
Go to the documentation of this file.
1 
37 #ifndef MH_Z19_H_
38 #define MH_Z19_H_
39 #include <stdbool.h>
40 #include <stdint.h>
41 #include <serial.h>
42 
51 typedef enum
52  {
53  MHZ19_OK
54  ,MHZ19_NO_MEASSURING_AVAILABLE
55  ,MHZ19_NO_SERIAL
56  ,MHZ19_PPM_MUST_BE_GT_999
57  } mh_z19_returnCode_t;
58 
59 /* ======================================================================================================================= */
70 void mh_z19_initialise(serial_comPort_t com_port);
71 
72 /* ======================================================================================================================= */
88 void mh_z19_injectCallBack(void(*mh_z19_callBack )(uint16_t));
89 
90 /* ======================================================================================================================= */
101 mh_z19_returnCode_t mh_z19_takeMeassuring(void);
102 
103 /* ======================================================================================================================= */
112 mh_z19_returnCode_t mh_z19_getCo2Ppm(uint16_t *ppm);
113 
114 /* ======================================================================================================================= */
125 mh_z19_returnCode_t mh_z19_setAutoCalibration(bool on);
126 
127 /* ======================================================================================================================= */
136 mh_z19_returnCode_t mh_z19_calibrateZeroPoint(void);
137 
138 /* ======================================================================================================================= */
149 mh_z19_returnCode_t mh_z19_calibrateSpanPoint(uint16_t ppm);
150 
224 #endif /* MH_Z19_H_ */
MHZ19_OK
@ MHZ19_OK
Definition: mh_z19.h:53
MHZ19_NO_MEASSURING_AVAILABLE
@ MHZ19_NO_MEASSURING_AVAILABLE
Definition: mh_z19.h:54
mh_z19_getCo2Ppm
mh_z19_returnCode_t mh_z19_getCo2Ppm(uint16_t *ppm)
Get latest CO2 value.
mh_z19_setAutoCalibration
mh_z19_returnCode_t mh_z19_setAutoCalibration(bool on)
Enable/disable auto calibration of the sensor.
mh_z19_takeMeassuring
mh_z19_returnCode_t mh_z19_takeMeassuring(void)
Perform a new CO2 meassuring.
mh_z19_injectCallBack
void mh_z19_injectCallBack(void(*mh_z19_callBack)(uint16_t))
Inject a call-back function to the driver.
MHZ19_NO_SERIAL
@ MHZ19_NO_SERIAL
Definition: mh_z19.h:55
mh_z19_returnCode_t
mh_z19_returnCode_t
MH-Z19 Driver return codes.
Definition: mh_z19.h:52
MHZ19_PPM_MUST_BE_GT_999
@ MHZ19_PPM_MUST_BE_GT_999
Definition: mh_z19.h:56
mh_z19_calibrateSpanPoint
mh_z19_returnCode_t mh_z19_calibrateSpanPoint(uint16_t ppm)
Span calibration of the sensor.
mh_z19_calibrateZeroPoint
mh_z19_returnCode_t mh_z19_calibrateZeroPoint(void)
Zero calibration of the sensor.
mh_z19_initialise
void mh_z19_initialise(serial_comPort_t com_port)
Initialise the driver.