Full PWM implementation, sans writemulti..

Author: brentru

src/Wippersnapper_V2.cpp

@@ -439,21 +439,14 @@ bool cbDecodeBrokerToDevice(pb_istream_t *stream, const pb_field_t *field,
       return false;
     }
     break;
-  case wippersnapper_signal_BrokerToDevice_pwm_write_duty_cycle_tag:
+  case wippersnapper_signal_BrokerToDevice_pwm_write_duty_tag:
     WS_DEBUG_PRINTLN("-> PWM Write Duty Cycle Message Type");
     if (!WsV2._pwm_controller->Handle_PWM_Write_DutyCycle(stream)) {
       WS_DEBUG_PRINTLN("ERROR: Unable to write duty cycle to PWM pin!");
       return false;
     }
     break;
-  case wippersnapper_signal_BrokerToDevice_pwm_write_duty_cycle_multi_tag:
-    WS_DEBUG_PRINTLN("-> PWM Write Duty Cycle Multi Message Type");
-    if (!WsV2._pwm_controller->Handle_PWM_Write_DutyCycle_Multi(stream)) {
-      WS_DEBUG_PRINTLN("ERROR: Unable to write multi duty cycle to PWM pins!");
-      return false;
-    }
-    break;
-  case wippersnapper_signal_BrokerToDevice_pwm_write_frequency_tag:
+  case wippersnapper_signal_BrokerToDevice_pwm_write_freq_tag:
     WS_DEBUG_PRINTLN("-> PWM Write Frequency Message Type");
     if (!WsV2._pwm_controller->Handle_PWM_Write_Frequency(stream)) {
       WS_DEBUG_PRINTLN("ERROR: Unable to write frequency to PWM pin!");

src/components/pwm/controller.cpp

@@ -14,11 +14,21 @@
  */
 #include "controller.h"
 
+/**************************************************************************/
+/*!
+    @brief  Ctor for PWMController.
+*/
+/**************************************************************************/
 PWMController::PWMController() {
   _pwm_model = new PWMModel();
   _active_pwm_pins = 0;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Dtor for PWMController.
+*/
+/**************************************************************************/
 PWMController::~PWMController() { delete _pwm_model; }
 
 /**************************************************************************/
@@ -63,6 +73,40 @@ bool PWMController::Handle_PWM_Add(pb_istream_t *stream) {
   return true;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Handles the PWM_Remove message.
+    @param  stream The stream containing the message data.
+    @return True if the message was handled successfully, false otherwise.
+*/
+/**************************************************************************/
+bool PWMController::Handle_PWM_Remove(pb_istream_t *stream) {
+  if (!_pwm_model->DecodePWMRemove(stream)) {
+    WS_DEBUG_PRINTLN("[pwm] Error: Failed to decode PWMRemove message!");
+    return false;
+  }
+  wippersnapper_pwm_PWMRemove msg_remove = *_pwm_model->GetPWMRemoveMsg();
+  uint8_t pin = atoi(msg_remove.pin + 1);
+  // Check if the pin is already attached
+  int pin_idx = GetPWMHardwareIdx(pin);
+  if (pin_idx == -1) {
+    WS_DEBUG_PRINTLN("[pwm] Error: pin not found!");
+    return false;
+  }
+
+  // Detach and free the pin
+  _pwm_hardware[pin_idx]->DetachPin();
+  delete _pwm_hardware[pin_idx];
+  _pwm_hardware[pin_idx] = nullptr;
+
+  // Update _active_pwm_pins[]
+  _active_pwm_pins--;
+  for (int i = pin_idx; i < _active_pwm_pins; i++) {
+    _pwm_hardware[i] = _pwm_hardware[i + 1];
+  }
+  return true;
+}
+
 /**************************************************************************/
 /*!
     @brief  Returns the index of the PWM hardware object that corresponds
@@ -80,6 +124,13 @@ int PWMController::GetPWMHardwareIdx(uint8_t pin) {
   return -1;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Handles the PWM_Write_DutyCycle message.
+    @param  stream The stream containing the message data.
+    @return True if the message was handled successfully, false otherwise.
+*/
+/**************************************************************************/
 bool PWMController::Handle_PWM_Write_DutyCycle(pb_istream_t *stream) {
   if (!_pwm_model->DecodePWMWriteDutyCycle(stream)) {
     WS_DEBUG_PRINTLN(
@@ -111,10 +162,24 @@ bool PWMController::Handle_PWM_Write_DutyCycle(pb_istream_t *stream) {
   return true;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Handles the PWM_Write_DutyCycle_Multi message.
+    @param  stream The stream containing the message data.
+    @return True if the message was handled successfully, false otherwise.
+*/
+/**************************************************************************/
 bool PWMController::Handle_PWM_Write_DutyCycle_Multi(pb_istream_t *stream) {
   return false;
 }
 
+/**************************************************************************/
+/*!
+    @brief  Handles the PWM_Write_Frequency message.
+    @param  stream The stream containing the message data.
+    @return True if the message was handled successfully, false otherwise.
+*/
+/**************************************************************************/
 bool PWMController::Handle_PWM_Write_Frequency(pb_istream_t *stream) {
   if (!_pwm_model->DecodePWMWriteFrequency(stream)) {
     WS_DEBUG_PRINTLN(
@@ -141,6 +206,4 @@ bool PWMController::Handle_PWM_Write_Frequency(pb_istream_t *stream) {
   WS_DEBUG_PRINTLN(" to pin: ");
   WS_DEBUG_PRINT(msg_write_frequency.pin);
   return true;
-}
-
-bool PWMController::Handle_PWM_Remove(pb_istream_t *stream) { return false; }
+}

src/components/pwm/hardware.cpp

@@ -79,6 +79,7 @@ bool PWMHardware::DetachPin() {
 
     // "Disable" the pin's output
     digitalWrite(_pin, LOW);
+    return did_detach;
 }
 
 /**************************************************************************/

src/components/pwm/model.cpp

@@ -51,7 +51,6 @@ PWMModel::~PWMModel() {
 /**************************************************************************/
 bool PWMModel::DecodePWMAdd(pb_istream_t *stream) {
   memset(&_msg_pwm_add, 0, sizeof(_msg_pwm_add));
-  // Attempt to decode the stream into a pwm_PWMAdd message
   return pb_decode(stream, wippersnapper_pwm_PWMAdd_fields, &_msg_pwm_add);
 }
 
@@ -98,11 +97,26 @@ wippersnapper_pwm_PWMAdded *PWMModel::GetPWMAddedMsg() {
   return &_msg_pwm_added;
 }
 
+/**************************************************************************/
+/*! 
+    @brief  Decodes a PWMRemove message from an input stream.
+    @param  stream  The stream to decode from.
+    @return true if successful, false otherwise.
+*/
+/**************************************************************************/
 bool PWMModel::DecodePWMRemove(pb_istream_t *stream) {
-  return false;
+  memset(&_msg_pwm_remove, 0, sizeof(_msg_pwm_remove));
+  return pb_decode(stream, wippersnapper_pwm_PWMRemove_fields, &_msg_pwm_remove);
 }
 
+/**************************************************************************/
+/*! 
+    @brief  Returns a pointer to the PWMRemove message.
+    @return Pointer to the PWMRemove message.
+*/
+/**************************************************************************/
 wippersnapper_pwm_PWMRemove *PWMModel::GetPWMRemoveMsg() {
+  return &_msg_pwm_remove;
 }
 
 /**************************************************************************/
@@ -127,18 +141,45 @@ wippersnapper_pwm_PWMWriteDutyCycle *PWMModel::GetPWMWriteDutyCycleMsg() {
   return &_msg_pwm_write_duty_cycle;
 }
 
+/**************************************************************************/
+/*! 
+    @brief  Decodes a PWMWriteDutyCycleMulti message from an input stream.
+    @param  stream  The stream to decode from.
+    @return true if successful, false otherwise.
+*/
+/**************************************************************************/
 bool PWMModel::DecodePWMWriteDutyCycleMulti(pb_istream_t *stream) {
   return false;
 }
 
+/**************************************************************************/
+/*! 
+    @brief  Returns a pointer to the PWMWriteDutyCycleMulti message.
+    @return Pointer to the PWMWriteDutyCycleMulti message.
+*/
+/**************************************************************************/
 wippersnapper_pwm_PWMWriteDutyCycleMulti *PWMModel::GetPWMWriteDutyCycleMultiMsg() {
+    return &_msg_pwm_write_duty_cycle_multi;
 }
 
+/**************************************************************************/
+/*! 
+    @brief  Decodes a PWMWriteFrequency message from an input stream.
+    @param  stream  The stream to decode from.
+    @return true if successful, false otherwise.
+*/
+/**************************************************************************/
 bool PWMModel::DecodePWMWriteFrequency(pb_istream_t *stream) {
   memset(&_msg_pwm_write_frequency, 0, sizeof(_msg_pwm_write_frequency));
   return pb_decode(stream, wippersnapper_pwm_PWMWriteFrequency_fields, &_msg_pwm_write_frequency);
 }
 
+/**************************************************************************/
+/*! 
+    @brief  Returns a pointer to the PWMWriteFrequency message.
+    @return Pointer to the PWMWriteFrequency message.
+*/
+/**************************************************************************/
 wippersnapper_pwm_PWMWriteFrequency *PWMModel::GetPWMWriteFrequencyMsg() {
   return &_msg_pwm_write_frequency;
 }