🚧 WIP, dsx - Add debug profile, remove redundant code within update() call

Author: brentru

src/Wippersnapper_V2.cpp

@@ -869,9 +869,15 @@ void Wippersnapper_V2::haltErrorV2(String error,
 */
 /**************************************************************************/
 bool Wippersnapper_V2::PublishSignal(pb_size_t which_payload, void *payload) {
+
+  #ifdef DEBUG_PROFILE
+  unsigned long total_start_time = micros();
+  #endif
+
   size_t szMessageBuf;
   wippersnapper_signal_DeviceToBroker MsgSignal =
       wippersnapper_signal_DeviceToBroker_init_default;
+
   // Fill generic signal payload with the payload from the args.
   WS_DEBUG_PRINT("Signal Payload Type: ");
   switch (which_payload) {
@@ -900,13 +906,15 @@ bool Wippersnapper_V2::PublishSignal(pb_size_t which_payload, void *payload) {
     WS_DEBUG_PRINTLN("DS18X20Added");
     MsgSignal.which_payload =
         wippersnapper_signal_DeviceToBroker_ds18x20_added_tag;
-    MsgSignal.payload.ds18x20_added = *(wippersnapper_ds18x20_Ds18x20Added *)payload;
+    MsgSignal.payload.ds18x20_added =
+        *(wippersnapper_ds18x20_Ds18x20Added *)payload;
     break;
   case wippersnapper_signal_DeviceToBroker_ds18x20_event_tag:
     WS_DEBUG_PRINTLN("DS18X20Event");
     MsgSignal.which_payload =
         wippersnapper_signal_DeviceToBroker_ds18x20_event_tag;
-    MsgSignal.payload.ds18x20_event = *(wippersnapper_ds18x20_Ds18x20Event *)payload;
+    MsgSignal.payload.ds18x20_event =
+        *(wippersnapper_ds18x20_Ds18x20Event *)payload;
     break;
   default:
     WS_DEBUG_PRINTLN("ERROR: Invalid signal payload type, bailing out!");
@@ -934,20 +942,37 @@ bool Wippersnapper_V2::PublishSignal(pb_size_t which_payload, void *payload) {
         "ERROR: Unable to encode d2b signal message, bailing out!");
     return false;
   }
-  WS_DEBUG_PRINTLN("Encoded!")
+  WS_DEBUG_PRINTLN("Encoded!");
 
-  //. Check that we are still connected
+  // Check that we are still connected
   runNetFSMV2();
   WsV2.feedWDTV2();
 
+  #ifdef DEBUG_PROFILE
+  unsigned long publish_start_time = micros();
+  #endif
+
   // Attempt to publish the signal message to the broker
   WS_DEBUG_PRINT("Publishing signal message to broker...");
+  #ifdef DEBUG_PROFILE
+  WS_DEBUG_PRINT("Message buffer size: ");
+  WS_DEBUG_PRINTLN(szMessageBuf);
+  #endif
   if (!WsV2._mqttV2->publish(WsV2._topicD2b, msgBuf, szMessageBuf, 1)) {
     WS_DEBUG_PRINTLN("ERROR: Failed to publish signal message to broker!");
     return false;
   }
   WS_DEBUG_PRINTLN("Published!");
 
+  #ifdef DEBUG_PROFILE
+  unsigned long publish_end_time = micros();
+  WS_DEBUG_PRINT("Publishing time: ");
+  WS_DEBUG_PRINTLN(publish_end_time - publish_start_time);
+  unsigned long total_end_time = micros();
+  WS_DEBUG_PRINT("Total PublishSignal() execution time: ");
+  WS_DEBUG_PRINTLN(total_end_time - total_start_time);
+  #endif
+
   return true;
 }
 

src/Wippersnapper_V2.h

@@ -72,8 +72,6 @@
 #include "display/ws_display_ui_helper.h"
 #endif
 
-
-
 #include "provisioning/ConfigJson.h"
 #if defined(USE_TINYUSB)
 #include "provisioning/tinyusb/Wippersnapper_FS_V2.h"
@@ -82,6 +80,10 @@
 #include "provisioning/littlefs/WipperSnapper_LittleFS.h"
 #endif
 
+// Debug print macros
+// Uncomment the following to enable debug output for function profiling
+// #DEBUG_PROFILE 1
+
 #define WS_VERSION                                                             \
   "2.0.0-alpha.1" ///< WipperSnapper app. version (semver-formatted)
 
@@ -91,9 +93,6 @@
 #define WS_KEEPALIVE_INTERVAL_MS                                               \
   5000 ///< Session keepalive interval time, in milliseconds
 
-#define WS_MQTT_MAX_PAYLOAD_SIZE                                               \
-  512 ///< MAXIMUM expected payload size, in bytes
-
 // Forward declarations (API v1)
 class Wippersnapper_AnalogIO;
 class Wippersnapper_FS_V2;

src/components/ds18x20/controller.cpp

@@ -192,74 +192,60 @@ void DS18X20Controller::update() {
       continue;
     }
 
-    // Create a new sensor_event
-    _DS18X20_model->InitDS18x20EventMsg();
-
-    // Are we reading the temperature in Celsius, Fahrenheit, or both?
-    if (temp_dsx_driver.is_read_temp_c) {
-      unsigned long temp_c_start_time = millis();
-
-      WS_DEBUG_PRINTLN("Reading temperature in Celsius"); // TODO: Debug remove
       // Attempt to read the temperature in Celsius
+      #ifdef DEBUG_PROFILE
+      unsigned long temp_c_start_time = millis();
+      #endif
       if (!temp_dsx_driver.ReadTemperatureC()) {
         WS_DEBUG_PRINTLN("ERROR: Unable to read temperature in Celsius");
         continue;
       }
+      #ifdef DEBUG_PROFILE
+      unsigned long temp_c_end_time = millis();
+      WS_DEBUG_PRINT("Read temperature Celsius time: ");
+      WS_DEBUG_PRINTLN(temp_c_end_time - temp_c_start_time);
+      #endif
+
+    // We got a temperature value from the hardware, let's create a new sensor_event
+    _DS18X20_model->InitDS18x20EventMsg();
+
+    // Are we reading the temperature in Celsius, Fahrenheit, or both?
+    if (temp_dsx_driver.is_read_temp_c) {
       float temp_c = temp_dsx_driver.GetTemperatureC();
       _DS18X20_model->addSensorEvent(
           wippersnapper_sensor_SensorType_SENSOR_TYPE_OBJECT_TEMPERATURE,
           temp_c);
-
-      unsigned long temp_c_end_time = millis();
-      WS_DEBUG_PRINT("Read temperature Celsius time: ");
-      WS_DEBUG_PRINTLN(temp_c_end_time - temp_c_start_time);
     }
     if (temp_dsx_driver.is_read_temp_f) {
-      unsigned long temp_f_start_time = millis();
-
-      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_OBJECT_TEMPERATURE_FAHRENHEIT,
           temp_f);
-
-      unsigned long temp_f_end_time = millis();
-      WS_DEBUG_PRINT("Read temperature Fahrenheit time: ");
-      WS_DEBUG_PRINTLN(temp_f_end_time - temp_f_start_time);
     }
 
-    // Get and print out the SensorEvent message's contents
-    wippersnapper_ds18x20_Ds18x20Event event_msg =
-        *_DS18X20_model->GetDS18x20EventMsg();
-    pb_size_t event_count = event_msg.sensor_events_count;
+    // Get the Ds18x20Event message
+    wippersnapper_ds18x20_Ds18x20Event* event_msg = _DS18X20_model->GetDS18x20EventMsg();
+    pb_size_t event_count = event_msg->sensor_events_count;
+
 
+    // Print the message's content out for debugging
     WS_DEBUG_PRINT("Sensor OneWire bus pin: ");
     WS_DEBUG_PRINT(temp_dsx_driver.GetOneWirePin());
     WS_DEBUG_PRINT(" got ");
     WS_DEBUG_PRINT(event_count);
     WS_DEBUG_PRINTLN(" sensor events");
     for (int i = 0; i < event_count; i++) {
       WS_DEBUG_PRINT("Sensor value: ");
-      WS_DEBUG_PRINTLN(event_msg.sensor_events[i].value.float_value);
+      WS_DEBUG_PRINT(event_msg->sensor_events[i].value.float_value);
     }
 
     // Encode the Ds18x20Event message
-    unsigned long encode_start_time = millis();
     if (!_DS18X20_model->EncodeDs18x20Event()) {
       WS_DEBUG_PRINTLN("ERROR: Failed to encode Ds18x20Event message");
       continue;
     }
-    unsigned long encode_end_time = millis();
-    WS_DEBUG_PRINT("Encode event message time: ");
-    WS_DEBUG_PRINTLN(encode_end_time - encode_start_time);
 
     // Publish the Ds18x20Event message to the broker
-    unsigned long publish_start_time = millis();
     WS_DEBUG_PRINT("Publishing Ds18x20Event message to broker...");
     if (!WsV2.PublishSignal(
             wippersnapper_signal_DeviceToBroker_ds18x20_event_tag,
@@ -268,16 +254,20 @@ void DS18X20Controller::update() {
       continue;
     }
     WS_DEBUG_PRINTLN("Published!");
-    unsigned long publish_end_time = millis();
-    WS_DEBUG_PRINT("Publish event message time: ");
-    WS_DEBUG_PRINTLN(publish_end_time - publish_start_time);
 
+    #ifdef DEBUG_PROFILE
     unsigned long sensor_end_time = millis();
     WS_DEBUG_PRINT("Total sensor processing time: ");
     WS_DEBUG_PRINTLN(sensor_end_time - sensor_start_time);
+    #endif
   }
 
+  #ifdef DEBUG_PROFILE
   unsigned long total_end_time = millis();
-  WS_DEBUG_PRINT("Total update() execution time: ");
-  WS_DEBUG_PRINTLN(total_end_time - total_start_time);
+  if (total_end_time - total_start_time != 0) {
+    WS_DEBUG_PRINT("Total update() execution time: ");
+    WS_DEBUG_PRINTLN(total_end_time - total_start_time);
+  }
+  #endif
+
 }

src/components/ds18x20/hardware.cpp

@@ -161,26 +161,9 @@ float DS18X20Hardware::GetTemperatureC() { return _temp_c; }
     @returns The temperature in Fahrenheit.
 */
 /*************************************************************************/
-float DS18X20Hardware::GetTemperatureF() { return _temp_f; }
-
-/*************************************************************************/
-/*!
-    @brief  Attempts to obtain the temperature from the sensor, in
-            degrees Fahrenheit.
-    @returns True if the temperature was successfully read, False otherwise.
-*/
-/*************************************************************************/
-bool DS18X20Hardware::ReadTemperatureF() {
-  bool is_success = ReadTemperatureC();
-  // Did we read the temperature successfully?
-  if (!is_success)
-    return false;
-  // 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;
+float DS18X20Hardware::GetTemperatureF() { 
+    _temp_f = _temp_c * 9.0 / 5.0 + 32.0;
+    return _temp_f;
 }
 
 /*************************************************************************/

src/components/ds18x20/hardware.h

@@ -37,7 +37,6 @@ class DS18X20Hardware {
   bool GetSensor();
   uint8_t GetOneWirePin();
   bool ReadTemperatureC();
-  bool ReadTemperatureF();
   float GetTemperatureC();
   float GetTemperatureF();
   bool is_read_temp_c; ///< Flag telling the controller to read the temperature

src/components/ds18x20/model.cpp

@@ -182,6 +182,9 @@ void DS18X20Model::addSensorEvent(wippersnapper_sensor_SensorType sensor_type,
       sensor_type;
   _msg_DS18x20Event.sensor_events[_msg_DS18x20Event.sensor_events_count]
       .which_value = wippersnapper_sensor_SensorEvent_float_value_tag;
+
+  // Convert the float to 2 decimal places
+  sensor_value = roundf(sensor_value * 100) / 100;
   _msg_DS18x20Event.sensor_events[_msg_DS18x20Event.sensor_events_count]
       .value.float_value = sensor_value;
   _msg_DS18x20Event.sensor_events_count++;