implement setup for dsx, remove deps that conflict

Author: brentru

platformio.ini

@@ -72,7 +72,6 @@ lib_deps =
     adafruit/Adafruit MQTT Library
     bblanchon/ArduinoJson
     https://github.com/pstolarz/OneWireNg.git
-    https://github.com/pstolarz/Arduino-Temperature-Control-Library.git#OneWireNg
     https://github.com/Sensirion/arduino-sht.git
     https://github.com/Sensirion/arduino-i2c-scd4x.git
     https://github.com/Sensirion/arduino-i2c-sen5x.git

src/Wippersnapper.cpp

@@ -66,9 +66,6 @@ Wippersnapper::Wippersnapper() {
 
   // UART
   WS._uartComponent = new ws_uart();
-
-  // DallasSemi (OneWire)
-  WS._ds18x20Component = new ws_ds18x20();
 };
 
 /**************************************************************************/
@@ -1319,43 +1316,6 @@ void cbPWMMsg(char *data, uint16_t len) {
 bool cbDecodeDs18x20Msg(pb_istream_t *stream, const pb_field_t *field,
                         void **arg) {
   (void)arg; // marking unused parameter to avoid compiler warning
-  if (field->tag ==
-      wippersnapper_signal_v1_Ds18x20Request_req_ds18x20_init_tag) {
-    WS_DEBUG_PRINTLN("[Message Type] Init. DS Sensor");
-    // Attempt to decode contents of DS18x20 message
-    wippersnapper_ds18x20_v1_Ds18x20InitRequest msgDS18xInitReq =
-        wippersnapper_ds18x20_v1_Ds18x20InitRequest_init_zero;
-
-    if (!ws_pb_decode(stream,
-                      wippersnapper_ds18x20_v1_Ds18x20InitRequest_fields,
-                      &msgDS18xInitReq)) {
-      WS_DEBUG_PRINTLN("ERROR: Could not decode "
-                       "wippersnapper_ds18x20_v1_Ds18x20InitRequest");
-      return false; // fail out if we can't decode the request
-    }
-    WS_DEBUG_PRINT("Adding DS18x20 Component...");
-    if (!WS._ds18x20Component->addDS18x20(&msgDS18xInitReq))
-      return false;
-    WS_DEBUG_PRINTLN("Added!");
-  } else if (field->tag ==
-             wippersnapper_signal_v1_Ds18x20Request_req_ds18x20_deinit_tag) {
-    WS_DEBUG_PRINTLN("[Message Type] De-init. DS Sensor");
-    // Attempt to decode contents of message
-    wippersnapper_ds18x20_v1_Ds18x20DeInitRequest msgDS18xDeInitReq =
-        wippersnapper_ds18x20_v1_Ds18x20DeInitRequest_init_zero;
-    if (!ws_pb_decode(stream,
-                      wippersnapper_ds18x20_v1_Ds18x20DeInitRequest_fields,
-                      &msgDS18xDeInitReq)) {
-      WS_DEBUG_PRINTLN("ERROR: Could not decode "
-                       "wippersnapper_ds18x20_v1_Ds18x20DeInitRequest");
-      return false; // fail out if we can't decode the request
-    }
-    // exec. deinit request
-    WS._ds18x20Component->deleteDS18x20(&msgDS18xDeInitReq);
-  } else {
-    WS_DEBUG_PRINTLN("ERROR: DS Message type not found!");
-    return false;
-  }
   return true;
 }
 
@@ -2876,10 +2836,6 @@ ws_status_t Wippersnapper::run() {
     WS._i2cPort0->update();
   WS.feedWDT();
 
-  // Process DS18x20 sensor events
-  WS._ds18x20Component->update();
-  WS.feedWDT();
-
   // Process UART sensor events
   WS._uartComponent->update();
   WS.feedWDT();

src/Wippersnapper.h

@@ -64,7 +64,6 @@
 #include "display/ws_display_ui_helper.h"
 #endif
 
-#include "components/ds18x20/ws_ds18x20.h"
 #include "components/pixels/ws_pixels.h"
 #include "components/pwm/ws_pwm.h"
 #include "components/servo/ws_servo.h"
@@ -104,7 +103,6 @@ class ws_ledc;
 class WipperSnapper_Component_I2C;
 class ws_servo;
 class ws_pwm;
-class ws_ds18x20;
 class ws_pixels;
 class ws_uart;
 
@@ -227,7 +225,6 @@ class Wippersnapper {
   ws_pixels *_ws_pixelsComponent; ///< ptr to instance of ws_pixels class
   ws_pwm *_pwmComponent;          ///< Instance of pwm class
   ws_servo *_servoComponent;      ///< Instance of servo class
-  ws_ds18x20 *_ds18x20Component;  ///< Instance of DS18x20 class
   ws_uart *_uartComponent;        ///< Instance of UART class
 
   // TODO: does this really need to be global?

src/components/ds18x20/controller.cpp

@@ -14,17 +14,19 @@
  */
 #include "controller.h"
 
-DS18X20Controller::DS18X20Controller() {
-  _DS18X20_model = new DS18X20Model();
-  _DS18X20_hardware = new DS18X20Hardware();
-}
+DS18X20Controller::DS18X20Controller() { _DS18X20_model = new DS18X20Model(); }
 
-DS18X20Controller::~DS18X20Controller() {
-  delete _DS18X20_model;
-  delete _DS18X20_hardware;
-}
+DS18X20Controller::~DS18X20Controller() { delete _DS18X20_model; }
 
 bool DS18X20Controller::Handle_Ds18x20Add(pb_istream_t *stream) {
-  // TODO: This requires an implementation
+  // Attempt to decode the incoming message into a Ds18x20Add message
+  if (!_DS18X20_model->DecodeDS18x20Add(stream)) {
+    WS_DEBUG_PRINTLN("ERROR: Unable to decode Ds18x20Add message");
+    return false;
+  }
+  // Pass the decoded message to the hardware
+  // TODO: Brent you were here and looking at this:
+  // https://github.com/pstolarz/OneWireNg/blob/master/examples/arduino/DallasTemperature/DallasTemperature.ino#L125
+
   return true;
 }

src/components/ds18x20/controller.h

@@ -35,8 +35,9 @@ class DS18X20Controller {
   bool Handle_Ds18x20Add(pb_istream_t *stream);
 
 private:
-  DS18X20Model *_DS18X20_model;       ///< ds18x20 model
-  DS18X20Hardware *_DS18X20_hardware; ///< ds18x20 hardware
+  DS18X20Model *_DS18X20_model; ///< ds18x20 model
+  std::vector<DS18X20Hardware>
+      _DS18X20_pins; ///< Vector containing multiple DS18X20Hardware objects
 };
 extern Wippersnapper_V2 WsV2; ///< Wippersnapper V2 instance
 #endif                        // WS_DS18X20_CONTROLLER_H

src/components/ds18x20/hardware.cpp

@@ -14,10 +14,39 @@
  */
 #include "hardware.h"
 
-DS18X20Hardware::DS18X20Hardware() {
-  // TODO: Implement this
+DS18X20Hardware::DS18X20Hardware(uint8_t onewire_pin) : _drv_therm(_ow) {
+  new (&_ow) OneWireNg_CurrentPlatform(onewire_pin, false);
 }
 
-DS18X20Hardware::~DS18X20Hardware() {
-  // TODO: Implement this
+DS18X20Hardware::~DS18X20Hardware() { delete &_ow; }
+
+void DS18X20Hardware::setResolution(int resolution) {
+  // Set the resolution of the DS18X20 sensor driver
+  switch (resolution) {
+  case 9:
+    _resolution = DSTherm::Resolution::RES_9_BIT;
+    break;
+  case 10:
+    _resolution = DSTherm::Resolution::RES_10_BIT;
+    break;
+  case 11:
+    _resolution = DSTherm::Resolution::RES_11_BIT;
+    break;
+  case 12:
+    _resolution = DSTherm::Resolution::RES_12_BIT;
+    break;
+  default:
+    _resolution =
+        DSTherm::Resolution::RES_12_BIT; // Default to 12-bit resolution
+    break;
+  }
+
+  // Set common resolution for all sensors.
+  // Th, Tl (high/low alarm triggers) are set to 0.
+  _drv_therm.writeScratchpadAll(0, 0, _resolution);
+
+  // The configuration above is stored in volatile sensors scratchpad
+  // memory and will be lost after power unplug. Therefore store the
+  // configuration permanently in sensors EEPROM.
+  _drv_therm.copyScratchpadAll(false);
 }

src/components/ds18x20/hardware.h

@@ -16,18 +16,9 @@
 #define WS_DS18X20_HARDWARE_H
 #include "Wippersnapper_V2.h"
 
-struct DS18X20_Pin {
-  // Specific to the DS18X20 sensor object
-  // TODO: Implement this! 
-  // From the PB model
-  char onewire_pin[5]; ///< 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
-};                     ///< DS18X20 Pin Object
+#include "OneWireNg_CurrentPlatform.h"
+#include "drivers/DSTherm.h"
+#include "utils/Placeholder.h"
 
 /**************************************************************************/
 /*!
@@ -37,9 +28,24 @@ struct DS18X20_Pin {
 /**************************************************************************/
 class DS18X20Hardware {
 public:
-  DS18X20Hardware();
+  DS18X20Hardware(uint8_t onewire_pin);
   ~DS18X20Hardware();
+  void setResolution(int resolution);
+
 private:
-  std::vector<DS18X20_Pin> _DS18X20_Pins; ///< Vector of analogio pins
+  // 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
+  DSTherm _drv_therm;                         ///< DS18X20 driver object
+  DSTherm::Resolution _resolution; ///< Resolution of the DS18X20 sensor
+  // 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
 };
 #endif // WS_DS18X20_HARDWARE_H

src/components/ds18x20/model.cpp

@@ -19,4 +19,11 @@ DS18X20Model::DS18X20Model() {
   _msg_DS18x20Add = wippersnapper_ds18x20_Ds18x20Add_init_zero;
 }
 
-DS18X20Model::~DS18X20Model() {}
+DS18X20Model::~DS18X20Model() {}
+
+bool DS18X20Model::DecodeDS18x20Add(pb_istream_t *stream) {
+  _msg_DS18x20Add = wippersnapper_ds18x20_Ds18x20Add_init_zero;
+  // Attempt to decode the stream into a Ds18x20Add message
+  return pb_decode(stream, wippersnapper_ds18x20_Ds18x20Add_fields,
+                   &_msg_DS18x20Add);
+}