fix reset pin for portenta machine control

Author: fabik111

README.md

@@ -35,8 +35,8 @@ The procedure:
 * `Arduino GIGA R1 WiFi`: short the pin 7 to GND until the led turns off
 * `Arduino Nano RP2040 Connect`: short the pin 2 to 3.3V until the led turns off
 * `Arduino Portenta H7`: short the pin 0 to GND until the led turns off
+* `Portenta Machine Control`: plug the device to a 24V power source, short the pin Digital Inputs 0 to 24VOUT until the led (`LED_BUILTIN`) turns off
 * Other boards: short the pin 2 to GND until the led turns off
-* `Portenta Machine Control`: currently the reset procedure is not available
 
 ### More on the reconfiguration pin
 Internally, the pin indicated in the procedure is set as `INPUT_PULLUP` (except for `Arduino Opta` ) and it's attached to an ISR fired on every change of the pin's status.
@@ -47,6 +47,10 @@ In order to be notified when the ISR is fired, it's possible to register a callb
 In order to change the default pin for resetting the board, it's possible to use the function `NetworkConfigurator.setReconfigurePin(your_pin)` specifying the new pin.
 The pin must be in the list of digital pins usable for interrupts. Please refer to the Arduino documentation for more details: https://docs.arduino.cc/language-reference/en/functions/external-interrupts/attachInterrupt/
 
+N.B.: For `Portenta Machine Control`, the pin must be one of the Digital Inputs 0-7.
+      The parameter must be one of the range DIN_READ_CH_PIN_00-DIN_READ_CH_PIN_07.
+      The defines are available in the Portenta Machine Control library and you must include Arduino_PortentaMachineControl.h for having access to them.
+
 ### Disable the reconfiguration feature
 In order to disable the reconfiguration procedure, use this function in the sketch `NetworkConfigurator.setReconfigurePin(DISABLE_PIN)`
 

examples/NetworkConfiguratorDemo/NetworkConfiguratorDemo.ino

@@ -22,7 +22,8 @@
  * - Arduino GIGA R1 WiFi: short the pin 7 to GND until the led turns off
  * - Arduino Nano RP2040 Connect: short the pin 2 to 3.3V until the led turns off
  * - Portenta H7: short the pin 0 to GND until the led turns off
- * - Portenta Machine Control: the reset is not available
+ * - Portenta Machine Control: plug the device to a 24V power source, short the pin Digital Inputs 0
+ *                             to 24VOUT until the led (`LED_BUILTIN`) turns off
  * - Other boards: short the pin 2 to GND until the led turns off
  *
  * In this sketch the BLE and Serial interfaces are always enabled and ready for accepting
@@ -78,6 +79,10 @@ void setup() {
   * The pin must be in the list of digital pins usable for interrupts.
   * Please refer to the Arduino documentation for more details:
   * https://docs.arduino.cc/language-reference/en/functions/external-interrupts/attachInterrupt/
+  * N.B.: For Portenta Machine Control, the pin must be one of the Digital Inputs 0-7.
+  * The parameter must be one of the range DIN_READ_CH_PIN_00-DIN_READ_CH_PIN_07.
+  * The defines are available in the Portenta Machine Control library and you must include
+  * Arduino_PortentaMachineControl.h for having access to them.
   */
   //NetworkConfigurator.setReconfigurePin(your_pin);
 

src/Arduino_NetworkConfigurator.cpp

@@ -41,7 +41,7 @@ NetworkConfiguratorClass::NetworkConfiguratorClass(ConnectionHandler &connection
       _receivedEvent = NetworkConfiguratorEvents::NONE;
       _optionUpdateTimer.begin(NC_UPDATE_NETWORK_OPTIONS_TIMER_ms); //initialize the timer before calling begin
       _agentsManager = &AgentsManagerClass::getInstance();
-      _resetInput = &ResetInput::getInstance();
+      _resetInput = &ResetInputBase::getInstance();
       _ledFeedback = &LEDFeedbackClass::getInstance();
 }
 
@@ -123,7 +123,8 @@ NetworkConfiguratorStates NetworkConfiguratorClass::update() {
    * - Arduino GIGA R1 WiFi: short the pin 7 to GND until the led turns off
    * - Arduino Nano RP2040 Connect: short the pin 2 to 3.3V until the led turns off
    * - Portenta H7: short the pin 0 to GND until the led turns off
-   * - Portenta Machine Control: the reset is not available
+   * - Portenta Machine Control: plug the device to a 24V power source, short the pin Digital Inputs 0
+   *                             to 24VOUT until the led (`LED_BUILTIN`) turns off
    * - Other boards: short the pin 2 to GND until the led turns off
    */
 
@@ -210,7 +211,7 @@ void NetworkConfiguratorClass::setReconfigurePin(int pin) {
   _resetInput->setPin(pin);
 }
 
-void NetworkConfiguratorClass::addReconfigurePinCallback(ResetInput::ResetInputCallback callback) {
+void NetworkConfiguratorClass::addReconfigurePinCallback(ResetInputBase::ResetInputCallback callback) {
   _resetInput->setPinChangedCallback(callback);
 }
 

src/Arduino_NetworkConfigurator.h

@@ -16,7 +16,7 @@
 #include <connectionHandlerModels/settings.h>
 #include <Arduino_TimedAttempt.h>
 #include <Arduino_KVStore.h>
-#include "utility/ResetInput.h"
+#include "utility/ResetInputBase.h"
 #include "utility/LEDFeedback.h"
 
 /**
@@ -59,7 +59,8 @@ enum class NetworkConfiguratorStates { ZERO_TOUCH_CONFIG,
  * - Arduino GIGA R1 WiFi: short the pin 7 to GND until the led turns off
  * - Arduino Nano RP2040 Connect: short the pin 2 to 3.3V until the led turns off
  * - Portenta H7: short the pin 0 to GND until the led turns off
- * - Portenta Machine Control: the reset is not available
+ * - Portenta Machine Control: plug the device to a 24V power source, short the pin Digital Inputs 0
+ *                             to 24VOUT until the led (`LED_BUILTIN`) turns off
  * - Other boards: short the pin 2 to GND until the led turns off
  *
  */
@@ -121,6 +122,10 @@ class NetworkConfiguratorClass {
    * The pin must be in the list of digital pins usable for interrupts.
    * Please refer to the Arduino documentation for more details:
    * https://docs.arduino.cc/language-reference/en/functions/external-interrupts/attachInterrupt/
+   * N.B.: For Portenta Machine Control, the pin must be one of the Digital Inputs 0-7.
+   * The parameter must be one of the range DIN_READ_CH_PIN_00-DIN_READ_CH_PIN_07.
+   * The defines are available in the Portenta Machine Control library and you must include
+   * Arduino_PortentaMachineControl.h for having access to them.
    */
   void setReconfigurePin(int pin);
 
@@ -129,7 +134,7 @@ class NetworkConfiguratorClass {
    * interrupt on the reconfiguration pin is fired.
    * @param callback Pointer to the callback function.
    */
-  void addReconfigurePinCallback(ResetInput::ResetInputCallback callback);
+  void addReconfigurePinCallback(ResetInputBase::ResetInputCallback callback);
 
   /**
    * @brief Checks if a specific configuration agent is enabled.
@@ -165,7 +170,7 @@ class NetworkConfiguratorClass {
   static inline models::NetworkSetting _networkSetting;
   bool _connectionHandlerIstantiated;
   bool _configInProgress;
-  ResetInput *_resetInput;
+  ResetInputBase *_resetInput;
   LEDFeedbackClass *_ledFeedback;
   /* Timeout instances */
   // Timeout for connection attempt

src/utility/ResetInput.cpp

@@ -8,68 +8,82 @@
 
 #pragma once
 
-#include "Arduino.h"
-#include <functional>
+#include "ANetworkConfigurator_Config.h"
+#include "ResetInputBase.h"
+#include "LEDFeedback.h"
 
-#define DISABLE_PIN -1
-
-/**
- * @class ResetInput
- * @brief A singleton class to handle input of the reset functionality with interrupt-based monitoring.
- *
- * This class provides methods to configure and monitor a reset input pin. It allows
- * setting up a custom callback function to be executed when the pin status changes.
- */
-class ResetInput{
+class ResetInput : public ResetInputBase {
 public:
-  /**
-   * @typedef ResetInput::ResetInputCallback
-   * @brief A type definition for the callback function to be executed on pin status change.
-   */
-  typedef std::function<void()> ResetInputCallback;
-  /**
-   * @brief Get the singleton instance of the ResetInput class.
-   * @return A reference to the ResetInput instance.
-   */
-  static ResetInput& getInstance();
-  /**
-   * @brief Initialize the reset input by setting up the interrupt pin.
-   */
-  void begin();
-  /**
-   * @brief Check if the reset event has been fired.
-   * @return True if the event is fired, otherwise false.
-   */
-  bool isEventFired();
-  /**
-   * @brief Set a custom callback function to be called when the pin status changes.
-   * This function must be called before invoking the `begin` method.
-   * @param callback The custom callback function to be executed.
-   */
-  void setPinChangedCallback(ResetInputCallback callback);
-  /**
-   * @brief Set the pin to be monitored for reset events.
-   * By default, the pin is set as INPUT_PULLUP.
-   * Use the value DISABLE_PIN to disable the pin and the reset procedure.
-   * This function must be called before invoking the `begin` method.
-   * @param pin The pin number to be monitored. The pin must
-   * be in the list of digital pins usable for interrupts.
-   * Please refer to the Arduino documentation for more details:
-   * https://docs.arduino.cc/language-reference/en/functions/external-interrupts/attachInterrupt/
-   */
-  void setPin(int pin);
+  static ResetInput &getInstance() {
+    static ResetInput instance;
+    return instance;
+  }
+
+  void begin() override {
+    if(_pin == DISABLE_PIN){
+      return;
+    }
+  #ifdef ARDUINO_OPTA
+    pinMode(_pin, INPUT);
+  #else
+    pinMode(_pin, INPUT_PULLUP);
+  #endif
+    pinMode(LED_RECONFIGURE, OUTPUT);
+    digitalWrite(LED_RECONFIGURE, LED_OFF);
+    attachInterrupt(digitalPinToInterrupt(_pin),_pressedCallback, CHANGE);
+  }
+
+  bool isEventFired() override  {
+    if(_startPressed != 0){
+  #if defined(ARDUINO_NANO_RP2040_CONNECT) || defined(ARDUINO_SAMD_MKRWIFI1010)
+      LEDFeedbackClass::getInstance().stop();
+  #endif
+      if(micros() - _startPressed > RESET_HOLD_TIME){
+        digitalWrite(LED_RECONFIGURE, LED_OFF);
+        _expired = true;
+      }
+    }
+
+    return _fireEvent;
+  }
+
 private:
-  /**
-   * @brief Private constructor to enforce the singleton pattern.
-   */
-  ResetInput();
-  static inline ResetInputCallback _pressedCustomCallback;
-  static inline int _pin;
+  ResetInput() {
+    _pin = PIN_RECONFIGURE;
+    _expired = false;
+    _startPressed = 0;
+    _fireEvent = false;
+  }
   static inline volatile bool _expired;
   static inline volatile bool _fireEvent;
   static inline volatile uint32_t _startPressed;
   /**
    * @brief Internal callback function to handle pin press events.
    */
-  static void _pressedCallback();
+  static void _pressedCallback() {
+  #if defined(ARDUINO_NANO_RP2040_CONNECT)
+    if(digitalRead(_pin) == HIGH){
+  #else
+    if(digitalRead(_pin) == LOW){
+  #endif
+  #if !defined(ARDUINO_NANO_RP2040_CONNECT) && !defined(ARDUINO_SAMD_MKRWIFI1010)
+      LEDFeedbackClass::getInstance().stop();
+  #endif
+      _startPressed = micros();
+      digitalWrite(LED_RECONFIGURE, LED_ON);
+    } else {
+      digitalWrite(LED_RECONFIGURE, LED_OFF);
+      if(_startPressed != 0 && _expired){
+        _fireEvent = true;
+      }else{
+        LEDFeedbackClass::getInstance().restart();
+      }
+      _startPressed = 0;
+    }
+
+    if (_pressedCustomCallback) {
+      _pressedCustomCallback();
+    }
+  }
 };
+