🚧 WIP, dsx - Add to hardware, updat eloop

Author: brentru

src/components/ds18x20/controller.cpp

@@ -24,6 +24,13 @@ bool DS18X20Controller::Handle_Ds18x20Add(pb_istream_t *stream) {
     WS_DEBUG_PRINTLN("ERROR: Unable to decode Ds18x20Add message");
     return false;
   }
+
+  // If we receive no sensor types to configure, bail out
+  if (_DS18X20_model->GetDS18x20AddMsg()->sensor_types_count == 0) {
+    WS_DEBUG_PRINTLN("ERROR: No ds18x sensor types provided!");
+    return false;
+  }
+
   // Extract the OneWire pin from the message
   uint8_t pin_name = atoi(_DS18X20_model->GetDS18x20AddMsg()->onewire_pin + 1);
 
@@ -34,13 +41,27 @@ bool DS18X20Controller::Handle_Ds18x20Add(pb_istream_t *stream) {
   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);
+    // 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;
+      } else if (
+          _DS18X20_model->GetDS18x20AddMsg()->sensor_types[i] ==
+          wippersnapper_sensor_SensorType_SENSOR_TYPE_AMBIENT_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);
   } else {
-    WS_DEBUG_PRINTLN("ERROR: Unable to get sensor ID, sensor not initialized");
+    WS_DEBUG_PRINTLN(
+        "ERROR: Unable to get ds18x sensor ID, ds18x sensor not initialized");
   }
 
   // Encode and publish a Ds18x20Added message back to the broker
@@ -62,17 +83,21 @@ bool DS18X20Controller::Handle_Ds18x20Add(pb_istream_t *stream) {
 
 void DS18X20Controller::update() {
   // Bail out if there are no OneWire pins to poll
-  if (_DS18X20_pins.size() == 0)
+  if (_DS18X20_pins.empty())
     return;
 
   // 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];
-    // Check if the driver's timer has expired
-    if (temp_dsx_driver->IsTimerExpired())
-      return;
-    // TODO: the update() method should check sensor type(s)
-    // before polling ReadTemperatureX methods!
+    DS18X20Hardware &temp_dsx_driver = _DS18X20_pins[i];
+    // Check if the driver's timer has not expired yet
+    if (!temp_dsx_driver.IsTimerExpired())
+      continue;
+    // Are we reading the temperature in Celsius, Fahrenheit, or both?
+    if (temp_dsx_driver.is_read_temp_c)
+      temp_dsx_driver.GetTemperatureC();
+    if (temp_dsx_driver.is_read_temp_f)
+      temp_dsx_driver.GetTemperatureF();
+    // wippersnapper_sensor_SensorType_SENSOR_TYPE_AMBIENT_TEMPERATURE
   }
 }

src/components/ds18x20/hardware.cpp

@@ -15,18 +15,25 @@
 #include "hardware.h"
 
 DS18X20Hardware::DS18X20Hardware(uint8_t onewire_pin) : _drv_therm(_ow) {
+  is_read_temp_c = false;
+  is_read_temp_f = false;
   // Initialize the OneWire bus object
+  _onewire_pin = onewire_pin;
   new (&_ow) OneWireNg_CurrentPlatform(onewire_pin, false);
 }
 
-DS18X20Hardware::~DS18X20Hardware() { delete &_ow; }
+DS18X20Hardware::~DS18X20Hardware() {
+  pinMode(_onewire_pin,
+          INPUT); // Set the pin to hi-z and release it for other uses
+  delete &_ow;
+}
 
 bool DS18X20Hardware::GetSensor() {
   OneWireNg::ErrorCode ec = _ow->readSingleId(_sensorId);
   return ec == OneWireNg::EC_SUCCESS;
 }
 
-void DS18X20Hardware::setResolution(int resolution) {
+void DS18X20Hardware::SetResolution(int resolution) {
   // Set the resolution of the DS18X20 sensor driver
   switch (resolution) {
   case 9:
@@ -57,10 +64,13 @@ void DS18X20Hardware::setResolution(int resolution) {
   _drv_therm.copyScratchpadAll(false);
 }
 
+void DS18X20Hardware::SetPeriod(float period) {
+  _period = period * 1000; // Convert to milliseconds
+}
+
+// Get the current time in milliseconds and compare it to the last time
+// the sensor was polled
 bool DS18X20Hardware::IsTimerExpired() {
-  // Get the current time in milliseconds and compare it to the last time
-  // the sensor was polled
-  ulong cur_time = millis();
   return millis() - _prv_period > _period;
 }
 
@@ -73,8 +83,11 @@ bool DS18X20Hardware::ReadTemperatureF() {
   // Did we read the temperature successfully?
   if (!is_success)
     return false;
-  // We have the temperature in Celsius, convert to Fahrenheit
+  // We now have the temperature but it's in in Celsius. Let's convert it to
+  // Fahrenheit
   _temp_f = _temp_c * 9.0 / 5.0 + 32.0;
+
+  _prv_period = millis(); // Update the last time the sensor was polled
   return true;
 }
 
@@ -84,19 +97,20 @@ bool DS18X20Hardware::ReadTemperatureC() {
   OneWireNg::ErrorCode ec =
       _drv_therm.convertTemp(_sensorId, DSTherm::MAX_CONV_TIME, false);
   if (ec != OneWireNg::EC_SUCCESS)
-    return false
+    return false;
 
-        // Scratchpad placeholder is static to allow reuse of the associated
-        // sensor id while reissuing readScratchpadSingle() calls.
-        // Note, due to its storage class the placeholder is zero initialized.
-        static Placeholder<DSTherm::Scratchpad>
-            scrpd;
+  // Scratchpad placeholder is static to allow reuse of the associated
+  // sensor id while reissuing readScratchpadSingle() calls.
+  // Note, due to its storage class the placeholder is zero initialized.
+  static Placeholder<DSTherm::Scratchpad> scrpd;
   ec = _drv_therm.readScratchpadSingle(scrpd);
   if (ec != OneWireNg::EC_SUCCESS)
     return false;
 
   // Read the temperature from the sensor
   long temp = scrpd->getTemp2();
   _temp_c = temp / 16.0; // Convert from 16-bit int to float
+
+  _prv_period = millis(); // Update the last time the sensor was polled
   return true;
 }

src/components/ds18x20/hardware.h

@@ -30,13 +30,16 @@ class DS18X20Hardware {
 public:
   DS18X20Hardware(uint8_t onewire_pin);
   ~DS18X20Hardware();
-  bool GetSensor();
-  void setResolution(int resolution);
+  void SetResolution(int resolution);
+  void SetPeriod(float period);
   bool IsTimerExpired();
+  bool GetSensor();
   bool ReadTemperatureC();
   bool ReadTemperatureF();
   float GetTemperatureC();
   float GetTemperatureF();
+  bool is_read_temp_c;
+  bool is_read_temp_f;
 
 private:
   Placeholder<OneWireNg_CurrentPlatform> _ow; ///< OneWire bus object
@@ -46,12 +49,9 @@ class DS18X20Hardware {
   float _temp_c;                   ///< Temperature in Celsius
   float _temp_f;                   ///< Temperature in Fahrenheit
   // From the PB model
-  uint8_t onewire_pin; ///< Pin utilized by the OneWire bus, used for addressing
-  float _period;       ///< The desired period to read the sensor, in seconds
-  float _prv_period;   ///< Last time the sensor was polled, in seconds
-  pb_size_t
-      _sensor_types_count; ///< Number of sensor types to read from the sensor
-  wippersnapper_sensor_SensorType
-      _sensor_types[2]; ///< DS sensor type(s) to read from the sensor
+  uint8_t
+      _onewire_pin;  ///< Pin utilized by the OneWire bus, used for addressing
+  float _period;     ///< The desired period to read the sensor, in seconds
+  float _prv_period; ///< Last time the sensor was polled, in seconds
 };
 #endif // WS_DS18X20_HARDWARE_H