Add display component, start handleAdd

Author: brentru

src/Wippersnapper.cpp

@@ -69,6 +69,9 @@ Wippersnapper::Wippersnapper() {
 
   // DallasSemi (OneWire)
   WS._ds18x20Component = new ws_ds18x20();
+
+  // Display controller
+  WS._displayController = new DisplayController();
 };
 
 /**************************************************************************/
@@ -1666,7 +1669,21 @@ void cbSignalUARTReq(char *data, uint16_t len) {
     @returns  True if decoded successfully, False otherwise.
 */
 bool cbDecodeDisplayMsg(pb_istream_t *stream, const pb_field_t *field, void **arg) {
-  // TODO: Need to write deserializer logic here
+  if (field->tag == wippersnapper_signal_v1_DisplayRequest_display_add_tag) {
+
+    // Decode message into a DisplayAddRequest
+    wippersnapper_display_v1_DisplayAddOrReplace msgAddReq = wippersnapper_display_v1_DisplayAddOrReplace_init_zero;
+    if (!ws_pb_decode(stream,
+                      wippersnapper_display_v1_DisplayAddOrReplace_fields,
+                      &msgAddReq)) {
+      WS_DEBUG_PRINTLN("ERROR: Failure decoding DisplayAddOrReplace message!");
+      return false;
+    }
+
+    // Attempt to add or replace a display component
+    bool did_add = WS._displayController->Handle_Display_AddOrReplace(&msgAddReq);
+    // TODO: Add response handling and publishing here
+
   return true;
 }
 

src/Wippersnapper.h

@@ -132,6 +132,7 @@
 #include "components/pwm/ws_pwm.h"
 #include "components/servo/ws_servo.h"
 #include "components/uart/ws_uart.h"
+#include "components/display/controller.h"
 
 #if defined(USE_TINYUSB)
 #include "provisioning/tinyusb/Wippersnapper_FS.h"
@@ -246,6 +247,7 @@ class ws_pwm;
 class ws_ds18x20;
 class ws_pixels;
 class ws_uart;
+class DisplayController;
 
 /**************************************************************************/
 /*!
@@ -369,6 +371,7 @@ class Wippersnapper {
   ws_servo *_servoComponent;      ///< Instance of servo class
   ws_ds18x20 *_ds18x20Component;  ///< Instance of DS18x20 class
   ws_uart *_uartComponent;        ///< Instance of UART class
+  DisplayController *_displayController; ///< Instance of display controller class
 
   // TODO: does this really need to be global?
   uint8_t _macAddr[6];  /*!< Unique network iface identifier */

src/components/display/controller.cpp

@@ -0,0 +1,37 @@
+/*!
+ * @file src/components/display/controller.cpp
+ *
+ * Implementation for the display API controller.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
+#include "controller.h"
+
+/*!
+    @brief  Constructs a new DisplayController object
+*/
+DisplayController::DisplayController() {
+  // TODO
+}
+
+/*!
+    @brief  Destructor
+*/
+DisplayController::DisplayController() {
+  // TODO
+}
+
+bool DisplayController::Handle_Display_AddOrReplace(wippersnapper_display_v1_DisplayAddOrReplace *msgAdd) {
+    DisplayHardware *display = new DisplayHardware();
+    // Configure display type
+    display->setType(msgAdd->type);
+
+    return true; // Placeholder
+}

src/components/display/controller.h

@@ -0,0 +1,41 @@
+/*!
+ * @file src/components/display/controller.h
+ *
+ * Controller for the display API
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
+#ifndef WS_DISPLAY_CONTROLLER_H
+#define WS_DISPLAY_CONTROLLER_H
+#include "Wippersnapper.h"
+#include "hardware.h"
+
+class Wippersnapper_V2; ///< Forward declaration
+class DisplayHardware;  ///< Forward declaration
+
+/**************************************************************************/
+/*!
+    @brief  Routes messages using the display.proto API to the
+            appropriate hardware and model classes, controls and tracks
+            the state of displays.
+*/
+/**************************************************************************/
+class DisplayController {
+public:
+  DisplayController();
+  ~DisplayController();
+  bool Handle_Display_AddOrReplace(wippersnapper_display_v1_DisplayAddOrReplace *msgAdd);
+  //bool Handle_Display_Write(pb_istream_t *stream);
+  //bool Handle_Display_Remove(pb_istream_t *stream);
+private:
+  //DisplayHardware *_display_strands[MAX_DISPLAY_STRANDS] = {
+};
+extern Wippersnapper Ws; ///< Global WS instance
+#endif

src/components/display/hardware.cpp

@@ -0,0 +1,58 @@
+/*!
+ * @file src/components/display/hardware.cpp
+ *
+ * Implementation for the display hardware.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
+#include "controller.h"
+
+/*!
+    @brief  Constructs a new DisplayHardware object
+*/
+DisplayHardware::DisplayHardware() {
+  _type = wippersnapper_display_v1_DisplayType_DISPLAY_TYPE_UNSPECIFIED;
+}
+
+/*!
+    @brief  Destructor
+*/
+DisplayHardware::DisplayHardware() {
+  // TODO: Clean up display drivers
+}
+
+/*!
+    @brief  Sets the hardware's display type.
+    @param  type
+            The display type to set.
+*/
+void DisplayHardware::setType(wippersnapper_display_v1_DisplayType type) {
+    _type = type;
+}
+
+/*!
+    @brief  Initializes the display hardware.
+    @param  reset
+            Whether to reset the display hardware.
+    @return True if initialization was successful, false otherwise.
+*/
+bool DisplayHardware::begin(bool reset) {
+    return true; // Placeholder for actual initialization logic
+}
+
+/*!
+    @brief  Sets the text size for the display.
+    @param  sz
+            The size of the text to set.
+*/
+void setTextSize(uint8_t sz) {
+    // Placeholder for setting text size on the display TODO
+}
+

src/components/display/hardware.h

@@ -0,0 +1,45 @@
+/*!
+ * @file src/components/display/hardware.h
+ *
+ * Hardware interface for display components.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Brent Rubell 2025 for Adafruit Industries.
+ *
+ * BSD license, all text here must be included in any redistribution.
+ *
+ */
+#ifndef WS_DISPLAY_HARDWARE_H
+#define WS_DISPLAY_HARDWARE_H
+#include "Wippersnapper.h"
+
+#include "Adafruit_ThinkInk.h"
+
+/**************************************************************************/
+/*!
+    @brief  Interface for interacting with display hardware (TFT, eInk,
+            OLED, etc.)
+            This class provides methods to initialize, write to, and
+            manage the state of display hardware.
+*/
+/**************************************************************************/
+class DisplayHardware {
+public:
+  DisplayHardware();
+  ~DisplayHardware();
+  // High-level API functions
+  void setType(wippersnapper_display_v1_DisplayType type);
+  bool begin(bool reset = true);
+  // API functions to abstract Adafruit_GFX
+  void setTextSize(uint8_t sz);
+
+  private:
+    wippersnapper_display_v1_DisplayType _type; ///< Display type
+    // TODO: Make these drivers instead?
+    ThinkInk_290_Grayscale4_EAAMFGN *disp_thinkink_grayscale4_eaamfgn = nullptr; //< 2025 MagTag with SSD1680Z chipset
+    ThinkInk_290_Grayscale4_T5 *disp_thinkink_grayscale4_t5 = nullptr; ///< Pre-2025 MagTag with IL0373 chipset
+};
+#endif // WS_DISPLAY_HARDWARE_H