🐛 Fix DSx bug, onewirePin not added to ds18x20Evetn messages

Author: brentru

src/components/ds18x20/controller.cpp

@@ -66,6 +66,10 @@ 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 pin name (non-logical)
+    new_dsx_driver->setOneWirePinName(
+        _DS18X20_model->GetDS18x20AddMsg()->onewire_pin);
+
     // Set the sensor's resolution
     new_dsx_driver->SetResolution(
         _DS18X20_model->GetDS18x20AddMsg()->sensor_resolution);
@@ -190,7 +194,7 @@ void DS18X20Controller::update() {
 
     // We got a temperature value from the hardware, let's create a new
     // sensor_event
-    _DS18X20_model->InitDS18x20EventMsg();
+    _DS18X20_model->InitDS18x20EventMsg(temp_dsx_driver.getOneWirePinName());
 
     // Are we reading the temperature in Celsius, Fahrenheit, or both?
     if (temp_dsx_driver.is_read_temp_c) {

src/components/ds18x20/hardware.cpp

@@ -85,6 +85,14 @@ bool DS18X20Hardware::GetSensor() {
 /***********************************************************************/
 uint8_t DS18X20Hardware::GetOneWirePin() { return _onewire_pin; }
 
+void DS18X20Hardware::setOneWirePinName(const char *prettyOWPinName) {
+  strncpy(_onewire_pin_name, prettyOWPinName, sizeof(_onewire_pin_name));
+  _onewire_pin_name[sizeof(_onewire_pin_name) - 1] = '\0';
+}
+
+// Return _onewire_pin_name
+const char *DS18X20Hardware::getOneWirePinName() { return _onewire_pin_name; }
+
 /*************************************************************************/
 /*!
     @brief  Sets the DS18X20 sensor's resolution.
@@ -179,10 +187,6 @@ bool DS18X20Hardware::ReadTemperatureC() {
   OneWireNg::ErrorCode ec =
       _drv_therm.convertTemp(_sensorId, DSTherm::MAX_CONV_TIME, false);
 
-  // TODO: this is extra debug prints, delete all prints and just return for
-  // final ver.
-  WS_DEBUG_PRINT("Error Code: ");
-  WS_DEBUG_PRINTLN(ec);
   if (ec != OneWireNg::EC_SUCCESS)
     return false;
 

src/components/ds18x20/hardware.h

@@ -31,11 +31,13 @@ class DS18X20Hardware {
   DS18X20Hardware(uint8_t onewire_pin);
   ~DS18X20Hardware();
   void printErrorCode(OneWireNg::ErrorCode ec);
+  void setOneWirePinName(const char *prettyOWPinName);
   void SetResolution(int resolution);
   void SetPeriod(float period);
   bool IsTimerExpired();
   bool GetSensor();
   uint8_t GetOneWirePin();
+  const char *getOneWirePinName();
   bool ReadTemperatureC();
   float GetTemperatureC();
   float GetTemperatureF();
@@ -52,7 +54,8 @@ class DS18X20Hardware {
   float _temp_f;                   ///< Temperature in Fahrenheit
   // From the PB model
   uint8_t
-      _onewire_pin;  ///< Pin utilized by the OneWire bus, used for addressing
+      _onewire_pin; ///< Pin utilized by the OneWire bus, used for addressing
+  char _onewire_pin_name[5]; ///< Name of the OneWire bus pin
   float _period;     ///< The desired period to read the sensor, in seconds
   float _prv_period; ///< Last time the sensor was polled, in seconds
 };

src/components/ds18x20/model.cpp

@@ -162,9 +162,10 @@ bool DS18X20Model::EncodeDs18x20Event() {
     @brief  Initializes the Ds18x20Event message.
 */
 /*************************************************************************/
-void DS18X20Model::InitDS18x20EventMsg() {
+void DS18X20Model::InitDS18x20EventMsg(const char *ow_pin_name) {
   _msg_DS18x20Event = wippersnapper_ds18x20_Ds18x20Event_init_zero;
   _msg_DS18x20Event.sensor_events_count = 0;
+  strcpy(_msg_DS18x20Event.onewire_pin, ow_pin_name);
 }
 
 /*************************************************************************/

src/components/ds18x20/model.h

@@ -41,7 +41,7 @@ class DS18X20Model {
   // TODO: move the below to private if we arent using it in controller?
   wippersnapper_ds18x20_Ds18x20Event
       _msg_DS18x20Event; ///< wippersnapper_ds18x20_Ds18x20Event message
-  void InitDS18x20EventMsg();
+  void InitDS18x20EventMsg(const char *ow_pin_name);
   void addSensorEvent(wippersnapper_sensor_SensorType sensor_type,
                       float sensor_value);