Implement WriteX funcs for each value type and link within drvOutputBase

brentru · brentru · commit 263fbfae2ad1 · 2025-05-08T11:48:02.000-04:00
diff --git a/src/components/i2c/controller.cpp b/src/components/i2c/controller.cpp
@@ -818,6 +818,10 @@ bool I2cController::Handle_I2cDeviceOutputWrite(pb_istream_t *stream) {
   if (_i2c_model->GetI2cDeviceOutputWriteMsg()->has_led_backpack_write) {
     // TODO
     WS_DEBUG_PRINTLN("[i2c] LED backpack write!");
+    if (!driver->LedBackpackWrite(&_i2c_model->GetI2cDeviceOutputWriteMsg()->led_backpack_write)) {
+      WS_DEBUG_PRINTLN("[i2c] ERROR: Unable to write to LED backpack!");
+      return false;
+    }
   } else if (_i2c_model->GetI2cDeviceOutputWriteMsg()->has_char_lcd_write) {
     WS_DEBUG_PRINTLN("[i2c] Char LCD write not implemented yet!");
   } else {
diff --git a/src/components/i2c/drivers/drvOutQuadAlphaNum.h b/src/components/i2c/drivers/drvOutQuadAlphaNum.h
@@ -18,10 +18,12 @@
 
 #include "drvOutputBase.h"
 #include <Adafruit_LEDBackpack.h>
+#include <Arduino.h>
 
 #define LED_BACKPACK_ALIGNMENT_UNSPECIFIED 0
 #define LED_BACKPACK_ALIGNMENT_LEFT 1
 #define LED_BACKPACK_ALIGNMENT_RIGHT 2
+#define LED_MAX_CHARS 4
 
 /*!
     @brief  Class that provides a driver interface for Quad Alphanumeric
@@ -64,6 +66,7 @@ class drvOutQuadAlphaNum : public drvOutputBase {
     _alpha4 = new Adafruit_AlphaNum4();
     bool did_begin = _alpha4->begin(_address, _i2c);
     _alpha4->setBrightness(_brightness);
+    return did_begin;
   }
 
   /*!
@@ -83,19 +86,65 @@ class drvOutQuadAlphaNum : public drvOutputBase {
     _brightness = brightness;
   }
 
+  /*!
+      @brief    Sets the brightness of the LED backpack.
+      @param    b
+                  The brightness value, from 0 (off) to 15 (full brightness).
+  */
+  void SetLedBackpackBrightness(uint8_t b) {
+    if (_alpha4 == nullptr) {
+      return;
+    }
+    _alpha4->setBrightness(b);
+  }
+
   /*!
       @brief    Writes the first four characters of a message to the quad
      alphanumeric display.
       @param    message
                   The message to be displayed.
   */
   void WriteMessage(const char *message) {
-    if (_alpha4 == nullptr) {
+    if (_alpha4 == nullptr || message == nullptr) {
       return;
     }
-    for (size_t i = 0; i < 4; i++) {
-      _alpha4->writeDigitAscii(i, message[i]);
+    // Clear before writing
+    _alpha4->clear();
+
+    // Calculate the number of characters to display
+    size_t len_display = min(strlen(message), (size_t)LED_MAX_CHARS);
+
+    // Set the starting position based on alignment
+    int pos_start;
+    if (_alignment == LED_BACKPACK_ALIGNMENT_LEFT) {
+      pos_start = 0; // start at the leftmost position of the display
+    } else {
+      // Exclude decimal points from the character count because those get
+      // displayed on a "special" segment of the LED display
+      int seg_chars = 0;
+      for (size_t i = 0; i < len_display; i++) {
+        if (message[i] != '.') {
+          seg_chars++;
+        }
+      }
+      // start at the rightmost position of the display
+      pos_start = LED_MAX_CHARS - seg_chars;
+    }
+
+    // Write to the display's buffer
+    int cur_idx = pos_start;
+    for (size_t i = 0; i < len_display; i++) {
+      // Look-ahead for a decimal point to attach to the current character
+      bool display_dot = false;
+      if (i + 1 < len_display && message[i + 1] == '.') {
+        display_dot = true;
+        i++;
+      }
+      // Write the character to the display buffer
+      _alpha4->writeDigitAscii(cur_idx, message[i], display_dot);
+      cur_idx++;
     }
+    // Issue the buffered data in RAM to the display
     _alpha4->writeDisplay();
   }
 
@@ -106,10 +155,9 @@ class drvOutQuadAlphaNum : public drvOutputBase {
       displayed.
   */
   void WriteValue(float value) {
-    if (_alpha4 == nullptr) {
-      return;
-    }
-    // TODO!
+    char message[LED_MAX_CHARS + 1];
+    snprintf(message, sizeof(message), "%.4f", value);
+    WriteMessage(message);
   }
 
   /*!
@@ -119,17 +167,19 @@ class drvOutQuadAlphaNum : public drvOutputBase {
       displayed.
   */
   void WriteValue(int32_t value) {
-    if (_alpha4 == nullptr) {
-      return;
-    }
-    // TODO!
+    char message[LED_MAX_CHARS + 1];
+    snprintf(message, sizeof(message), "%ld", value);
+    WriteMessage(message);
   }
 
 protected:
   Adafruit_AlphaNum4 *_alpha4 =
-      nullptr; ///< ptr to a 4-digit alphanumeric display object
-  int32_t _brightness;
-  uint32_t _alignment;
+      nullptr;         ///< ptr to a 4-digit alphanumeric display object
+  int32_t _brightness; ///< Brightness of the LED backpack, from 0 (off) to 15
+                       ///< (full brightness)
+  uint32_t _alignment =
+      LED_BACKPACK_ALIGNMENT_RIGHT; ///< Determines L/R alignment of the message
+                                    ///< displayed
 };
 
 #endif // DRV_OUT_QUAD_ALPHANUM_H
diff --git a/src/components/i2c/drivers/drvOutputBase.h b/src/components/i2c/drivers/drvOutputBase.h
@@ -88,16 +88,45 @@ class drvOutputBase : public drvBase {
   }
 
   /*!
-      @brief    High-level fn, executes a call to the appropriate driver function(s)
-                based on the message data type to write.
+      @brief    Sets the brightness of the LED backpack.
+      @param    b
+                  The brightness value, from 0 (off) to 15 (full brightness).
+  */
+  virtual void SetLedBackpackBrightness(uint8_t b) {
+    // noop
+  }
+
+  /*!
+      @brief    High-level fn, executes a call to the appropriate driver
+     function(s) based on the message data type to write.
       @param    msg_backpack_write
                 Pointer to a wippersnapper_i2c_output_LedBackpackWrite message.
+      @returns  True if the message was written successfully, False otherwise.
   */
-  void LedBackpackWrite(wippersnapper_i2c_output_LedBackpackWrite *msg_backpack_write) {
+  bool LedBackpackWrite(
+      wippersnapper_i2c_output_LedBackpackWrite *msg_backpack_write) {
+    // Check if we should adjust brightness
+    if (msg_backpack_write->adjust_brightness)
+      SetLedBackpackBrightness((uint8_t)msg_backpack_write->brightness);
 
+    // Write the message to a LED backpack
+    switch (msg_backpack_write->which_message) {
+    case wippersnapper_i2c_output_LedBackpackWrite_text_tag:
+      WriteMessage(msg_backpack_write->message.text);
+      break;
+    case wippersnapper_i2c_output_LedBackpackWrite_number_int_tag:
+      WriteValue(msg_backpack_write->message.number_int);
+      break;
+    case wippersnapper_i2c_output_LedBackpackWrite_number_float_tag:
+      WriteValue(msg_backpack_write->message.number_float);
+      break;
+    default:
+      return false;
+      break;
+    }
+    return true;
   }
 
 protected:
-  // TODO
 };
 #endif // DRV_OUTPUT_BASE_H
diff --git a/src/protos/i2c.pb.h b/src/protos/i2c.pb.h
@@ -335,7 +335,7 @@ extern const pb_msgdesc_t wippersnapper_i2c_I2cDeviceOutputWrite_msg;
 #define wippersnapper_i2c_I2cDeviceAddOrReplace_size 141
 #define wippersnapper_i2c_I2cDeviceAddedOrReplaced_size 56
 #define wippersnapper_i2c_I2cDeviceDescriptor_size 50
-#define wippersnapper_i2c_I2cDeviceOutputWrite_size 145
+#define wippersnapper_i2c_I2cDeviceOutputWrite_size 147
 #define wippersnapper_i2c_I2cDeviceRemove_size   52
 #define wippersnapper_i2c_I2cDeviceRemoved_size  54
 #if defined(wippersnapper_sensor_SensorEvent_size)
diff --git a/src/protos/i2c_output.pb.h b/src/protos/i2c_output.pb.h
@@ -64,6 +64,7 @@ typedef struct _wippersnapper_i2c_output_LedBackpackWrite {
         int32_t number_int; /* * Number to write to the LED backpack. * */
         float number_float; /* * Float to write to the LED backpack. * */
     } message;
+    bool adjust_brightness; /* * Optionally used to enable the brightness tag. * */
     int32_t brightness; /* * Optionally adjusts the brightness from 0 (off) to 15 (full brightness). * */
     wippersnapper_i2c_output_LedBackpackBlinkRate blink_rate; /* * Optionally sets the blink rate for the LED backpack. * */
     bool enable_scroll_marquee; /* * Optionally enables automatic text scrolling * */
@@ -111,12 +112,12 @@ extern "C" {
 #define wippersnapper_i2c_output_LedBackpackConfig_init_default {0, _wippersnapper_i2c_output_LedBackpackAlignment_MIN}
 #define wippersnapper_i2c_output_CharLCDConfig_init_default {0, 0, 0, ""}
 #define wippersnapper_i2c_output_I2cOutputAdd_init_default {0, {wippersnapper_i2c_output_LedBackpackConfig_init_default}}
-#define wippersnapper_i2c_output_LedBackpackWrite_init_default {0, {""}, 0, _wippersnapper_i2c_output_LedBackpackBlinkRate_MIN, 0, 0, 0}
+#define wippersnapper_i2c_output_LedBackpackWrite_init_default {0, {""}, 0, 0, _wippersnapper_i2c_output_LedBackpackBlinkRate_MIN, 0, 0, 0}
 #define wippersnapper_i2c_output_CharLCDWrite_init_default {0, {""}, 0, "", 0}
 #define wippersnapper_i2c_output_LedBackpackConfig_init_zero {0, _wippersnapper_i2c_output_LedBackpackAlignment_MIN}
 #define wippersnapper_i2c_output_CharLCDConfig_init_zero {0, 0, 0, ""}
 #define wippersnapper_i2c_output_I2cOutputAdd_init_zero {0, {wippersnapper_i2c_output_LedBackpackConfig_init_zero}}
-#define wippersnapper_i2c_output_LedBackpackWrite_init_zero {0, {""}, 0, _wippersnapper_i2c_output_LedBackpackBlinkRate_MIN, 0, 0, 0}
+#define wippersnapper_i2c_output_LedBackpackWrite_init_zero {0, {""}, 0, 0, _wippersnapper_i2c_output_LedBackpackBlinkRate_MIN, 0, 0, 0}
 #define wippersnapper_i2c_output_CharLCDWrite_init_zero {0, {""}, 0, "", 0}
 
 /* Field tags (for use in manual encoding/decoding) */
@@ -131,11 +132,12 @@ extern "C" {
 #define wippersnapper_i2c_output_LedBackpackWrite_text_tag 1
 #define wippersnapper_i2c_output_LedBackpackWrite_number_int_tag 2
 #define wippersnapper_i2c_output_LedBackpackWrite_number_float_tag 3
-#define wippersnapper_i2c_output_LedBackpackWrite_brightness_tag 4
-#define wippersnapper_i2c_output_LedBackpackWrite_blink_rate_tag 5
-#define wippersnapper_i2c_output_LedBackpackWrite_enable_scroll_marquee_tag 6
-#define wippersnapper_i2c_output_LedBackpackWrite_scroll_marquee_speed_tag 7
-#define wippersnapper_i2c_output_LedBackpackWrite_enable_ampm_dot_tag 8
+#define wippersnapper_i2c_output_LedBackpackWrite_adjust_brightness_tag 4
+#define wippersnapper_i2c_output_LedBackpackWrite_brightness_tag 5
+#define wippersnapper_i2c_output_LedBackpackWrite_blink_rate_tag 6
+#define wippersnapper_i2c_output_LedBackpackWrite_enable_scroll_marquee_tag 7
+#define wippersnapper_i2c_output_LedBackpackWrite_scroll_marquee_speed_tag 8
+#define wippersnapper_i2c_output_LedBackpackWrite_enable_ampm_dot_tag 9
 #define wippersnapper_i2c_output_CharLCDWrite_text_tag 1
 #define wippersnapper_i2c_output_CharLCDWrite_number_int_tag 2
 #define wippersnapper_i2c_output_CharLCDWrite_number_float_tag 3
@@ -170,11 +172,12 @@ X(a, STATIC,   ONEOF,    MESSAGE,  (config,char_lcd_config,config.char_lcd_confi
 X(a, STATIC,   ONEOF,    STRING,   (message,text,message.text),   1) \
 X(a, STATIC,   ONEOF,    INT32,    (message,number_int,message.number_int),   2) \
 X(a, STATIC,   ONEOF,    FLOAT,    (message,number_float,message.number_float),   3) \
-X(a, STATIC,   SINGULAR, INT32,    brightness,        4) \
-X(a, STATIC,   SINGULAR, UENUM,    blink_rate,        5) \
-X(a, STATIC,   SINGULAR, BOOL,     enable_scroll_marquee,   6) \
-X(a, STATIC,   SINGULAR, FLOAT,    scroll_marquee_speed,   7) \
-X(a, STATIC,   SINGULAR, BOOL,     enable_ampm_dot,   8)
+X(a, STATIC,   SINGULAR, BOOL,     adjust_brightness,   4) \
+X(a, STATIC,   SINGULAR, INT32,    brightness,        5) \
+X(a, STATIC,   SINGULAR, UENUM,    blink_rate,        6) \
+X(a, STATIC,   SINGULAR, BOOL,     enable_scroll_marquee,   7) \
+X(a, STATIC,   SINGULAR, FLOAT,    scroll_marquee_speed,   8) \
+X(a, STATIC,   SINGULAR, BOOL,     enable_ampm_dot,   9)
 #define wippersnapper_i2c_output_LedBackpackWrite_CALLBACK NULL
 #define wippersnapper_i2c_output_LedBackpackWrite_DEFAULT NULL
 
@@ -207,7 +210,7 @@ extern const pb_msgdesc_t wippersnapper_i2c_output_CharLCDWrite_msg;
 #define wippersnapper_i2c_output_CharLCDWrite_size 46
 #define wippersnapper_i2c_output_I2cOutputAdd_size 32
 #define wippersnapper_i2c_output_LedBackpackConfig_size 13
-#define wippersnapper_i2c_output_LedBackpackWrite_size 43
+#define wippersnapper_i2c_output_LedBackpackWrite_size 45
 
 #ifdef __cplusplus
 } /* extern "C" */
diff --git a/src/protos/signal.pb.h b/src/protos/signal.pb.h
@@ -257,7 +257,7 @@ extern const pb_msgdesc_t wippersnapper_signal_DeviceToBroker_msg;
 
 /* Maximum encoded size of messages (where known) */
 #if defined(wippersnapper_digitalio_DigitalIOEvent_size) && defined(wippersnapper_digitalio_DigitalIOWrite_size) && defined(wippersnapper_uart_UARTAdd_size) && defined(wippersnapper_uart_UARTRemove_size)
-union wippersnapper_signal_BrokerToDevice_payload_size_union {char f12[(6 + wippersnapper_digitalio_DigitalIOEvent_size)]; char f13[(6 + wippersnapper_digitalio_DigitalIOWrite_size)]; char f80[(7 + wippersnapper_uart_UARTAdd_size)]; char f81[(7 + wippersnapper_uart_UARTRemove_size)]; char f0[149];};
+union wippersnapper_signal_BrokerToDevice_payload_size_union {char f12[(6 + wippersnapper_digitalio_DigitalIOEvent_size)]; char f13[(6 + wippersnapper_digitalio_DigitalIOWrite_size)]; char f80[(7 + wippersnapper_uart_UARTAdd_size)]; char f81[(7 + wippersnapper_uart_UARTRemove_size)]; char f0[151];};
 #endif
 #if defined(wippersnapper_digitalio_DigitalIOEvent_size) && defined(wippersnapper_analogio_AnalogIOEvent_size) && defined(wippersnapper_ds18x20_Ds18x20Event_size) && defined(wippersnapper_uart_UARTAdded_size) && defined(wippersnapper_uart_UARTEvent_size) && defined(wippersnapper_i2c_I2cDeviceEvent_size)
 union wippersnapper_signal_DeviceToBroker_payload_size_union {char f10[(6 + wippersnapper_digitalio_DigitalIOEvent_size)]; char f20[(7 + wippersnapper_analogio_AnalogIOEvent_size)]; char f80[(7 + wippersnapper_ds18x20_Ds18x20Event_size)]; char f90[(7 + wippersnapper_uart_UARTAdded_size)]; char f100[(7 + wippersnapper_uart_UARTEvent_size)]; char f113[(7 + wippersnapper_i2c_I2cDeviceEvent_size)]; char f0[6246];};
