co2_sensor.cpp 11.7 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
  uint16_t measurement_timestep = MEASUREMENT_TIMESTEP; // [s] Value between 2 and 1800 (range for SCD30 sensor)
6
  const uint16_t measurement_timestep_bootup = 2; // [s] Measurement timestep during acclimatization
Eric Duminil's avatar
Eric Duminil committed
7
8
  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
9
10
  int8_t max_deviation_during_calibration = 30; // [ppm]
  int8_t enough_stable_measurements = 60;
11
  const uint8_t max_deviation_during_bootup = 20; // [%]
12
13
14
#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
15
  const float temperature_offset = TEMPERATURE_OFFSET; // [K]
16
17
18
#else
  const float temperature_offset = -3.0;  // [K] Temperature measured by sensor is usually at least 3K too high.
#endif
19
  bool auto_calibrate_sensor = AUTO_CALIBRATE_SENSOR; // [true / false]
20
  const bool debug_sensor_states = false; // If true, log state transitions over serial console
21
22
23
24
}

namespace sensor {
  SCD30 scd30;
25
  uint16_t co2 = 0;
26
27
  float temperature = 0;
  float humidity = 0;
28
  char timestamp[23];
29
  int16_t stable_measurements = 0;
Käppler's avatar
Käppler committed
30
31
32

  /**
   * Define sensor states
33
   * BOOTUP -> initial state, until first >0 ppm values are returned
Käppler's avatar
Käppler committed
34
   * READY -> sensor does output valid information (> 0 ppm) and no other condition takes place
Eric Duminil's avatar
Eric Duminil committed
35
   * NEEDS_CALIBRATION -> sensor measurements are too low (< 250 ppm)
36
37
   * PREPARE_CALIBRATION_UNSTABLE -> forced calibration was initiated, last measurements were too far apart
   * PREPARE_CALIBRATION_STABLE -> forced calibration was initiated, last measurements were close to each others
Käppler's avatar
Käppler committed
38
   */
39
40
41
  enum state {
    BOOTUP,
    READY,
42
    NEEDS_CALIBRATION,
43
    PREPARE_CALIBRATION_UNSTABLE,
44
    PREPARE_CALIBRATION_STABLE
Käppler's avatar
Käppler committed
45
  };
46
47
48
  const char *state_names[] = {
      "BOOTUP",
      "READY",
49
      "NEEDS_CALIBRATION",
50
      "PREPARE_CALIBRATION_UNSTABLE",
51
      "PREPARE_CALIBRATION_STABLE" };
52
53

  state current_state = BOOTUP;
Käppler's avatar
Käppler committed
54
55
  void switchState(state);

56
57
  void initialize() {
#if defined(ESP8266)
58
    Wire.begin(12, 14); // ESP8266 - D6, D5;
59
60
#endif
#if defined(ESP32)
Eric Duminil's avatar
Eric Duminil committed
61
    Wire.begin(21, 22); // ESP32
62
63
64
65
66
67
68
69
    /**
     *  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
70
71
    Serial.println();
    scd30.enableDebugging(); // Prints firmware version in the console.
72

73
    if (!scd30.begin(config::auto_calibrate_sensor)) {
Eric Duminil's avatar
Eric Duminil committed
74
75
76
      Serial.println(F("ERROR - CO2 sensor not detected. Please check wiring!"));
      led_effects::showKITTWheel(color::red, 30);
      ESP.restart();
77
78
    }

79
80
81
82
83
    // Changes of the SCD30's measurement timestep do not come into effect
    // before the next measurement takes place. That means that after a hard reset
    // of the ESP the SCD30 sometimes needs a long time until switching back to 2 s
    // for acclimatization. Resetting it after startup seems to fix this behaviour.
    scd30.reset();
Käppler's avatar
Käppler committed
84

85
    Serial.print(F("Setting temperature offset to -"));
86
    Serial.print(abs(config::temperature_offset));
Eric Duminil's avatar
Eric Duminil committed
87
    Serial.println(F(" K."));
88
    scd30.setTemperatureOffset(abs(config::temperature_offset)); // setTemperatureOffset only accepts positive numbers, but shifts the temperature down.
89
    delay(100);
90

91
    Serial.print(F("Temperature offset is : -"));
92
    Serial.print(scd30.getTemperatureOffset());
Eric Duminil's avatar
Eric Duminil committed
93
    Serial.println(F(" K"));
94

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

98
99
100
101
    // SCD30 has its own timer.
    //NOTE: The timer seems to be inaccurate, though, possibly depending on voltage. Should it be offset?
    Serial.println();
    Serial.print(F("Setting SCD30 timestep to "));
102
    Serial.print(config::measurement_timestep_bootup);
Eric Duminil's avatar
Eric Duminil committed
103
    Serial.println(F(" s during acclimatization."));
104
    scd30.setMeasurementInterval(config::measurement_timestep_bootup); // [s]
105

106
107
108
    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
109
    sensor_console::defineIntCommand("calibrate", calibrateSensorToSpecificPPM,
110
        F(" 600 (Starts calibration process, to given ppm)"));
Eric Duminil's avatar
Eric Duminil committed
111
    sensor_console::defineIntCommand("calibrate!", calibrateSensorRightNow,
112
113
114
        F(" 600 (Calibrates right now, to given ppm)"));
    sensor_console::defineIntCommand("auto_calibrate", setAutoCalibration,
        F(" 0/1 (Disables/enables autocalibration)"));
115
116
  }

117
118
119
120
121
122
123
  bool hasSensorSettled() {
    static uint16_t last_co2 = 0;
    uint16_t delta;
    delta = abs(co2 - last_co2);
    last_co2 = co2;
    // We assume the sensor has acclimated to the environment if measurements
    // change less than a specified percentage of the current value.
Eric Duminil's avatar
Eric Duminil committed
124
    return (co2 > 0 && delta < ((uint32_t) co2 * config::max_deviation_during_bootup / 100));
125
126
  }

127
128
  bool countStableMeasurements() {
    // Returns true, if a sufficient number of stable measurements has been observed.
Eric Duminil's avatar
Eric Duminil committed
129
    static int16_t previous_co2 = 0;
Eric Duminil's avatar
Eric Duminil committed
130
131
    if (co2 > (previous_co2 - config::max_deviation_during_calibration)
        && co2 < (previous_co2 + config::max_deviation_during_calibration)) {
132
      stable_measurements++;
Eric Duminil's avatar
Eric Duminil committed
133
      Serial.print(F("Number of stable measurements : "));
Eric Duminil's avatar
Eric Duminil committed
134
      Serial.println(stable_measurements);
135
      switchState(PREPARE_CALIBRATION_STABLE);
136
137
    } else {
      stable_measurements = 0;
138
      switchState(PREPARE_CALIBRATION_UNSTABLE);
139
    }
Eric Duminil's avatar
Eric Duminil committed
140
    previous_co2 = co2;
141
    return (stable_measurements == config::enough_stable_measurements);
142
143
144
  }

  void startCalibrationProcess() {
145
146
147
148
    /** 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.
     */
149
150
151
152
    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."));
153
    switchState(PREPARE_CALIBRATION_UNSTABLE);
154
155
  }

156
157
  void calibrateAndRestart() {
    Serial.print(F("Calibrating SCD30 now..."));
158
159
    scd30.setAltitudeCompensation(config::altitude_above_sea_level);
    scd30.setForcedRecalibrationFactor(config::co2_calibration_level);
160
161
    Serial.println(F(" Done!"));
    Serial.println(F("Sensor calibrated."));
Eric Duminil's avatar
Eric Duminil committed
162
    ESP.restart(); // softer than ESP.reset
163
  }
164

165
  void logToSerial() {
Eric Duminil's avatar
Eric Duminil committed
166
167
    Serial.print(timestamp);
    Serial.print(F(" - co2(ppm): "));
168
169
    Serial.print(co2);
    Serial.print(F(" temp(C): "));
170
    Serial.print(temperature, 1);
171
    Serial.print(F(" humidity(%): "));
172
    Serial.println(humidity, 1);
173
174
  }

Käppler's avatar
Käppler committed
175
  void switchState(state new_state) {
176
177
178
    if (new_state == current_state) {
      return;
    }
179
180
181
    if (config::debug_sensor_states) {
      Serial.print(F("Changing sensor state: "));
      Serial.print(state_names[current_state]);
Eric Duminil's avatar
Eric Duminil committed
182
      Serial.print(F(" -> "));
183
184
      Serial.println(state_names[new_state]);
    }
Käppler's avatar
Käppler committed
185
186
187
    current_state = new_state;
  }

188
  void switchStateForCurrentPPM() {
189
    if (current_state == BOOTUP) {
Eric Duminil's avatar
Eric Duminil committed
190
191
192
      if (!hasSensorSettled()) {
        return;
      }
193
194
195
196
      switchState(READY);
      Serial.println(F("Sensor acclimatization finished."));
      Serial.print(F("Setting SCD30 timestep to "));
      Serial.print(config::measurement_timestep);
Eric Duminil's avatar
Eric Duminil committed
197
      Serial.println(F(" s."));
198
199
      scd30.setMeasurementInterval(config::measurement_timestep); // [s]
    }
Käppler's avatar
Käppler committed
200
    if ((current_state == PREPARE_CALIBRATION_UNSTABLE) || (current_state == PREPARE_CALIBRATION_STABLE)) {
201
202
203
204
205
206
207
208
209
210
211
212
213
214
      // Check for pre-calibration states first, because we do not want to
      // leave them before calibration is done.
      bool ready_for_calibration = countStableMeasurements();
      if (ready_for_calibration) {
        calibrateAndRestart();
      }
    } else if (co2 < 250) {
      // Sensor should be calibrated.
      switchState(NEEDS_CALIBRATION);
    } else {
      switchState(READY);
    }
  }

215
216
217
  void displayCO2OnLedRing() {
    /**
     * Display data, even if it's "old" (with breathing).
Eric Duminil's avatar
Eric Duminil committed
218
     * A short delay is required in order to let background tasks run on the ESP8266.
219
     * see https://github.com/esp8266/Arduino/issues/3241#issuecomment-301290392
220
221
     */
    if (co2 < 2000) {
222
      led_effects::displayCO2color(co2);
223
      delay(100);
224
225
    } else {
      // >= 2000: entire ring blinks red
226
      led_effects::redAlert();
227
228
229
    }
  }

230
  void showState() {
231
232
233
234
235
    switch (current_state) {
    case BOOTUP:
      led_effects::showWaitingLED(color::blue);
      break;
    case READY:
236
      displayCO2OnLedRing();
237
      break;
238
    case NEEDS_CALIBRATION:
239
240
      led_effects::showWaitingLED(color::magenta);
      break;
241
    case PREPARE_CALIBRATION_UNSTABLE:
242
243
      led_effects::showWaitingLED(color::red);
      break;
244
    case PREPARE_CALIBRATION_STABLE:
245
246
247
      led_effects::showWaitingLED(color::green);
      break;
    default:
Eric Duminil's avatar
Eric Duminil committed
248
      Serial.println(F("Encountered unknown sensor state")); // This should not happen.
249
250
251
    }
  }

Eric Duminil's avatar
Eric Duminil committed
252
  /** Gets fresh data if available, checks calibration status, displays CO2 levels.
253
   * Returns true if fresh data is available, for further processing (e.g. MQTT, CSV or LoRa)
Eric Duminil's avatar
Eric Duminil committed
254
255
256
257
258
   */
  bool processData() {
    bool freshData = scd30.dataAvailable();

    if (freshData) {
259
      ntp::getLocalTime(timestamp);
Eric Duminil's avatar
Eric Duminil committed
260
261
262
      co2 = scd30.getCO2();
      temperature = scd30.getTemperature();
      humidity = scd30.getHumidity();
263

264
      switchStateForCurrentPPM();
265

266
267
      // Log every time fresh data is available.
      logToSerial();
268
269
    }

270
    showState();
271

272
273
274
    // Report data for further processing only if the data is reliable
    // (state 'READY') or manual calibration is necessary (state 'NEEDS_CALIBRATION').
    return freshData && (current_state == READY || current_state == NEEDS_CALIBRATION);
275
  }
276
277
278
279
280
281
282
283

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

287
288
289
290
291
292
293
  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."));
  }

294
295
296
297
  void setTimer(int32_t timestep) {
    if (timestep >= 2 && timestep <= 1800) {
      Serial.print(F("Setting Measurement Interval to : "));
      Serial.print(timestep);
Eric Duminil's avatar
Eric Duminil committed
298
      Serial.println(F("s."));
299
300
301
302
303
304
305
306
307
308
309
      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);
Eric Duminil's avatar
Eric Duminil committed
310
      Serial.println(F(" ppm."));
311
312
313
314
315
316
317
318
      sensor::startCalibrationProcess();
    }
  }

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