From c08a323952b1be4e44d3532e4ead910c0da3b30c Mon Sep 17 00:00:00 2001 From: smueller Date: Wed, 15 May 2024 16:16:01 +0200 Subject: [PATCH] add warning to conditioning add warning to: - Readme - Example Usage - Function description Closes #5 --- README.md | 8 ++++++++ examples/exampleUsage/exampleUsage.ino | 3 ++- src/SensirionI2CSgp41.h | 2 ++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a37446..40f91e7 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,14 @@ Note: Installation via the Arduino Library Manager is coming soon. Plotter` via the `Tools` menu to observe the measurement values. Note that the `Baud Rate` in the corresponding window has to be set to `115200 baud`. +# Conditioning + +After each restart of the sensor or when the hotplates have been switched off, the conditioning command must +be called from idle mode. The conditioning heats the hotplate of the NOx pixel to a different temperature compared +to the measurement mode enabling a faster switch-on thereafter. + +It is recommended to execute the conditioning for 10s, but **10s must not be exceeded** to avoid damage to the sensing material. + # Contributing **Contributions are welcome!** diff --git a/examples/exampleUsage/exampleUsage.ino b/examples/exampleUsage/exampleUsage.ino index f49a8ca..00fbd17 100644 --- a/examples/exampleUsage/exampleUsage.ino +++ b/examples/exampleUsage/exampleUsage.ino @@ -40,7 +40,8 @@ SensirionI2CSgp41 sgp41; -// time in seconds needed for NOx conditioning +// Time in seconds needed for NOx conditioning +// WARNING: To avoid damage to the sensing material the conditioning must not exceed 10s! uint16_t conditioning_s = 10; void setup() { diff --git a/src/SensirionI2CSgp41.h b/src/SensirionI2CSgp41.h index 5915ef4..c4ffbf5 100644 --- a/src/SensirionI2CSgp41.h +++ b/src/SensirionI2CSgp41.h @@ -61,6 +61,8 @@ class SensirionI2CSgp41 { * the sgp41_measure_raw command while the NOx pixel will be operated at a * different temperature for conditioning. This command returns only the * measured raw signal of the VOC pixel SRAW_VOC as 2 bytes (+ 1 CRC byte). + * + * WARNING: To avoid damage to the sensing material the conditioning must not exceed 10s! * * @param defaultRh Default conditions for relative humidty. *