🚧 WIP, digitalio - Implement remove pin API

Author: brentru

src/Wippersnapper_V2.cpp

@@ -347,9 +347,6 @@ bool cbDecodeBrokerToDevice(pb_istream_t *stream, const pb_field_t *field,
   case wippersnapper_signal_BrokerToDevice_digitalio_remove_tag:
     WS_DEBUG_PRINTLN("-> DigitalIO Remove Message Type");
     break;
-  case wippersnapper_signal_BrokerToDevice_digitalio_event_tag:
-    WS_DEBUG_PRINTLN("-> DigitalIO Event Message Type");
-    break;
   case wippersnapper_signal_BrokerToDevice_digitalio_write_tag:
     WS_DEBUG_PRINTLN("-> DigitalIO Write Message Type");
     if (!WsV2.digital_io_controller->WriteDigitalIOPin(stream)) {

src/components/digitalIO/controller.cpp

@@ -128,6 +128,36 @@ bool DigitalIOController::AddDigitalIOPin(pb_istream_t *stream) {
   return true;
 }
 
+/***********************************************************************/
+/*!
+    @brief  Removes a digital pin from the controller, if it exists
+    @param  stream
+            The nanopb input stream.
+    @return True if the digital pin was successfully removed.
+*/
+/***********************************************************************/
+bool DigitalIOController::RemoveDigitalIOPin(pb_istream_t *stream) {
+  // Attempt to decode the DigitalIORemove message
+  if (!_dio_model->DecodeDigitalIORemove(stream)) {
+    WS_DEBUG_PRINTLN("ERROR: Unable to decode DigitalIORemove message!");
+    return false;
+  }
+
+  // Get the pin's name
+  int pin_name = atoi(_dio_model->GetDigitalIOAddMsg()->pin_name + 1);
+
+  // Bail out if the pin does not exist within controller
+  if (GetPinIdx(pin_name) == -1) {
+    WS_DEBUG_PRINTLN(
+        "ERROR: Unable to find digital output pin on the controller!");
+    return false;
+  }
+
+  // Deinitialize the pin
+  _dio_hardware->deinit(pin_name);
+  return true;
+}
+
 /***********************************************************************/
 /*!
     @brief  Get the index of a digital output pin

src/components/digitalIO/controller.h

@@ -53,6 +53,7 @@ class DigitalIOController {
   // Decoder-related Functions
   bool AddDigitalIOPin(pb_istream_t *stream);
   bool WriteDigitalIOPin(pb_istream_t *stream);
+  bool RemoveDigitalIOPin(pb_istream_t *stream);
   // Encoder-related Functions
   void Update();
   bool EncodePublishPinEvent(uint8_t pin_name, bool pin_value);

src/components/digitalIO/model.cpp

@@ -43,6 +43,22 @@ wippersnapper_digitalio_DigitalIOAdd *DigitalIOModel::GetDigitalIOAddMsg() {
   return &_msg_dio_add;
 }
 
+/***********************************************************************/
+/*!
+    @brief  Parses a DigitalIORemove message.
+    @return DigitalIORemove message object.
+*/
+/***********************************************************************/
+bool DigitalIOModel::DecodeDigitalIORemove(pb_istream_t *stream) {
+  // Zero-out the DigitalIORemove message struct. to ensure we don't have any
+  // old data
+  _msg_dio_remove = wippersnapper_digitalio_DigitalIORemove_init_default;
+
+  // Decode the stream into a DigitalIORemove message
+  return pb_decode(stream, wippersnapper_digitalio_DigitalIORemove_fields,
+                   &_msg_dio_remove);
+}
+
 /***********************************************************************/
 /*!
     @brief  Gets a DigitalIORemove message.

src/components/digitalIO/model.h

@@ -30,6 +30,7 @@ class DigitalIOModel {
   bool DecodeDigitalIOAdd(pb_istream_t *stream);
   wippersnapper_digitalio_DigitalIOAdd *GetDigitalIOAddMsg();
   // DigitalIORemove
+  bool DecodeDigitalIORemove(pb_istream_t *stream);
   wippersnapper_digitalio_DigitalIORemove *GetDigitalIORemove();
   // DigitalIOWrite
   bool DecodeDigitalIOWrite(pb_istream_t *stream);