🚧 WIP, dsx - Implement readF, getters

Author: brentru

src/components/ds18x20/controller.cpp

@@ -72,6 +72,7 @@ void DS18X20Controller::update() {
     // Check if the driver's timer has expired
     if (temp_dsx_driver->IsTimerExpired())
       return;
-    // TODO: Poll the sensor
+    // TODO: the update() method should check sensor type(s)
+    // before polling ReadTemperatureX methods!
   }
 }

src/components/ds18x20/hardware.cpp

@@ -64,25 +64,39 @@ bool DS18X20Hardware::IsTimerExpired() {
   return millis() - _prv_period > _period;
 }
 
-OneWireNg::ErrorCode DS18X20Hardware::ReadTemperatureC() {
+float DS18X20Hardware::GetTemperatureC() { return _temp_c; }
+
+float DS18X20Hardware::GetTemperatureF() { return _temp_f; }
+
+bool DS18X20Hardware::ReadTemperatureF() {
+  bool is_success = ReadTemperatureC();
+  // Did we read the temperature successfully?
+  if (!is_success)
+    return false;
+  // We have the temperature in Celsius, convert to Fahrenheit
+  _temp_f = _temp_c * 9.0 / 5.0 + 32.0;
+  return true;
+}
+
+bool DS18X20Hardware::ReadTemperatureC() {
   // Start temperature conversion for the first identified sensor on the OneWire
   // bus
   OneWireNg::ErrorCode ec =
       _drv_therm.convertTemp(_sensorId, DSTherm::MAX_CONV_TIME, false);
   if (ec != OneWireNg::EC_SUCCESS)
-    return ec;
+    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 ec;
+    return false;
 
   // Read the temperature from the sensor
   long temp = scrpd->getTemp2();
   _temp_c = temp / 16.0; // Convert from 16-bit int to float
-
-  return ec;
+  return true;
 }

src/components/ds18x20/hardware.h

@@ -31,20 +31,20 @@ class DS18X20Hardware {
   DS18X20Hardware(uint8_t onewire_pin);
   ~DS18X20Hardware();
   bool GetSensor();
-  OneWireNg::ErrorCode DS18X20Hardware::ReadTemperatureC();
   void setResolution(int resolution);
   bool IsTimerExpired();
+  bool ReadTemperatureC();
+  bool ReadTemperatureF();
+  float GetTemperatureC();
+  float GetTemperatureF();
 
 private:
-  // NOTE: We are going to try definining a vector of DS18X20Hardware objects
-  // iwthin the controller so instead of a struct, these are all assigned to
-  // this class
   Placeholder<OneWireNg_CurrentPlatform> _ow; ///< OneWire bus object
   OneWireNg::Id _sensorId;
   DSTherm _drv_therm;              ///< DS18X20 driver object
   DSTherm::Resolution _resolution; ///< Resolution of the DS18X20 sensor
-  float _temp_c;
-  float _temp_f;
+  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