Implement NeoPixel configuration in hardware

brentru · brentru · commit f8e7894968f6 · 2025-04-14T16:26:06.000-04:00
diff --git a/src/Wippersnapper_V2.cpp b/src/Wippersnapper_V2.cpp
@@ -117,7 +117,7 @@ void Wippersnapper_V2::provision() {
   }
 
   WsV2._display->enableLogging();
-  releaseStatusLED(); // don't use status LED if we are using the display
+  ReleaseStatusPixel(); // don't use status LED if we are using the display
   // UI Setup
   WsV2._ui_helper = new ws_display_ui_helper(WsV2._display);
   WsV2._ui_helper->set_bg_black();
diff --git a/src/components/digitalIO/controller.cpp b/src/components/digitalIO/controller.cpp
@@ -76,7 +76,7 @@ bool DigitalIOController::Handle_DigitalIO_Add(pb_istream_t *stream) {
 
   // Check if the provided pin is also the status LED pin
   if (_dio_hardware->IsStatusLEDPin(pin_name))
-    releaseStatusLED();
+    ReleaseStatusPixel();
 
   // Deinit the pin if it's already in use
   if (GetPinIdx(pin_name) != -1)
diff --git a/src/components/pixels/controller.cpp b/src/components/pixels/controller.cpp
@@ -44,6 +44,23 @@ PixelsController::~PixelsController() {
 */
 /**************************************************************************/
 bool PixelsController::Handle_Pixels_Add(pb_istream_t *stream) {
+  // Attempt to decode the istream
+  if (!_pixels_model->DecodePixelsAdd(stream))
+    return false;
+  // Get the decoded message
+  wippersnapper_pixels_PixelsAdd *msg_add = _pixels_model->GetPixelsAddMsg();
+  _pixel_strands[_num_strands] = new PixelsHardware();
+
+  // TODO: Call ConfigureStrand()!
+  bool did_init = false;
+  did_init = _pixel_strands[_num_strands]->ConfigureStrand(
+      msg_add->pixels_type, msg_add->pixels_ordering, msg_add->pixels_num,
+      msg_add->pixels_brightness, msg_add->pixels_pin_data,
+      msg_add->pixels_pin_dotstar_clock);
+  if (!did_init)
+    WS_DEBUG_PRINTLN("[pixels] Failed to create strand!");
+  // TODO: Implement the wippersnapper_pixels_PixelsAdded message back to the
+  // broker here
 }
 
 /**************************************************************************/
@@ -54,8 +71,7 @@ bool PixelsController::Handle_Pixels_Add(pb_istream_t *stream) {
     @returns True if successful, False otherwise
 */
 /**************************************************************************/
-bool PixelsController::Handle_Pixels_Write(pb_istream_t *stream) {
-}
+bool PixelsController::Handle_Pixels_Write(pb_istream_t *stream) {}
 
 /**************************************************************************/
 /*!
@@ -65,5 +81,4 @@ bool PixelsController::Handle_Pixels_Write(pb_istream_t *stream) {
     @returns True if successful, False otherwise
 */
 /**************************************************************************/
-bool PixelsController::Handle_Pixels_Remove(pb_istream_t *stream) {
-}
+bool PixelsController::Handle_Pixels_Remove(pb_istream_t *stream) {}
diff --git a/src/components/pixels/hardware.cpp b/src/components/pixels/hardware.cpp
@@ -21,38 +21,90 @@
 */
 /**************************************************************************/
 PixelsHardware::PixelsHardware() {
+  _type = wippersnapper_pixels_PixelsType_PIXELS_TYPE_UNSPECIFIED;
 }
 
 /**************************************************************************/
 /*!
     @brief  Destructs a PixelsHardware object
 */
 /**************************************************************************/
-PixelsHardware::~PixelsHardware() {
+PixelsHardware::~PixelsHardware() {}
+
+bool PixelsHardware::AddNeoPixel(uint16_t num_pixels, uint16_t pin_data,
+                                 neoPixelType order, uint8_t brightness) {
+  if (getStatusNeoPixelPin() == pin_data && WsV2.lockStatusNeoPixelV2)
+    ReleaseStatusPixel(); // Release the status pixel for use
+
+  _neopixel = new Adafruit_NeoPixel((uint16_t)num_pixels, pin_data, order);
+  _neopixel->begin();
+  _neopixel->setBrightness((uint8_t)brightness);
+  _neopixel->clear();
+  _neopixel->show();
+  // Check if the NeoPixel object was created successfully
+  if (_neopixel->numPixels() != num_pixels)
+    return false;
+
+  WS_DEBUG_PRINT("[pixels] Added NeoPixel strand on pin ");
+  WS_DEBUG_PRINT(pin_data);
+  return true;
 }
 
-/**************************************************************************/
-/*!
-    @brief  Configures a pixel strand
-    @param  pin_data
-            Data pin for the pixel strand
-    @param  pin_clock
-            Clock pin for DotStar pixel strands
-    @param  type
-            Type of pixel strand (NeoPixel, DotStar)
-    @param  order
-            Color ordering of pixels
-    @param  num_pixels
-            Number of pixels in the strand
-    @param  brightness
-            Initial brightness (0-255)
-    @returns True if successful, False otherwise
-*/
-/**************************************************************************/
-bool PixelsHardware::ConfigurePixelStrand(uint8_t pin_data, uint8_t pin_clock, 
-                                         wippersnapper_pixels_PixelsType type,
-                                         wippersnapper_pixels_PixelsOrder order,
-                                         uint32_t num_pixels, uint32_t brightness) {
+bool PixelsHardware::ConfigureStrand(wippersnapper_pixels_PixelsType type,
+                                     wippersnapper_pixels_PixelsOrder order,
+                                     uint32_t num_pixels, uint32_t brightness,
+                                     const char *pin_data,
+                                     const char *pin_clock) {
+  _type = type;
+  // Convert the pin string to an integer
+  uint16_t p_data = atoi(pin_data + 1);
+  // pin_clock is OPTIONALLY passed for a dotstar
+  if (pin_clock != nullptr)
+    uint16_t p_clock = atoi(pin_clock + 1);
+  // Generics, TODO
+
+  // TODO: Wrap the initialization into a function instead of within the
+  // conditional
+  if (_type == wippersnapper_pixels_PixelsType_PIXELS_TYPE_NEOPIXEL) {
+    if (getStatusNeoPixelPin() == p_data && WsV2.lockStatusNeoPixelV2) {
+      ReleaseStatusPixel(); // Release the status pixel for use
+    }
+    if (!AddNeoPixel(num_pixels, p_data, GetStrandOrder(order),
+                     (uint8_t)brightness)) {
+      WS_DEBUG_PRINTLN("[pixels] Failed to create NeoPixel strand!");
+      return false;
+    }
+    return true;
+  } else if (_type == wippersnapper_pixels_PixelsType_PIXELS_TYPE_DOTSTAR) {
+    // TODO! DOTSTAR
+  } else {
+    // TODO! Signal!!!
+    return false;
+  }
+  return true;
+}
+
+void PixelsHardware::begin() {
+  // TODO:
+  // https://github.com/adafruit/Adafruit_Wippersnapper_Arduino/blob/main/src/components/pixels/ws_pixels.cpp#L258
+}
+
+neoPixelType
+PixelsHardware::GetStrandOrder(wippersnapper_pixels_PixelsOrder order) {
+  switch (order) {
+  case wippersnapper_pixels_PixelsOrder_PIXELS_ORDER_GRB:
+    return NEO_GRB + NEO_KHZ800;
+  case wippersnapper_pixels_PixelsOrder_PIXELS_ORDER_GRBW:
+    return NEO_GRBW + NEO_KHZ800;
+  case wippersnapper_pixels_PixelsOrder_PIXELS_ORDER_RGB:
+    return NEO_RGB + NEO_KHZ800;
+  case wippersnapper_pixels_PixelsOrder_PIXELS_ORDER_RGBW:
+    return NEO_RGBW + NEO_KHZ800;
+  case wippersnapper_pixels_PixelsOrder_PIXELS_ORDER_BRG:
+    return NEO_BRG + NEO_KHZ800;
+  default:
+    return NEO_GRB + NEO_KHZ800;
+  }
 }
 
 /**************************************************************************/
@@ -64,8 +116,7 @@ bool PixelsHardware::ConfigurePixelStrand(uint8_t pin_data, uint8_t pin_clock,
             32-bit color value
 */
 /**************************************************************************/
-void PixelsHardware::SetPixelColor(uint8_t pin_data, uint32_t color) {
-}
+void PixelsHardware::SetPixelColor(uint8_t pin_data, uint32_t color) {}
 
 /**************************************************************************/
 /*!
@@ -74,5 +125,4 @@ void PixelsHardware::SetPixelColor(uint8_t pin_data, uint32_t color) {
             Data pin for the pixel strand
 */
 /**************************************************************************/
-void PixelsHardware::deinit(uint8_t pin_data) {
-}
+void PixelsHardware::deinit(uint8_t pin_data) {}
diff --git a/src/components/pixels/hardware.h b/src/components/pixels/hardware.h
@@ -22,13 +22,13 @@
  * @brief This struct represents a NeoPixel or DotStar strand.
  */
 struct PixelStrand {
-    uint8_t pin_data;           ///< Data pin
-    uint8_t pin_clock;          ///< Clock pin (for DotStar)
-    wippersnapper_pixels_PixelsType type;     ///< Pixel type
-    wippersnapper_pixels_PixelsOrder order;   ///< Color ordering
-    uint32_t num_pixels;        ///< Number of pixels
-    uint32_t brightness;        ///< Current brightness (0-255)
-  };
+  uint8_t pin_data;                       ///< Data pin
+  uint8_t pin_clock;                      ///< Clock pin (for DotStar)
+  wippersnapper_pixels_PixelsType type;   ///< Pixel type
+  wippersnapper_pixels_PixelsOrder order; ///< Color ordering
+  uint32_t num_pixels;                    ///< Number of pixels
+  uint32_t brightness;                    ///< Current brightness (0-255)
+};
 
 /**************************************************************************/
 /*!
@@ -39,12 +39,21 @@ class PixelsHardware {
 public:
   PixelsHardware();
   ~PixelsHardware();
-  bool ConfigurePixelStrand(uint8_t pin_data, uint8_t pin_clock, 
-                          wippersnapper_pixels_PixelsType type,
-                          wippersnapper_pixels_PixelsOrder order,
-                          uint32_t num_pixels, uint32_t brightness);
+  bool ConfigureStrand(wippersnapper_pixels_PixelsType type,
+                       wippersnapper_pixels_PixelsOrder order,
+                       uint32_t num_pixels, uint32_t brightness,
+                       const char *pin_data, const char *pin_clock);
+  void begin();
   void SetPixelColor(uint8_t pin_data, uint32_t color);
   void deinit(uint8_t pin_data);
+  bool AddNeoPixel(uint16_t num_pixels, uint16_t pin_data, neoPixelType order,
+                   uint8_t brightness);
+  // helpers
+  neoPixelType GetStrandOrder(wippersnapper_pixels_PixelsOrder order);
+
 private:
+  Adafruit_NeoPixel *_neopixel = nullptr; ///< Used for NeoPixel pixel strands
+  Adafruit_DotStar *_dotstar = nullptr;   ///< Used for DotStar pixel strands
+  wippersnapper_pixels_PixelsType _type;
 };
 #endif // WS_PIXELS_HARDWARE_H
diff --git a/src/components/statusLED/Wippersnapper_StatusLED.cpp b/src/components/statusLED/Wippersnapper_StatusLED.cpp
@@ -99,7 +99,7 @@ void initStatusLED() {
     @brief    De-initializes the status LED and releases pin.
 */
 /****************************************************************************/
-void releaseStatusLED() {
+void ReleaseStatusPixel() {
 #ifdef USE_STATUS_NEOPIXEL
   delete statusPixel; // Deallocate Adafruit_NeoPixel object, set data pin back
                       // to INPUT.
diff --git a/src/components/statusLED/Wippersnapper_StatusLED.h b/src/components/statusLED/Wippersnapper_StatusLED.h
@@ -60,7 +60,7 @@ typedef enum ws_led_status_t {
 
 // Status LED
 void initStatusLED();
-void releaseStatusLED();
+void ReleaseStatusPixel();
 int16_t getStatusNeoPixelPin();
 int16_t getStatusDotStarDataPin();
 uint32_t ledStatusStateToColor(ws_led_status_t statusState);

Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ void Wippersnapper_V2::provision() {`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`WsV2._display->enableLogging();`
`120`		`- releaseStatusLED(); // don't use status LED if we are using the display`
	`120`	`+ ReleaseStatusPixel(); // don't use status LED if we are using the display`
`121`	`121`	`// UI Setup`
`122`	`122`	`WsV2._ui_helper = new ws_display_ui_helper(WsV2._display);`
`123`	`123`	`WsV2._ui_helper->set_bg_black();`