co2_sensor.cpp 6.28 KB
Newer Older
1
2
3
4
#include "co2_sensor.h"

namespace config {
  // Values should be defined in config.h
Eric Duminil's avatar
Eric Duminil committed
5
6
7
  uint16_t measurement_timestep = MEASUREMENT_TIMESTEP; // [s] Value between 2 and 1800 (range for SCD30 sensor)
  const uint16_t altitude_above_sea_level = ALTITUDE_ABOVE_SEA_LEVEL; // [m]
  uint16_t co2_calibration_level = ATMOSPHERIC_CO2_CONCENTRATION; // [ppm]
8
9
10
#ifdef TEMPERATURE_OFFSET
  // Residual heat from CO2 sensor seems to be high enough to change the temperature reading. How much should it be offset?
  // NOTE: Sign isn't relevant. The returned temperature will always be shifted down.
Eric Duminil's avatar
Eric Duminil committed
11
  const float temperature_offset = TEMPERATURE_OFFSET; // [K]
12
13
14
#else
  const float temperature_offset = -3.0;  // [K] Temperature measured by sensor is usually at least 3K too high.
#endif
Eric Duminil's avatar
Eric Duminil committed
15
  const bool auto_calibrate_sensor = AUTO_CALIBRATE_SENSOR; // [true / false]
16
17
18
19
20
21
22
23
}

namespace sensor {
  SCD30 scd30;
  int16_t co2 = 0;
  float temperature = 0;
  float humidity = 0;
  String timestamp = "";
24
25
26
  int16_t stable_measurements = 0;
  uint32_t waiting_color = color::blue;
  bool should_calibrate = false;
27
28
29
30
31
32

  void initialize() {
#if defined(ESP8266)
    Wire.begin(12, 14);  // ESP8266 - D6, D5;
#endif
#if defined(ESP32)
Eric Duminil's avatar
Eric Duminil committed
33
    Wire.begin(21, 22); // ESP32
34
35
36
37
38
39
40
41
42
43
44
45
46
    /**
     *  SCD30   ESP32
     *  VCC --- 3V3
     *  GND --- GND
     *  SCL --- SCL (GPIO22) //NOTE: GPIO3 Would be more convenient (right next to GND)
     *  SDA --- SDA (GPIO21) //NOTE: GPIO1 would be more convenient (right next to GPO3)
     */
#endif

    // CO2
    if (scd30.begin(config::auto_calibrate_sensor) == false) {
      Serial.println("Air sensor not detected. Please check wiring. Freezing...");
      while (1) {
47
        led_effects::showWaitingLED(color::red);
48
49
50
51
      }
    }

    // SCD30 has its own timer.
Eric Duminil's avatar
Eric Duminil committed
52
    //NOTE: The timer seems to be inaccurate, though, possibly depending on voltage. Should it be offset?
53
54
55
56
    Serial.println();
    Serial.print(F("Setting SCD30 timestep to "));
    Serial.print(config::measurement_timestep);
    Serial.println(" s.");
Eric Duminil's avatar
Eric Duminil committed
57
    scd30.setMeasurementInterval(config::measurement_timestep); // [s]
58

59
    Serial.print(F("Setting temperature offset to -"));
60
61
62
    Serial.print(abs(config::temperature_offset));
    Serial.println(" K.");
    scd30.setTemperatureOffset(abs(config::temperature_offset)); // setTemperatureOffset only accepts positive numbers, but shifts the temperature down.
63
    delay(100);
64

65
    Serial.print(F("Temperature offset is : -"));
66
67
68
    Serial.print(scd30.getTemperatureOffset());
    Serial.println(" K");

69
    Serial.print(F("Auto-calibration is "));
70
71
72
    Serial.println(config::auto_calibrate_sensor ? "ON." : "OFF.");
  }

Eric Duminil's avatar
Eric Duminil committed
73
  //NOTE: should timer deviation be used to adjust measurement_timestep?
Eric Duminil's avatar
Eric Duminil committed
74
  void checkTimerDeviation() {
75
    static int32_t previous_measurement_at = 0;
Eric Duminil's avatar
Eric Duminil committed
76
77
78
79
80
81
82
    int32_t now = millis();
    Serial.print("Measurement time offset : ");
    Serial.print(now - previous_measurement_at - config::measurement_timestep * 1000);
    Serial.println(" ms.");
    previous_measurement_at = now;
  }

83
  void countStableMeasurements() {
Eric Duminil's avatar
Eric Duminil committed
84
    static int16_t previous_co2 = 0;
85
86
    if (co2 > (previous_co2 - 30) && co2 < (previous_co2 + 30)) {
      stable_measurements++;
Eric Duminil's avatar
Eric Duminil committed
87
      Serial.print(F("Number of stable measurements : "));
Eric Duminil's avatar
Eric Duminil committed
88
      Serial.println(stable_measurements);
89
90
91
92
93
      waiting_color = color::green;
    } else {
      stable_measurements = 0;
      waiting_color = color::red;
    }
Eric Duminil's avatar
Eric Duminil committed
94
    previous_co2 = co2;
95
96
97
  }

  void startCalibrationProcess() {
98
99
100
101
    /** From the sensor documentation:
     * For best results, the sensor has to be run in a stable environment in continuous mode at
     * a measurement rate of 2s for at least two minutes before applying the FRC command and sending the reference value.
     */
102
103
104
105
    Serial.println(F("Setting SCD30 timestep to 2s, prior to calibration."));
    scd30.setMeasurementInterval(2); // [s] The change will only take effect after next measurement.
    Serial.println(F("Waiting until the measurements are stable for at least 2 minutes."));
    Serial.println(F("It could take a very long time."));
106
    should_calibrate = true;
107
108
  }

109
110
  void calibrateAndRestart() {
    Serial.print(F("Calibrating SCD30 now..."));
111
112
    scd30.setAltitudeCompensation(config::altitude_above_sea_level);
    scd30.setForcedRecalibrationFactor(config::co2_calibration_level);
113
114
    Serial.println(F(" Done!"));
    Serial.println(F("Sensor calibrated."));
Eric Duminil's avatar
Eric Duminil committed
115
    ESP.restart(); // softer than ESP.reset
116
  }
117

118
  void logToSerial() {
Eric Duminil's avatar
Eric Duminil committed
119
120
    Serial.print(timestamp);
    Serial.print(F(" - co2(ppm): "));
121
122
    Serial.print(co2);
    Serial.print(F(" temp(C): "));
123
    Serial.print(temperature, 1);
124
    Serial.print(F(" humidity(%): "));
125
    Serial.println(humidity, 1);
126
127
128
129
130
  }

  void displayCO2OnLedRing() {
    if (co2 < 250) {
      // Sensor should be calibrated.
131
      led_effects::showWaitingLED(color::magenta);
132
133
134
135
      return;
    }
    /**
     * Display data, even if it's "old" (with breathing).
136
137
     * A short delay is required in order to not overwhelm controller.
     * see https://github.com/esp8266/Arduino/issues/3241#issuecomment-301290392
138
139
     */
    if (co2 < 2000) {
140
      led_effects::displayCO2color(co2);
141
      delay(100);
142
143
    } else {
      // >= 2000: entire ring blinks red
144
      led_effects::redAlert();
145
146
147
    }
  }

Eric Duminil's avatar
Eric Duminil committed
148
  /** Gets fresh data if available, checks calibration status, displays CO2 levels.
149
   * Returns true if fresh data is available, for further processing (e.g. MQTT, CSV or LoRa)
Eric Duminil's avatar
Eric Duminil committed
150
151
152
153
154
155
156
157
158
159
160
   */
  bool processData() {
    bool freshData = scd30.dataAvailable();

    if (freshData) {
      // checkTimerDeviation();
      timestamp = ntp::getLocalTime();
      co2 = scd30.getCO2();
      temperature = scd30.getTemperature();
      humidity = scd30.getHumidity();
    }
161
162

    //NOTE: Data is available, but it's sometimes erroneous: the sensor outputs zero ppm but non-zero temperature and non-zero humidity.
Eric Duminil's avatar
Eric Duminil committed
163
    if (co2 <= 0) {
164
      // No measurement yet. Waiting.
165
      led_effects::showWaitingLED(color::blue);
Eric Duminil's avatar
Eric Duminil committed
166
      return false;
167
168
169
    }

    /**
170
     * Fresh data. Log it and send it if needed.
171
172
     */
    if (freshData) {
Eric Duminil's avatar
Eric Duminil committed
173
174
175
      if (should_calibrate) {
        countStableMeasurements();
      }
176
      logToSerial();
177
178
179
180
181
182
    }

    if (should_calibrate) {
      if (stable_measurements == 60) {
        calibrateAndRestart();
      }
183
      led_effects::showWaitingLED(waiting_color);
Eric Duminil's avatar
Eric Duminil committed
184
      return false;
185
186
    }

187
    displayCO2OnLedRing();
Eric Duminil's avatar
Eric Duminil committed
188
    return freshData;
189
  }
190
}