Serial UI enhance, running

- added new modifiers “swap”, “clr" and “ack” to “set config” for temp
sensor ids.
- serial UI adapted, manual test (cmd line) ok

Author: oliver-reinhard

bc_setup.h

@@ -4,7 +4,7 @@
   // Uncomment AT MOST ONE (!) of the following lines:
     // #define UNIT_TEST
     // #define BLE_UI
-    // #define SERIAL_UI
+     #define SERIAL_UI
 
   #ifdef UNIT_TEST
     // Comment the following line to prevent execution of STATE tests:

boiler_controller.ino

@@ -187,7 +187,7 @@ void logTemperatureValues(ControlContext *context) {
       }
 
       if (logValuesNow) {
-        Flags flags = context->op->water.sensorStatus<<4 | context->op->ambient.sensorStatus;
+        Flags flags = (context->op->water.sensorStatus<<4) | (context->op->ambient.sensorStatus);
         context->log->logValues(context->op->water.currentTemp, context->op->ambient.currentTemp, flags);
         context->op->water.lastLoggedTemp = water;
         context->op->water.lastLoggedTime = time;

config.cpp

@@ -1,5 +1,11 @@
 #include "config.h"
 
+
+void ConfigParams::setTempSensorIDs(TempSensorID water, TempSensorID ambient) {
+  memcpy(this->waterTempSensorId, water, TEMP_SENSOR_ID_BYTES);
+  memcpy(this->ambientTempSensorId, ambient, TEMP_SENSOR_ID_BYTES);
+}
+
 void ConfigParams::initParams(boolean &updated) {
   updated = false;
 

config.h

@@ -52,9 +52,13 @@
       float heaterPower;  // [Watts]
       float insulationFactor; // correction factor to model tank insulation charactericstis
       uint8_t  reserved[32];  // for future use
-  
+
+      void setTempSensorIDs(TempSensorID water, TempSensorID ambient);
+      
+      /* Override. */
       void print();
 
+      /* Override. */
       uint16_t memSize() { return sizeof(*this); };
 
     protected:

control.cpp

@@ -3,6 +3,17 @@
 // #define DEBUG_CONTROL
 
 
+void OperationalParams::swapTempSensorIDs() {
+  TempSensorID tempId;
+  memcpy(tempId, water.id, TEMP_SENSOR_ID_BYTES);
+  water.setId(ambient.id);
+  ambient.setId(tempId);
+  
+  SensorStatusEnum tempStatus = water.sensorStatus;
+  water.sensorStatus = ambient.sensorStatus;
+  ambient.sensorStatus = tempStatus;      
+}
+    
 uint32_t heatingTotalMillis(OperationalParams *op) {
   uint32_t duration = op->heatingAccumulatedMillis;
   if (op->heatingStartMillis != 0L) {
@@ -50,6 +61,32 @@ uint8_t ControlActions::setupSensors() {
   return matched;
 }
 
+void ControlActions::swapTempSensorIDs() {
+  context->op->swapTempSensorIDs();
+}
+
+void ControlActions::clearTempSensorIDs() {
+  context->config->setTempSensorIDs((uint8_t*) UNDEFINED_SENSOR_ID, (uint8_t*) UNDEFINED_SENSOR_ID);
+  context->config->save();
+  context->log->logConfigParam(PARAM_WATER_TEMP_SENSOR_ID, 0.0);
+  context->log->logConfigParam(PARAM_AMBIENT_TEMP_SENSOR_ID, 0.0);
+  context->log->logMessage(MSG_TEMP_SENSOR_IDS_CLEARED, 0, 0);
+}
+
+boolean ControlActions::confirmTempSensorIDs() {
+  if (context->op->water.sensorStatus == SENSOR_ID_AUTO_ASSIGNED || context->op->ambient.sensorStatus == SENSOR_ID_AUTO_ASSIGNED) {
+    context->config->setTempSensorIDs(context->op->water.id, context->op->ambient.id);
+    context->config->save();
+    context->log->logConfigParam(PARAM_WATER_TEMP_SENSOR_ID, 0.0);
+    context->log->logConfigParam(PARAM_AMBIENT_TEMP_SENSOR_ID, 0.0);
+    
+    context->op->water.confirmId();
+    context->op->ambient.confirmId();
+    return true;
+  }
+  return false;
+}
+
 void ControlActions::initSensorReadout() {
   context->controller->initSensorReadout();
 }

control.h

@@ -12,7 +12,8 @@
     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.
+    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.
+    MSG_TEMP_SENSOR_IDS_CLEARED =  24      // Sensor IDs of water- and ambient-temperature sensor cleared. Restart to see the effect.
   } ControlMessageEnum;
 
 
@@ -74,6 +75,11 @@
     // accumulated time in state HEATING, not including the period since last start (if heatingStartMillis != 0L)
     uint32_t heatingAccumulatedMillis = 0L;
     boolean loggingValues = false;
+
+    /*
+     * Swap sensor IDs and sensor states between water and ambient sensor.
+     */
+    void swapTempSensorIDs();
   };
 
   /*
@@ -99,9 +105,44 @@
       ControlActions(ControlContext *context) {
         this->context = context;
       }
-      virtual uint8_t setupSensors();
-      virtual void initSensorReadout();
-      virtual void completeSensorReadout();
+
+      /*
+       * Performs a search on the OneWire Bus and matches / assigns returned sensor addresses with configured sensors.
+       */
+      uint8_t setupSensors();
+
+      /*
+       * Swap the sensor IDs and states of water- and ambient-temperature sensor in the operational parameters.
+       */
+      void swapTempSensorIDs();
+
+      /*
+       * Clears the sensor IDs of water- and ambient-temperature sensors in the configuration parameters and saves the latter to EEPROM. 
+       */
+      void clearTempSensorIDs();
+      
+      /*
+       * Copies the sensor IDs of water- and ambient-temperature sensors of the the configuration parameters to the configuration parameters and saves the latter to EEPROM. 
+       * Sets the sensor status of one or both sensors to SENSOR_OK iff sensor status is SENSOR_ID_AUTO_ASSIGNED.
+       * 
+       * @return true if at lestt one ID was copied and status was changed.
+       */
+      boolean confirmTempSensorIDs();
+
+      /*
+       * Sends a command to all physical temperature sensors to trigger the conversion of physical values to a temperature.
+       * 
+       * Note: The conversion takes time (up to 750 ms depending on the precision of the returned value) and completeSensorReadout cannot be invoked before that.
+       *       See the data sheet of the DS18B20 temperature sensors for exact times.
+       */
+      void initSensorReadout();
+
+      /*
+       * Reads the temperatures from the physical sensors and assignes the value and state to the configured temperature sonsors.
+       * 
+       * Note: See the note for initSensorReadout()
+       */
+      void completeSensorReadout();
 
       /*
        * Physically turns the water heater on or off.

log.cpp

@@ -40,7 +40,7 @@ Timestamp Log::logState(StateID previous, StateID current, EventID event) {
   data.previous = previous;
   data.current = current;
   data.event = event;
-  LogEntry e = addLogEntry(LOG_DATA_TYPE_VALUES, (LogData *) &data);
+  LogEntry e = addLogEntry(LOG_DATA_TYPE_STATE, (LogData *) &data);
   #ifdef DEBUG_LOG
     Serial.println(F("DEBUG_LOG: logState(..)"));
   #endif
@@ -54,7 +54,7 @@ Timestamp Log::logConfigParam(ConfigParamID id, float newValue) {
   LogConfigParamData data;
   data.id = id;
   data.newValue = newValue;
-  LogEntry e = addLogEntry(LOG_DATA_TYPE_VALUES, (LogData *) &data);
+  LogEntry e = addLogEntry(LOG_DATA_TYPE_CONFIG, (LogData *) &data);
   #ifdef DEBUG_LOG
     Serial.println(F("DEBUG_LOG: logConfigParam(..)"));
   #endif

sensors/OneWireSensors.h

@@ -21,10 +21,10 @@
    */
   typedef enum {
     SENSOR_INITIALISING = 1,
-    SENSOR_OK = 2,               // temperature value is defined and within the given range
-    SENSOR_NOK = 3,              // temperature value could not be obtained or is outside the given range
-    SENSOR_ID_UNDEFINED = 4,     // no physical sensor could be found for the logical sensor
-    SENSOR_ID_AUTO_ASSIGNED = 5  // a physical sensor was assigned to the logical sensor but it may not correspond to the intended sensor
+    SENSOR_ID_AUTO_ASSIGNED = 2, // a physical sensor was assigned to the logical sensor but it may not correspond to the intended sensor
+    SENSOR_ID_UNDEFINED = 3,     // no physical sensor could be found for the logical sensor
+    SENSOR_OK = 4,               // temperature value is defined and within the given range
+    SENSOR_NOK = 5               // temperature value could not be obtained or is outside the given range
   } SensorStatusEnum;
 
   typedef uint8_t SensorStatusID;
@@ -74,6 +74,19 @@
       static boolean idUndefined(const TempSensorID id) {
         return ! memcmp(id, UNDEFINED_SENSOR_ID, TEMP_SENSOR_ID_BYTES);
       }
+
+      /*
+       * Sets the sensor status to SENSOR_OK iff it is SENSOR_ID_AUTO_ASSIGNED.
+       * 
+       * @return true if status was changed.
+       */
+      boolean confirmId() {
+        if (sensorStatus == SENSOR_ID_AUTO_ASSIGNED) {
+          sensorStatus = SENSOR_OK;
+          return true;
+        }
+        return false;
+      }
   };
 
   struct TemperatureReadout {

sensors/sensors.ino

@@ -104,8 +104,8 @@ test(b_single_sensor_readout) {
   uint8_t matched = controller.setupSensors();
   assertEqual(matched, 1);
   assertEqual(s1.sensorStatus, SENSOR_ID_AUTO_ASSIGNED);
-  // manually confirm auto-assigned:
-  s1.sensorStatus = SENSOR_OK;
+  // manually confirm auto-assigned ID:
+  s1.confirmId();
 
   #ifdef MOCK_ONE_WIRE
     const int16_t temperatures100_1[] = {2300};
@@ -164,8 +164,8 @@ test(c_twin_sensor_readout) {
   uint8_t matched = controller.setupSensors();
   assertEqual(matched, 2);
   assertEqual(s1.sensorStatus, SENSOR_ID_AUTO_ASSIGNED);
-  // manually confirm auto-assigned s1 but not s2:
-  s1.sensorStatus = SENSOR_OK;
+  // manually confirm auto-assigned ID for s1 but not for s2:
+  s1.confirmId();
 
   #ifdef MOCK_ONE_WIRE
     const int16_t temperatures100_1[] = {2300, 2400};

ui.h

@@ -19,7 +19,7 @@
 
   class NullUI {
     public:
-      NullUI(ControlContext *context) {
+      NullUI(ExecutionContext *context) {
         this->context = context;
       }
 
@@ -36,15 +36,15 @@
       virtual void notifyNewLogEntry(LogEntry) { }
 
     protected:
-      ControlContext *context;
+      ExecutionContext *context;
   };  
 
 
   #ifdef BLE_UI
 
     class BLEUI : public NullUI {
       public:
-        BLEUI(ControlContext *context) : NullUI(context) { }
+        BLEUI(ExecutionContext *context) : NullUI(context) { }
         void setup();
 
         void readUserCommand();

ui_ble.h

@@ -5,7 +5,7 @@
 
   class BLEUI : public NullUI {
     public:
-      BLEUI(ControlContext *context) : NullUI(context) { }
+      BLEUI(ExecutionContext *context) : NullUI(context) { }
       void setup();
 
       void readUserCommand();

ui_ser.cpp

@@ -1,4 +1,4 @@
-#include <string.h>
+//#include <string.h>
 #include "ui_ser.h"
 #include "config.h"
 
@@ -7,6 +7,10 @@ const char COMMAND_CHARS[] = " abcdefghijklmnopqrstuvwxyz"; // includes blank (f
 const char INT_CHARS[] = "0123456789"; 
 const char SENSOR_ID_CHARS[] = "0123456789abcdef-"; // includes dash
 
+const char STR_CONFIG_SENSOR_ID_SWAP[] PROGMEM = "swap";
+const char STR_CONFIG_SENSOR_ID_CLR[]  PROGMEM = "clr";
+const char STR_CONFIG_SENSOR_ID_ACK[]  PROGMEM = "ack";
+
 //#define DEBUG_UI
 
 /*
@@ -48,13 +52,13 @@ String getConfigParamName(ConfigParamEnum literal) {
 
 String formatFloat(float f) {
   char s[20];
-  dtostrf((double)f, 6, 2, &s[0]); 
+  dtostrf((double)f, 6, 2, s); 
   return s;
 }
 
 String formatInt(uint16_t i) {
   char s[20];
-  utoa(i, &s[0], 10);
+  utoa(i, s, 10);
   return s;
 }
 
@@ -85,6 +89,7 @@ String getConfigParamValue(ConfigParams *all, ConfigParamEnum p) {
   }
 }
 
+/*
 boolean parseTempSensorID(char *value, uint8_t *id) {
   uint8_t len = strspn(value, SENSOR_ID_CHARS);
   #ifdef DEBUG_UI
@@ -106,24 +111,25 @@ boolean parseTempSensorID(char *value, uint8_t *id) {
     return false;
   }
 }
+*/
 
-boolean setConfigParamValue(ControlContext *context, ConfigParamEnum p, char *value) {
+boolean setConfigParamValue(ExecutionContext *context, ConfigParamEnum p, char *value) {
   switch(p) {
     case PARAM_TARGET_TEMP: 
       context->config->targetTemp = atoi(value);
       context->log->logConfigParam(p, (float) context->config->targetTemp);
       return true;
     case PARAM_WATER_TEMP_SENSOR_ID:
-      if (parseTempSensorID(value, context->config->waterTempSensorId)) {
-        context->log->logConfigParam(p, 0.0);
-        return true;
-      }
-      return false;
     case PARAM_AMBIENT_TEMP_SENSOR_ID:
-      if (parseTempSensorID(value, context->config->ambientTempSensorId)) {
-        context->log->logConfigParam(p, 0.0);
+      if (!strcmp_P(value, STR_CONFIG_SENSOR_ID_SWAP)) {
+        context->control->swapTempSensorIDs();
         return true;
-      }
+      } else if (!strcmp_P(value, STR_CONFIG_SENSOR_ID_CLR)) {
+        context->control->clearTempSensorIDs();
+        return true;
+      } else if (!strcmp_P(value, STR_CONFIG_SENSOR_ID_ACK)) {
+        return context->control->confirmTempSensorIDs();
+      } 
       return false;
     case PARAM_HEATER_CUT_OUT_WATER_TEMP: 
       context->config->heaterCutOutWaterTemp = atoi(value);
@@ -438,6 +444,7 @@ void SerialUI::readUserCommand() {
 }
 
 void printLogEntry(LogEntry *e) {
+
   Serial.print(formatTimestamp(e->timestamp));
   Serial.print("  ");
   LogDataTypeEnum type = (LogDataTypeEnum)e->type;
@@ -531,15 +538,15 @@ void SerialUI::processReadWriteRequests(ReadWriteRequests requests, BoilerStateA
 
     Serial.print(F("Water:   "));
     Serial.print(getSensorStatusName(context->op->water.sensorStatus));
-    if (context->op->water.sensorStatus == SENSOR_OK) {
+    if (context->op->water.sensorStatus == SENSOR_OK  || context->op->water.sensorStatus == SENSOR_ID_AUTO_ASSIGNED) {
       Serial.print(F(", "));
       Serial.print(formatTemperature(context->op->water.currentTemp));
     }
     Serial.println();
 
     Serial.print(F("Ambient: "));
     Serial.print(getSensorStatusName(context->op->ambient.sensorStatus));
-    if (context->op->ambient.sensorStatus == SENSOR_OK) {
+    if (context->op->ambient.sensorStatus == SENSOR_OK || context->op->ambient.sensorStatus == SENSOR_ID_AUTO_ASSIGNED) {
       Serial.print(F(", "));
       Serial.print(formatTemperature(context->op->ambient.currentTemp));
     }

ui_ser.h

@@ -5,7 +5,7 @@
 
   class SerialUI : public NullUI {
     public:
-      SerialUI(ControlContext *context) : NullUI(context) { }
+      SerialUI(ExecutionContext *context) : NullUI(context) { }
 
       void setup();