co2_sensor.cpp 10.4 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]
Eric Duminil's avatar
Eric Duminil committed
8
9
  int8_t max_deviation_during_calibration = 30; // [ppm]
  int8_t enough_stable_measurements = 60;
10
11
12
#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
13
  const float temperature_offset = TEMPERATURE_OFFSET; // [K]
14
15
16
#else
  const float temperature_offset = -3.0;  // [K] Temperature measured by sensor is usually at least 3K too high.
#endif
17
  bool auto_calibrate_sensor = AUTO_CALIBRATE_SENSOR; // [true / false]
18
19
20
21
}

namespace sensor {
  SCD30 scd30;
22
  uint16_t co2 = 0;
23
24
  float temperature = 0;
  float humidity = 0;
25
  char timestamp[23];
26
27
  int16_t stable_measurements = 0;
  uint32_t waiting_color = color::blue;
Käppler's avatar
Käppler committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

  /**
   * Define sensor states
   * INITIAL -> initial state
   * BOOTUP -> state after initializing the sensor, i.e. after scd.begin()
   * READY -> sensor does output valid information (> 0 ppm) and no other condition takes place
   * (NOTE: This state is currently unused)
   * NEEDSCALIBRATION -> sensor measurements are too low (< 250 ppm)
   * PREPARECALIBRATION -> forced calibration was initiated, waiting for stable measurements
   * CALIBRATION -> the sensor does calibrate itself
   */
  enum state {INITIAL, BOOTUP, READY, NEEDSCALIBRATION, PREPARECALIBRATION, CALIBRATION};
  const char *state_names[] = {
    "INITIAL",
    "BOOTUP",
    "READY",
    "NEEDSCALIBRATION",
    "PREPARECALIBRATION",
    "CALIBRATION"
  };
  state current_state = INITIAL;
  void switchState(state);

51
52
53
54
55
  void initialize() {
#if defined(ESP8266)
    Wire.begin(12, 14);  // ESP8266 - D6, D5;
#endif
#if defined(ESP32)
Eric Duminil's avatar
Eric Duminil committed
56
    Wire.begin(21, 22); // ESP32
57
58
59
60
61
62
63
64
65
66
67
    /**
     *  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) {
Eric Duminil's avatar
Eric Duminil committed
68
69
70
      Serial.println(F("ERROR - CO2 sensor not detected. Please check wiring!"));
      led_effects::showKITTWheel(color::red, 30);
      ESP.restart();
71
72
    }

Käppler's avatar
Käppler committed
73
74
    switchState(BOOTUP);

75
    // SCD30 has its own timer.
Eric Duminil's avatar
Eric Duminil committed
76
    //NOTE: The timer seems to be inaccurate, though, possibly depending on voltage. Should it be offset?
77
78
79
80
    Serial.println();
    Serial.print(F("Setting SCD30 timestep to "));
    Serial.print(config::measurement_timestep);
    Serial.println(" s.");
Eric Duminil's avatar
Eric Duminil committed
81
    scd30.setMeasurementInterval(config::measurement_timestep); // [s]
82

83
    Serial.print(F("Setting temperature offset to -"));
84
85
86
    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.
87
    delay(100);
88

89
    Serial.print(F("Temperature offset is : -"));
90
91
92
    Serial.print(scd30.getTemperatureOffset());
    Serial.println(" K");

93
    Serial.print(F("Auto-calibration is "));
94
    Serial.println(config::auto_calibrate_sensor ? "ON." : "OFF.");
95

96
97
98
    sensor_console::defineIntCommand("co2", setCO2forDebugging, F(" 1500 (Sets co2 level, for debugging purposes)"));
    sensor_console::defineIntCommand("timer", setTimer, F(" 30 (Sets measurement interval, in s)"));
    sensor_console::defineCommand("calibrate", startCalibrationProcess, F(" (Starts calibration process)"));
Eric Duminil's avatar
Eric Duminil committed
99
    sensor_console::defineIntCommand("calibrate", calibrateSensorToSpecificPPM,
100
        F(" 600 (Starts calibration process, to given ppm)"));
Eric Duminil's avatar
Eric Duminil committed
101
    sensor_console::defineIntCommand("calibrate!", calibrateSensorRightNow,
102
103
104
        F(" 600 (Calibrates right now, to given ppm)"));
    sensor_console::defineIntCommand("auto_calibrate", setAutoCalibration,
        F(" 0/1 (Disables/enables autocalibration)"));
105
106
  }

Eric Duminil's avatar
Eric Duminil committed
107
  //NOTE: should timer deviation be used to adjust measurement_timestep?
Eric Duminil's avatar
Eric Duminil committed
108
  void checkTimerDeviation() {
109
    static int32_t previous_measurement_at = 0;
Eric Duminil's avatar
Eric Duminil committed
110
    int32_t now = millis();
111
    Serial.print(F("Measurement time offset : "));
Eric Duminil's avatar
Eric Duminil committed
112
113
114
115
116
    Serial.print(now - previous_measurement_at - config::measurement_timestep * 1000);
    Serial.println(" ms.");
    previous_measurement_at = now;
  }

117
  void countStableMeasurements() {
Eric Duminil's avatar
Eric Duminil committed
118
    static int16_t previous_co2 = 0;
Eric Duminil's avatar
Eric Duminil committed
119
120
    if (co2 > (previous_co2 - config::max_deviation_during_calibration)
        && co2 < (previous_co2 + config::max_deviation_during_calibration)) {
121
      stable_measurements++;
Eric Duminil's avatar
Eric Duminil committed
122
      Serial.print(F("Number of stable measurements : "));
Eric Duminil's avatar
Eric Duminil committed
123
      Serial.println(stable_measurements);
124
125
126
127
128
      waiting_color = color::green;
    } else {
      stable_measurements = 0;
      waiting_color = color::red;
    }
Eric Duminil's avatar
Eric Duminil committed
129
    previous_co2 = co2;
130
131
132
  }

  void startCalibrationProcess() {
133
134
135
136
    /** 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.
     */
137
138
139
140
    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."));
Käppler's avatar
Käppler committed
141
    switchState(PREPARECALIBRATION);
142
143
  }

144
  void calibrateAndRestart() {
Käppler's avatar
Käppler committed
145
    switchState(CALIBRATION);
146
    Serial.print(F("Calibrating SCD30 now..."));
147
148
    scd30.setAltitudeCompensation(config::altitude_above_sea_level);
    scd30.setForcedRecalibrationFactor(config::co2_calibration_level);
149
150
    Serial.println(F(" Done!"));
    Serial.println(F("Sensor calibrated."));
Eric Duminil's avatar
Eric Duminil committed
151
    ESP.restart(); // softer than ESP.reset
152
  }
153

154
  void logToSerial() {
Eric Duminil's avatar
Eric Duminil committed
155
156
    Serial.print(timestamp);
    Serial.print(F(" - co2(ppm): "));
157
158
    Serial.print(co2);
    Serial.print(F(" temp(C): "));
159
    Serial.print(temperature, 1);
160
    Serial.print(F(" humidity(%): "));
161
    Serial.println(humidity, 1);
162
163
  }

Käppler's avatar
Käppler committed
164
165
166
167
168
169
170
171
172
  void switchState(state new_state) {
    if (new_state == current_state) return;
    Serial.print(F("Changing sensor state: "));
    Serial.print(state_names[current_state]);
    Serial.print(" -> ");
    Serial.println(state_names[new_state]);
    current_state = new_state;
  }

173
174
175
  void displayCO2OnLedRing() {
    /**
     * Display data, even if it's "old" (with breathing).
Eric Duminil's avatar
Eric Duminil committed
176
     * A short delay is required in order to let background tasks run on the ESP8266.
177
     * see https://github.com/esp8266/Arduino/issues/3241#issuecomment-301290392
178
179
     */
    if (co2 < 2000) {
180
      led_effects::displayCO2color(co2);
181
      delay(100);
182
183
    } else {
      // >= 2000: entire ring blinks red
184
      led_effects::redAlert();
185
186
187
    }
  }

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
  void showState() {
    switch(current_state) {
      case BOOTUP: led_effects::showWaitingLED(color::blue); break;
      // No special signaling, we want to show the CO2 value
      case READY: break;
      case NEEDSCALIBRATION: led_effects::showWaitingLED(color::magenta); break;
      case PREPARECALIBRATION: led_effects::showWaitingLED(waiting_color); break;
      // No special signaling here, too.
      case CALIBRATION: break;
      // This should not happen.
      default:
        Serial.println(F("Encountered unknown sensor state"));
    }
  }

Eric Duminil's avatar
Eric Duminil committed
203
  /** Gets fresh data if available, checks calibration status, displays CO2 levels.
204
   * Returns true if fresh data is available, for further processing (e.g. MQTT, CSV or LoRa)
Eric Duminil's avatar
Eric Duminil committed
205
206
207
208
209
210
   */
  bool processData() {
    bool freshData = scd30.dataAvailable();

    if (freshData) {
      // checkTimerDeviation();
211
      ntp::getLocalTime(timestamp);
Eric Duminil's avatar
Eric Duminil committed
212
213
214
      co2 = scd30.getCO2();
      temperature = scd30.getTemperature();
      humidity = scd30.getHumidity();
215

216
217
218
219
220
221
222
      //NOTE: Data is available, but it's sometimes erroneous: the sensor outputs zero ppm but non-zero temperature and non-zero humidity.
      if (co2 <= 0) {
        // No measurement yet. Waiting.
        switchState(BOOTUP);
      } else if (co2 < 250) {
        // Sensor should be calibrated.
        switchState(NEEDSCALIBRATION);
223
      } else if (current_state == PREPARECALIBRATION) {
Eric Duminil's avatar
Eric Duminil committed
224
        countStableMeasurements();
225
226
227
228
229
        if (stable_measurements == config::enough_stable_measurements) {
          calibrateAndRestart();
        }
      } else {
        switchState(READY);
Eric Duminil's avatar
Eric Duminil committed
230
      }
231

232
233
      // Log every time fresh data is available.
      logToSerial();
234
235
    }

236
237
238
239
240
    // We need to show LED effects for "old" data, too, as long as we get new data.
    if (current_state == READY) {
      displayCO2OnLedRing();
    } else {
      showState();
241
242
    }

Eric Duminil's avatar
Eric Duminil committed
243
    return freshData;
244
  }
245
246
247
248
249
250
251
252
253
254

  /*****************************************************************
   * Callbacks for sensor commands                                 *
   *****************************************************************/
  void setCO2forDebugging(int32_t fakeCo2) {
    Serial.print(F("DEBUG. Setting CO2 to "));
    co2 = fakeCo2;
    Serial.println(co2);
  }

255
256
257
258
259
260
261
  void setAutoCalibration(int32_t autoCalibration) {
    config::auto_calibrate_sensor = autoCalibration;
    scd30.setAutoSelfCalibration(autoCalibration);
    Serial.print(F("Setting auto-calibration to : "));
    Serial.println(autoCalibration ? F("On.") : F("Off."));
  }

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
  void setTimer(int32_t timestep) {
    if (timestep >= 2 && timestep <= 1800) {
      Serial.print(F("Setting Measurement Interval to : "));
      Serial.print(timestep);
      Serial.println("s.");
      sensor::scd30.setMeasurementInterval(timestep);
      config::measurement_timestep = timestep;
      led_effects::showKITTWheel(color::green, 1);
    }
  }

  void calibrateSensorToSpecificPPM(int32_t calibrationLevel) {
    if (calibrationLevel >= 400 && calibrationLevel <= 2000) {
      Serial.print(F("Force calibration, at "));
      config::co2_calibration_level = calibrationLevel;
      Serial.print(config::co2_calibration_level);
      Serial.println(" ppm.");
      sensor::startCalibrationProcess();
    }
  }

  void calibrateSensorRightNow(int32_t calibrationLevel) {
    stable_measurements = config::enough_stable_measurements;
    calibrateSensorToSpecificPPM(calibrationLevel);
  }
287
}