🚧 WIP, dsx - Read temperature and properly reset all counters

Author: brentru

platformio.ini

@@ -179,7 +179,8 @@ extends = common:esp32
 board = adafruit_feather_esp32s3
 build_flags = -DARDUINO_ADAFRUIT_FEATHER_ESP32S3 -DBOARD_HAS_PSRAM
 ;set partition to tinyuf2-partitions-4MB.csv as of idf 5.1
-board_build.partitions = tinyuf2-partitions-4MB.csv
+; board_build.partitions = tinyuf2-partitions-4MB.csv
+board_build.partitions = tinyuf2-partitions-4MB-noota.csv
 extra_scripts = pre:rename_usb_config.py
 
 ; Adafruit Feather ESP32-S3 NO PSRAM

src/Wippersnapper_V2.cpp

@@ -372,6 +372,13 @@ bool cbDecodeBrokerToDevice(pb_istream_t *stream, const pb_field_t *field,
       return false;
     }
     break;
+  case wippersnapper_signal_BrokerToDevice_ds18x20_add_tag:
+    WS_DEBUG_PRINTLN("-> DS18X20 Add Message Type");
+    if (!WsV2._ds18x20_controller->Handle_Ds18x20Add(stream)) {
+      WS_DEBUG_PRINTLN("ERROR: Unable to add DS18X20 sensor!");
+      return false;
+    }
+    break;
   default:
     WS_DEBUG_PRINTLN("ERROR: BrokerToDevice message type not found!");
     return false;
@@ -1171,6 +1178,9 @@ ws_status_t Wippersnapper_V2::runV2() {
   // Process all analog inputs
   WsV2.analogio_controller->update();
 
+  // Process all DS18x20 sensor events
+  WsV2._ds18x20_controller->update();
+
   // TODO: Process I2C sensor events
 
   // TODO: Process DS18x20 sensor events

src/components/ds18x20/controller.cpp

@@ -59,30 +59,31 @@ bool DS18X20Controller::Handle_Ds18x20Add(pb_istream_t *stream) {
   uint8_t pin_name = atoi(_DS18X20_model->GetDS18x20AddMsg()->onewire_pin + 1);
 
   // Initialize the DS18X20Hardware object
-  DS18X20Hardware new_dsx_driver(pin_name);
+  auto new_dsx_driver = std::make_unique<DS18X20Hardware>(pin_name);
   // Attempt to get the sensor's ID on the OneWire bus to show it's been init'd
-  bool is_initialized = new_dsx_driver.GetSensor();
-  if (!is_initialized) {
+  bool is_initialized = new_dsx_driver->GetSensor();
+  if (is_initialized) {
     WS_DEBUG_PRINTLN("Sensor found on OneWire bus and initialized");
     // Set the sensor's resolution
-    new_dsx_driver.SetResolution(
+    new_dsx_driver->SetResolution(
         _DS18X20_model->GetDS18x20AddMsg()->sensor_resolution);
     // Set the sensor's period
-    new_dsx_driver.SetPeriod(_DS18X20_model->GetDS18x20AddMsg()->period);
+    new_dsx_driver->SetPeriod(_DS18X20_model->GetDS18x20AddMsg()->period);
     // Configure the types of sensor reads to perform
     for (int i = 0; i < _DS18X20_model->GetDS18x20AddMsg()->sensor_types_count;
          i++) {
       if (_DS18X20_model->GetDS18x20AddMsg()->sensor_types[i] ==
-          wippersnapper_sensor_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE) {
-        new_dsx_driver.is_read_temp_c = true;
+          wippersnapper_sensor_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE) {
+        new_dsx_driver->is_read_temp_c = true;
       } else if (
           _DS18X20_model->GetDS18x20AddMsg()->sensor_types[i] ==
-          wippersnapper_sensor_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE_FAHRENHEIT) {
-        new_dsx_driver.is_read_temp_f = true;
+          wippersnapper_sensor_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE_FAHRENHEIT) {
+        new_dsx_driver->is_read_temp_f = true;
       }
     }
     // Add the DS18X20Hardware object to the vector of hardware objects
-    _DS18X20_pins.push_back(new_dsx_driver);
+    //_DS18X20_pins.push_back(new_dsx_driver);
+    _DS18X20_pins.push_back(std::move(new_dsx_driver));
   } else {
     WS_DEBUG_PRINTLN(
         "ERROR: Unable to get ds18x sensor ID, ds18x sensor not initialized");
@@ -126,12 +127,12 @@ bool DS18X20Controller::Handle_Ds18x20Remove(pb_istream_t *stream) {
   wippersnapper_ds18x20_Ds18x20Remove *msg_remove =
       _DS18X20_model->GetDS18x20RemoveMsg();
   uint8_t pin_name = atoi(msg_remove->onewire_pin + 1);
-  // Destroy the DS18X20Hardware object, remove it from the vector, and release
-  // it for other uses
-  for (uint8_t i = 0; i < _DS18X20_pins.size(); i++) {
-    if (_DS18X20_pins[i].GetOneWirePin() == pin_name) {
+
+  // Find the driver/bus in the vector and remove it
+  for (size_t i = 0; i < _DS18X20_pins.size(); ++i) {
+    if (_DS18X20_pins[i]->GetOneWirePin() == pin_name) {
       _DS18X20_pins.erase(_DS18X20_pins.begin() + i);
-      break;
+      return true;
     }
   }
   WS_DEBUG_PRINT("Removed OneWire Pin: ");
@@ -152,7 +153,7 @@ void DS18X20Controller::update() {
   // Iterate through the vector
   for (uint8_t i = 0; i < _DS18X20_pins.size(); i++) {
     // Create a temporary DS18X20Hardware driver
-    DS18X20Hardware &temp_dsx_driver = _DS18X20_pins[i];
+    DS18X20Hardware &temp_dsx_driver = *(_DS18X20_pins[i]);
     // Check if the driver's timer has not expired yet
     if (!temp_dsx_driver.IsTimerExpired()) {
       continue;
@@ -162,17 +163,27 @@ void DS18X20Controller::update() {
     // Are we reading the temperature in Celsius, Fahrenheit, or both?
     if (temp_dsx_driver.is_read_temp_c) {
       WS_DEBUG_PRINTLN("Reading temperature in Celsius"); // TODO: Debug remove
+      // Attempt to read the temperature in Celsius
+      if (!temp_dsx_driver.ReadTemperatureC()) {
+        WS_DEBUG_PRINTLN("ERROR: Unable to read temperature in Celsius");
+        continue;
+      }
       float temp_c = temp_dsx_driver.GetTemperatureC();
       _DS18X20_model->addSensorEvent(
-          wippersnapper_sensor_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE,
+          wippersnapper_sensor_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE,
           temp_c);
     }
     if (temp_dsx_driver.is_read_temp_f) {
       WS_DEBUG_PRINTLN(
           "Reading temperature in Fahrenheit"); // TODO: Debug remove
+      // Attempt to read the temperature in Fahrenheit
+      if (!temp_dsx_driver.ReadTemperatureF()) {
+        WS_DEBUG_PRINTLN("ERROR: Unable to read temperature in Fahrenheit");
+        continue;
+      }
       float temp_f = temp_dsx_driver.GetTemperatureF();
       _DS18X20_model->addSensorEvent(
-          wippersnapper_sensor_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE_FAHRENHEIT,
+          wippersnapper_sensor_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE_FAHRENHEIT,
           temp_f);
     }
     // Print out the SensorEvent message's contents for debugging

src/components/ds18x20/controller.h

@@ -17,6 +17,7 @@
 #include "Wippersnapper_V2.h"
 #include "hardware.h"
 #include "model.h"
+#include <memory>
 
 class Wippersnapper_V2; ///< Forward declaration
 class DS18X20Model;     ///< Forward declaration
@@ -39,8 +40,7 @@ class DS18X20Controller {
 
 private:
   DS18X20Model *_DS18X20_model; ///< ds18x20 model
-  std::vector<DS18X20Hardware>
-      _DS18X20_pins; ///< Vector containing multiple DS18X20Hardware objects
+  std::vector<std::unique_ptr<DS18X20Hardware>> _DS18X20_pins;
 };
 extern Wippersnapper_V2 WsV2; ///< Wippersnapper V2 instance
 #endif                        // WS_DS18X20_CONTROLLER_H

src/components/ds18x20/hardware.cpp

@@ -37,7 +37,32 @@ DS18X20Hardware::DS18X20Hardware(uint8_t onewire_pin) : _drv_therm(_ow) {
 DS18X20Hardware::~DS18X20Hardware() {
   pinMode(_onewire_pin,
           INPUT); // Set the pin to hi-z and release it for other uses
-  delete &_ow;
+}
+
+void DS18X20Hardware::printErrorCode(OneWireNg::ErrorCode ec) {
+  switch (ec) {
+  case OneWireNg::EC_SUCCESS:
+    WS_DEBUG_PRINTLN("EC_SUCCESS");
+    break;
+  case OneWireNg::EC_NO_DEVS:
+    WS_DEBUG_PRINTLN("EC_NO_DEVSNo slave devices; search process finished");
+    break;
+  case OneWireNg::EC_BUS_ERROR:
+    WS_DEBUG_PRINTLN("EC_BUS_ERROR-wire bus error");
+    break;
+  case OneWireNg::EC_CRC_ERROR:
+    WS_DEBUG_PRINTLN("EC_CRC_ERRORCRC error");
+    break;
+  case OneWireNg::EC_UNSUPPORED:
+    WS_DEBUG_PRINTLN("EC_UNSUPPOREDService is not supported by the platform");
+    break;
+  case OneWireNg::EC_FULL:
+    WS_DEBUG_PRINTLN("EC_FULLNo space (e.g. filters table is full)");
+    break;
+  default:
+    WS_DEBUG_PRINTLN("EC ?!?1 Unknown error");
+    break;
+  }
 }
 
 /***********************************************************************/
@@ -48,6 +73,7 @@ DS18X20Hardware::~DS18X20Hardware() {
 /***********************************************************************/
 bool DS18X20Hardware::GetSensor() {
   OneWireNg::ErrorCode ec = _ow->readSingleId(_sensorId);
+  printErrorCode(ec);
   return ec == OneWireNg::EC_SUCCESS;
 }
 
@@ -107,6 +133,7 @@ void DS18X20Hardware::SetResolution(int resolution) {
 /*************************************************************************/
 void DS18X20Hardware::SetPeriod(float period) {
   _period = period * 1000; // Convert to milliseconds
+  _prv_period = 0;         // Also reset the previous period here
 }
 
 /*************************************************************************/

src/components/ds18x20/hardware.h

@@ -30,6 +30,7 @@ class DS18X20Hardware {
 public:
   DS18X20Hardware(uint8_t onewire_pin);
   ~DS18X20Hardware();
+  void printErrorCode(OneWireNg::ErrorCode ec);
   void SetResolution(int resolution);
   void SetPeriod(float period);
   bool IsTimerExpired();

src/components/ds18x20/model.cpp

@@ -193,4 +193,5 @@ void DS18X20Model::addSensorEvent(wippersnapper_sensor_SensorType sensor_type,
       .which_value = wippersnapper_sensor_SensorEvent_float_value_tag;
   _msg_DS18x20Event.sensor_events[_msg_DS18x20Event.sensor_events_count]
       .value.float_value = sensor_value;
+  _msg_DS18x20Event.sensor_events_count++;
 }