Sensors subproject integrated, not tested

- still missing a command to confirm / swap auto-assigned sensor ids

Author: oliver-reinhard

bc_setup.h

@@ -1,8 +1,8 @@
-#ifndef BOILER_BC_SETUP_H_INCLUDED
-  #define BOILER_BC_SETUP_H_INCLUDED
+#ifndef BC_SETUP_H_INCLUDED
+  #define BC_SETUP_H_INCLUDED
 
-  // Uncomment ONE (!) of the following lines:
-     #define UNIT_TEST
+  // Uncomment AT MOST ONE (!) of the following lines:
+    // #define UNIT_TEST
     // #define BLE_UI
     // #define SERIAL_UI
 

boiler_controller.ino

@@ -1,7 +1,4 @@
 #include "bc_setup.h"
-#ifdef UNIT_TEST
-  #include <ArduinoUnit.h>
-#endif
 #include "math.h"
 #include "control.h"
 #include "state.h"
@@ -10,6 +7,8 @@
   #include "ui_ser.h"
 #elif defined BLE_UI
   #include "ui_ble.h"
+#elif defined UNIT_TEST
+  #include <ArduinoUnit.h>
 #endif
 
 //#define DEBUG_MAIN
@@ -31,9 +30,13 @@ typedef enum {
 /*
  * GLOBALS
  */
-ConfigParams config = ConfigParams();
-Log logger = Log(sizeof(ConfigParams)); 
+ConfigParams configParams = ConfigParams();
+Log logger = Log(configParams.eepromSize()); 
 OperationalParams opParams;
+DS18B20TemperatureSensor *sensors[] = {&opParams.water, &opParams.ambient};
+OneWire oneWire = OneWire(ONE_WIRE_PIN);  // on pin 10 (a 4.7K pull-up resistor to +5V is necessary)
+DS18B20Controller controller = DS18B20Controller(&oneWire, sensors, 2);
+
 ExecutionContext context;
 ControlActions controlActions = ControlActions(&context);
 BoilerStateAutomaton automaton = BoilerStateAutomaton(&context);
@@ -60,11 +63,12 @@ void setup() {
   #else
     logger.init();
     logger.logMessage(MSG_SYSTEM_INIT, 0, 0);
-    config.load(); 
+    configParams.load(); 
 
     context.log = &logger;
-    context.config = &config;
+    context.config = &configParams;
     context.op = &opParams;
+    context.controller = &controller;
     context.control = &controlActions;
 
     pinMode(HEATER_PIN, OUTPUT);

config.h

@@ -1,24 +1,8 @@
-#ifndef BOILER_CONFIG_H_INCLUDED
-  #define BOILER_CONFIG_H_INCLUDED
+#ifndef BC_CONFIG_H_INCLUDED
+  #define BC_CONFIG_H_INCLUDED
 
   #include "config/Configuration.h"
-
-  /*
-  typedef int16_t Temperature;  // [°C * 100]
-  #define UNDEFINED_TEMPERATURE -10000 // [°C * 100];
-
-  #define TEMP_SENSOR_ID_BYTES 8
-  typedef uint8_t TempSensorID[TEMP_SENSOR_ID_BYTES];
-  const TempSensorID UNDEFINED_SENSOR_ID = {0,0,0,0,0,0,0,0};
-
-  */
-  // Water min and max values used to check that sensor-temperature readout is plausible:
-  #define WATER_MIN_TEMP -2000 // [°C * 100]
-  #define WATER_MAX_TEMP 10000 // [°C * 100]
-  
-  // Water min and max values used to check that ambient-temperature readout is plausible:
-  #define AMBIENT_MIN_TEMP -3000 // [°C * 100]
-  #define AMBIENT_MAX_TEMP 5000 // [°C * 100]
+  #include "sensors/OneWireSensors.h"
 
   /*
    * ID values are defined by ConfigParamEnum.

control.cpp

@@ -11,106 +11,52 @@ uint32_t heatingTotalMillis(OperationalParams *op) {
   return duration;
 }
 
-boolean undefinedSensorId(TempSensorID addr) {
-  return ! memcmp(addr, UNDEFINED_SENSOR_ID, TEMP_SENSOR_ID_BYTES);
-}
-
-boolean isWaterSensor(TempSensorID addr, ConfigParams *config) {
-  return ! memcmp(addr, config->waterTempSensorId, TEMP_SENSOR_ID_BYTES);
-}
-
-boolean isAmbientSensor(TempSensorID addr, ConfigParams *config) {
-  return ! memcmp(addr, config->ambientTempSensorId, TEMP_SENSOR_ID_BYTES);
-}
 
-
-
-void ControlActions::setupSensors() {
-  if (undefinedSensorId(context->config->waterTempSensorId)) {
-   context->op->water.sensorStatus = SENSOR_ID_UNDEFINED;
+uint8_t ControlActions::setupSensors() {
+  context->op->water.setId(context->config->waterTempSensorId);
+  context->op->water.rangeMin = WATER_MIN_TEMP;
+  context->op->water.rangeMax = WATER_MAX_TEMP;
+  
+  context->op->ambient.setId(context->config->ambientTempSensorId);
+  context->op->ambient.rangeMin = AMBIENT_MIN_TEMP;
+  context->op->ambient.rangeMax = AMBIENT_MAX_TEMP;
+  
+  uint8_t matched = context->controller->setupSensors();
+  
+  if (context->op->water.sensorStatus == SENSOR_ID_UNDEFINED) {
    context->log->logMessage(MSG_WATER_TEMP_SENSOR_ID_UNDEF, 0, 0); 
    #ifdef DEBUG_CONTROL
      Serial.println(F("DEBUG_CONTROL: Water temp sensor ID undefined"));
    #endif
+  } else if (context->op->water.sensorStatus == SENSOR_ID_AUTO_ASSIGNED) {
+   context->log->logMessage(MSG_WATER_TEMP_SENSOR_ID_AUTO, 0, 0); 
+   #ifdef DEBUG_CONTROL
+     Serial.println(F("DEBUG_CONTROL: Water temp sensor ID assigned automatically."));
+   #endif
   }
 
-  if (undefinedSensorId(context->config->ambientTempSensorId)) {
-   context->op->ambient.sensorStatus = SENSOR_ID_UNDEFINED;
-   context->log->logMessage(MSG_AMBIENT_TEMP_SENSOR_ID_UNDEF, 0, 0);
+  if (context->op->ambient.sensorStatus == SENSOR_ID_UNDEFINED) {
+   context->log->logMessage(MSG_AMBIENT_TEMP_SENSOR_ID_UNDEF, 0, 0); 
    #ifdef DEBUG_CONTROL
      Serial.println(F("DEBUG_CONTROL: Ambient temp sensor ID undefined"));
    #endif
-  } 
+  } else if (context->op->ambient.sensorStatus == SENSOR_ID_AUTO_ASSIGNED) {
+   context->log->logMessage(MSG_AMBIENT_TEMP_SENSOR_ID_AUTO, 0, 0); 
+   #ifdef DEBUG_CONTROL
+     Serial.println(F("DEBUG_CONTROL: Ambient temp sensor ID assigned automatically."));
+   #endif
+  }
 
-  //
-  // CONSIDER: set sensor resolution
-  // CONSIDER: detect sensors and store IDs for user to choose which sensor is which
+  return matched;
 }
 
 void ControlActions::initSensorReadout() {
-  oneWire.reset();
-  // Talk to all slaves on bus:
-  oneWire.skip();
-  // Start temp readout and conversion to scratchpad, with parasite power on at the end
-  oneWire.write(CMD_CONVERT_TEMP, 1);
-  //
-  // Important: do not oneWire.reset() now for at least 750 ms (for 12-bit temperature resolution)
-  //
+  context->controller->initSensorReadout();
 }
 
 
 void ControlActions::completeSensorReadout() {
-  context->op->water.sensorStatus   = SENSOR_NOK;
-  context->op->water.currentTemp    = UNDEFINED_TEMPERATURE;
-  context->op->ambient.sensorStatus = SENSOR_NOK;
-  context->op->ambient.currentTemp  = UNDEFINED_TEMPERATURE;
-  
-  uint8_t addr[TEMP_SENSOR_ID_BYTES];
-  
-  while(oneWire.search(addr)) {  
-    if (OneWire::crc8(addr, TEMP_SENSOR_ID_BYTES-1) != addr[TEMP_SENSOR_ID_BYTES-1]) {
-      continue;
-    }
-    
-    uint8_t data[TEMP_SENSOR_READOUT_BYTES];
-    if (! readScratchpad(addr, &data[0])) {
-      continue;
-    }
-    TemperatureReadout readout = getCelcius(data);
-    
-    if (isWaterSensor(addr, context->config)) {
-      // Ensure temperature is plausible:
-      if( readout.celcius >= WATER_MIN_TEMP && readout.celcius <= WATER_MAX_TEMP) {
-         context->op->water.sensorStatus = SENSOR_OK;
-         context->op->water.currentTemp  = readout.celcius;
-         #ifdef DEBUG_CONTROL
-           Serial.print(F("DEBUG_CONTROL: Water: Sensor OK, temp: "));
-           Serial.println(readout.celcius);
-         #endif
-      } 
-      #ifdef DEBUG_CONTROL
-        else {
-          Serial.println(F("DEBUG_CONTROL: Water: Sensor NOK"));
-        }
-      #endif
-    } else if (isAmbientSensor(addr, context->config)) {
-      // Ensure temperature is plausible:
-      if( readout.celcius >= AMBIENT_MIN_TEMP && readout.celcius <= AMBIENT_MAX_TEMP) {
-         context->op->ambient.sensorStatus = SENSOR_OK;
-         context->op->ambient.currentTemp  = readout.celcius;
-         #ifdef DEBUG_CONTROL
-           Serial.print("DEBUG_CONTROL: Ambient: Sensor OK, temp: "));
-           Serial.println(readout.celcius);
-         #endif
-      }
-      #ifdef DEBUG_CONTROL
-        else {
-          Serial.println(F("DEBUG_CONTROL: Ambient: Sensor NOK"));
-        }
-      #endif
-    }
-  }
-  oneWire.reset_search();
+  context->controller->completeSensorReadout();
 }
 
 void ControlActions::heat(boolean on) {

control.h

@@ -1,19 +1,28 @@
-#ifndef BOILER_CONTROL_H_INCLUDED
-  #define BOILER_CONTROL_H_INCLUDED
+#ifndef BC_CONTROL_H_INCLUDED
+  #define BC_CONTROL_H_INCLUDED
 
   #include "bc_setup.h"
-  #include <OneWire.h>
   #include "config.h"
   #include "log.h"
 
   #define HEATER_PIN   9
   #define ONE_WIRE_PIN 10 // Temperature sensors
 
   typedef enum {
-    MSG_WATER_TEMP_SENSOR_ID_UNDEF = 20,  // Sensor ID of water-temperature sensor has not been configured. Configure and restart.
-    MSG_AMBIENT_TEMP_SENSOR_ID_UNDEF = 21  // Sensor ID of ambient-temperature sensor has not been configured. Configure and restart.
+    MSG_WATER_TEMP_SENSOR_ID_UNDEF = 20,   // Sensor ID of water-temperature sensor could not be obtained. Check wiring and sensor, then restart.
+    MSG_WATER_TEMP_SENSOR_ID_AUTO =  21,   // Sensor ID of water-temperature sensor was assigned automatically. Confirm that it refers to the correct sensor, then restart.
+    MSG_AMBIENT_TEMP_SENSOR_ID_UNDEF = 22, // Sensor ID of ambient-temperature sensor could not be obtained. Check wiring and sensor, then restart.
+    MSG_AMBIENT_TEMP_SENSOR_ID_AUTO =  23  // Sensor ID of ambient-temperature sensor was assigned automatically. Confirm that it refers to the correct sensor, then restart.
   } ControlMessageEnum;
 
+
+  // Water min and max values used to check that sensor-temperature readout is plausible:
+  #define WATER_MIN_TEMP -2000 // [°C * 100]
+  #define WATER_MAX_TEMP 10000 // [°C * 100]
+  
+  // Water min and max values used to check that ambient-temperature readout is plausible:
+  #define AMBIENT_MIN_TEMP -3000 // [°C * 100]
+  #define AMBIENT_MAX_TEMP 5000 // [°C * 100]
 
   #define CMD_ARG_BUF_SIZE 30   // Size of the read buffer for incoming data
 
@@ -48,22 +57,6 @@
   // bitwise OR combination ("|") of ReadWriteRequestEnum(s)
   typedef uint8_t ReadWriteRequests;
 
-  typedef enum {
-    SENSOR_INITIALISING = 0,
-    SENSOR_OK = 1,
-    SENSOR_NOK = 2,
-    SENSOR_ID_UNDEFINED = 3
-  } SensorStatusEnum;
-
-  typedef uint8_t SensorStatusID;
-  
-  struct TemperatureSensor {
-    SensorStatusEnum sensorStatus = SENSOR_INITIALISING;
-    Temperature currentTemp = UNDEFINED_TEMPERATURE;
-    Temperature lastLoggedTemp = UNDEFINED_TEMPERATURE;
-    uint32_t lastLoggedTime = 0L;
-  };
-
   struct UserCommand {
     UserCommandEnum command = CMD_NONE;
     char args[CMD_ARG_BUF_SIZE]; // always '\0' terminated
@@ -72,8 +65,8 @@
   struct OperationalParams {
     // timepoint [ms] of most recent transition to current state:
     uint32_t currentStateStartMillis = 0L;
-    TemperatureSensor water;
-    TemperatureSensor ambient;
+    DS18B20TemperatureSensor water = DS18B20TemperatureSensor("Water");
+    DS18B20TemperatureSensor ambient = DS18B20TemperatureSensor("Ambient");
     UserCommand *command;
     boolean heating = false;
     // time [ms] of most recent transition to state HEATING:
@@ -93,6 +86,7 @@
       Log *log;
       ConfigParams *config;
       OperationalParams *op;
+      DS18B20Controller *controller;
   };
 
   /*
@@ -105,7 +99,7 @@
       ControlActions(ControlContext *context) {
         this->context = context;
       }
-      virtual void setupSensors();
+      virtual uint8_t setupSensors();
       virtual void initSensorReadout();
       virtual void completeSensorReadout();
 
@@ -124,7 +118,6 @@
 
     protected:
       ControlContext *context;
-      OneWire oneWire = OneWire(ONE_WIRE_PIN);  // on pin 10 (a 4.7K pull-up resistor to +5V is necessary)
       ReadWriteRequests pendingRequests = READ_WRITE_NONE;
   };
 

log.h

@@ -1,5 +1,5 @@
-#ifndef BOILER_LOG_H_INCLUDED
-  #define BOILER_LOG_H_INCLUDED
+#ifndef BC_LOG_H_INCLUDED
+  #define BC_LOG_H_INCLUDED
 
   #include "config.h"
   #include "log/Logging.h"

sensor/sensors/OneWireSensors.cpp renamed to sensors/OneWireSensors.cpp

@@ -17,10 +17,6 @@
  */
 #define DATA_CONFIG_BYTE  4
 
-boolean isUndefinedTempSensorID(TempSensorID addr) {
-  return ! memcmp(addr, UNDEFINED_SENSOR_ID, TEMP_SENSOR_ID_BYTES);
-}
-
 uint8_t DS18B20Controller::setupSensors() {
   for(uint8_t i=0; i<numSensors; i++) {
     if(sensors[i]->idUndefined()) {

sensor/sensors/OneWireSensors.h renamed to sensors/OneWireSensors.h

@@ -10,8 +10,6 @@
   #define TEMP_SENSOR_ID_BYTES 8
   typedef uint8_t TempSensorID[TEMP_SENSOR_ID_BYTES];
   const TempSensorID UNDEFINED_SENSOR_ID = {0,0,0,0,0,0,0,0};
-
-  boolean isUndefinedTempSensorID(TempSensorID addr);
 
   /*
    * Number of bytes of data vector returned by the DS18B20: 8 byte data + 1 byte CRC
@@ -67,6 +65,13 @@
        * Returns true if the ID of this sensor is UNDEFINED_SENSOR_ID, i.e. this object does represent a physical sensor.
        */
       boolean idUndefined() {
+        return idUndefined(this->id);
+      }
+
+      /*
+       * Returns true if the given is UNDEFINED_SENSOR_ID.
+       */
+      static boolean idUndefined(const TempSensorID id) {
         return ! memcmp(id, UNDEFINED_SENSOR_ID, TEMP_SENSOR_ID_BYTES);
       }
   };

sensor/sensors/sensors.ino renamed to sensors/sensors.ino

@@ -69,11 +69,17 @@ test(a_sensor_setup) {
     oneWire._setSearchResults((uint8_t *) SENSOR_IDS, 2);
   #endif
   uint8_t matched = controller.setupSensors();
+  #ifndef MOCK_ONE_WIRE
+    if (matched < 2) }
+      Serial.println(F("Cannot access one or more physical sensors -> check wiring."));
+    }
+  #endif
   assertEqual(matched, 2);
   assertEqual(s1.sensorStatus, SENSOR_ID_AUTO_ASSIGNED);
   assertEqual(s2.sensorStatus, SENSOR_ID_AUTO_ASSIGNED);
   assertEqual(s3.sensorStatus, SENSOR_ID_UNDEFINED);
   #ifdef MOCK_ONE_WIRE
+    // check that the sensor IDs were "recognized" (mocking) correctly:
     assertTrue(! memcmp(s1.id, SENSOR_IDS[0], TEMP_SENSOR_ID_BYTES));
     assertTrue(! memcmp(s2.id, SENSOR_IDS[1], TEMP_SENSOR_ID_BYTES));
   #else