add the reset procedure (#39)

fix reset routine for nina boards

fixes for ledFeedback and reset procedure

Author: fabik111

examples/auto-retry/auto-retry.ino

@@ -79,7 +79,7 @@ void setup() {
 
 void loop() {
   if (provisioningCompleted && networkConfigured) {
-    NetworkConfigurator.configurationCompleted();
+    NetworkConfigurator.disconnectAgent();
     if (NetworkConfigurator.isBLEenabled()) {
       NetworkConfigurator.enableBLE(false);
     }

examples/network-setting/network-setting.ino

@@ -31,7 +31,7 @@ DeviceMode deviceMode = DeviceMode::CONFIG;
 void changeMode(DeviceMode nextMode){
   if(nextMode == DeviceMode::RUN){
     if(deviceMode == DeviceMode::CONFIG){
-      NetworkConfigurator.configurationCompleted();
+      NetworkConfigurator.disconnectAgent();
       if (NetworkConfigurator.isBLEenabled()) {
         NetworkConfigurator.enableBLE(false);
       }

src/NetworkConfigurator.cpp

@@ -23,6 +23,7 @@
 #define NC_UPDATE_NETWORK_OPTIONS_TIMER_ms 120000
 
 constexpr char *STORAGE_KEY{ "NETWORK_CONFIGS" };
+constexpr char *START_BLE_AT_STARTUP_KEY{ "START_BLE" };
 
 NetworkConfiguratorClass::NetworkConfiguratorClass(ConnectionHandler &connectionHandler)
   :
@@ -32,6 +33,7 @@ NetworkConfiguratorClass::NetworkConfiguratorClass(ConnectionHandler &connection
     _optionUpdateTimer{ NC_UPDATE_NETWORK_OPTIONS_TIMER_ms, NC_UPDATE_NETWORK_OPTIONS_TIMER_ms } {
       _optionUpdateTimer.begin(NC_UPDATE_NETWORK_OPTIONS_TIMER_ms); //initialize the timer before calling begin
       _agentsManager = &AgentsManagerClass::getInstance();
+      _resetInput = &ResetInput::getInstance();
 }
 
 bool NetworkConfiguratorClass::begin() {
@@ -71,6 +73,7 @@ bool NetworkConfiguratorClass::begin() {
 
   _connectionTimeout.begin(NC_CONNECTION_TIMEOUT_ms);
   _connectionRetryTimer.begin(NC_CONNECTION_RETRY_TIMER_ms);
+  _resetInput->begin();
 
 #ifdef BOARD_HAS_ETHERNET
   _networkSetting.type = NetworkAdapter::ETHERNET;
@@ -110,6 +113,18 @@ NetworkConfiguratorStates NetworkConfiguratorClass::poll() {
     _state = nextState;
   }
 
+  /* Reconfiguration procedure:
+   * - Arduino Opta: press and hold the user button (BTN_USER) until the led (LED_USER) turns off
+   * - Arduino Nano 33 IOT: short the pin 2 to GND until the led turns off
+   * - Arduino Uno R4 WiFi: short the pin 2 to GND until the led turns off
+   * - Arduino Nano RP2040 Connect: short the pin 2 to 3.3V until the led turns off
+   * - Other boards: short the pin 7 to GND until the led turns off
+   */
+
+  if(_resetInput->isEventFired()) {
+    startReconfigureProcedure();
+  }
+
   return _state;
 }
 
@@ -153,15 +168,24 @@ bool NetworkConfiguratorClass::end() {
   return _agentsManager->end(SERVICE_ID_FOR_AGENTMANAGER);
 }
 
+void NetworkConfiguratorClass::setReconfigurePin(uint32_t pin) {
+  _resetInput->setPin(pin);
+}
+
+void NetworkConfiguratorClass::addReconfigurePinCallback(void (*callback)()) {
+  _resetInput->setPinChangedCallback(callback);
+}
+
 bool NetworkConfiguratorClass::isBLEenabled() {
   return _agentsManager->isBLEAgentEnabled();
 }
 
 void NetworkConfiguratorClass::enableBLE(bool enable) {
+  _bleEnabled = enable;
   _agentsManager->enableBLEAgent(enable);
 }
 
-void NetworkConfiguratorClass::configurationCompleted() {
+void NetworkConfiguratorClass::disconnectAgent() {
   _agentsManager->disconnect();
 }
 
@@ -404,6 +428,19 @@ void NetworkConfiguratorClass::handleGetWiFiFWVersion() {
   _agentsManager->sendMsg(fwVersionMsg);
 }
 
+void NetworkConfiguratorClass::startReconfigureProcedure() {
+  resetStoredConfiguration();
+  if(_kvstore != nullptr){
+    if (_kvstore->begin()) {
+      if(!_kvstore->putBool(START_BLE_AT_STARTUP_KEY, true)){
+        DEBUG_ERROR("NetworkConfiguratorClass::%s Error saving BLE enabled at startup", __FUNCTION__);
+      }
+      _kvstore->end();
+    }
+  }
+  NVIC_SystemReset();
+}
+
 #ifdef BOARD_HAS_ETHERNET
 NetworkConfiguratorStates NetworkConfiguratorClass::handleCheckEth() {
   NetworkConfiguratorStates nextState = _state;
@@ -445,6 +482,12 @@ NetworkConfiguratorStates NetworkConfiguratorClass::handleReadStorage() {
       }
 
     } else {
+      if(_kvstore->exists(START_BLE_AT_STARTUP_KEY)) {
+        if(_kvstore->getBool(START_BLE_AT_STARTUP_KEY)) {
+          _agentsManager->enableBLEAgent(true);
+        }
+        _kvstore->remove(START_BLE_AT_STARTUP_KEY);
+      }
       nextState = NetworkConfiguratorStates::WAITING_FOR_CONFIG;
     }
     _kvstore->end();
@@ -492,6 +535,9 @@ NetworkConfiguratorStates NetworkConfiguratorClass::handleConnecting() {
   ConnectionResult res = connectToNetwork(&err);
 
   if (res == ConnectionResult::SUCCESS) {
+    if(_agentsManager->isBLEAgentEnabled() && !_bleEnabled) {
+      _agentsManager->enableBLEAgent(false);
+    }
     nextState = NetworkConfiguratorStates::CONFIGURED;
   } else if (res == ConnectionResult::FAILED) {
     sendStatus(err);

src/NetworkConfigurator.h

@@ -16,6 +16,7 @@
 #include <settings/settings.h>
 #include <Arduino_TimedAttempt.h>
 #include <Arduino_KVStore.h>
+#include "Utility/ResetInput/ResetInput.h"
 
 enum class NetworkConfiguratorStates { CHECK_ETH,
                                        READ_STORED_CONFIG,
@@ -37,16 +38,20 @@ class NetworkConfiguratorClass {
     _kvstore = &kvstore;
   }
 
+  void setReconfigurePin(uint32_t pin);
+  void addReconfigurePinCallback(void (*callback)());
   bool isBLEenabled();
   void enableBLE(bool enable);
-  void configurationCompleted();
+  void disconnectAgent();
   bool addAgent(ConfiguratorAgent &agent);
 
 private:
   NetworkConfiguratorStates _state = NetworkConfiguratorStates::END;
   ConnectionHandler *_connectionHandler;
   static inline models::NetworkSetting _networkSetting;
   bool _connectionHandlerIstantiated = false;
+  ResetInput *_resetInput;
+  bool _bleEnabled = true;
   TimedAttempt _connectionTimeout;
   TimedAttempt _connectionRetryTimer;
   TimedAttempt _optionUpdateTimer;
@@ -77,6 +82,8 @@ class NetworkConfiguratorClass {
   NetworkConfiguratorStates handleConnectRequest();
   void handleGetWiFiFWVersion();
 
+  void startReconfigureProcedure();
+
   String decodeConnectionErrorMessage(NetworkConnectionState err, StatusMessage *errorCode);
   ConnectionResult connectToNetwork(StatusMessage *err);
   ConnectionResult disconnectFromNetwork();

src/Utility/LEDFeedback/LEDFeedback.cpp

@@ -225,7 +225,20 @@ void LEDFeedbackClass::setMode(LEDFeedbackMode mode) {
   }
 }
 
+void LEDFeedbackClass::stop() {
+  stopped = true;
+  turnOFF();
+}
+
+void LEDFeedbackClass::restart() {
+  stopped = false;
+}
+
 void LEDFeedbackClass::poll() {
+  if(stopped) {
+    return;
+  }
+
   if(_ledChangeInterval == 0) {
     turnOFF();
     return;

src/Utility/LEDFeedback/LEDFeedback.h

@@ -23,6 +23,8 @@ class LEDFeedbackClass {
     static LEDFeedbackClass& getInstance();
     void begin();
     void setMode(LEDFeedbackMode mode);
+    void stop();
+    void restart();
     void poll();
 private:
     LEDFeedbackClass() {};
@@ -35,4 +37,5 @@ class LEDFeedbackClass {
     uint16_t _ledPin = 0;
     uint32_t* _framePtr = nullptr;
     int32_t _ledChangeInterval = 500;
+    bool stopped = false;
 };

src/Utility/ResetInput/ResetInput.cpp

@@ -0,0 +1,112 @@
+/*
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#include "ResetInput.h"
+#include "Utility/LEDFeedback/LEDFeedback.h"
+
+#ifdef ARDUINO_OPTA
+#define PIN_RECONFIGURE BTN_USER
+#define LED_RECONFIGURE LED_USER
+#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_UNOR4_WIFI) || defined(ARDUINO_NANO_RP2040_CONNECT)
+#define PIN_RECONFIGURE 2
+#define LED_RECONFIGURE LED_BUILTIN
+#else
+#define PIN_RECONFIGURE 7
+#define LED_RECONFIGURE LED_BUILTIN
+#endif
+
+#ifndef RESET_HOLD_TIME
+#define RESET_HOLD_TIME 3000000
+#endif
+
+ResetInput &ResetInput::getInstance() {
+  static ResetInput instance;
+  return instance;
+}
+
+ResetInput::ResetInput():
+  _pin {PIN_RECONFIGURE}
+  {
+    _pressed = false;
+    _startPressed = 0;
+    _fireEvent = false;
+    _pressedCustomCallback = nullptr;
+  }
+
+void ResetInput::begin() {
+#ifdef ARDUINO_OPTA
+  pinMode(PIN_RECONFIGURE, INPUT);
+#else
+  pinMode(PIN_RECONFIGURE, INPUT_PULLUP);
+#endif
+  pinMode(LED_RECONFIGURE, OUTPUT);
+
+  attachInterrupt(digitalPinToInterrupt(PIN_RECONFIGURE),_pressedCallback, CHANGE);
+}
+
+bool ResetInput::isEventFired() {
+  if(_pressed){
+#if defined(ARDUINO_NANO_RP2040_CONNECT) || defined(ARDUINO_SAMD_MKRWIFI1010)
+    LEDFeedbackClass::getInstance().stop();
+#endif
+    if(micros() - _startPressed > RESET_HOLD_TIME){
+#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_GIGA)
+    digitalWrite(LED_RECONFIGURE, HIGH);
+#else
+    digitalWrite(LED_RECONFIGURE, LOW);
+#endif
+    }
+  }
+
+  return _fireEvent;
+}
+
+void ResetInput::setPinChangedCallback(void (*callback)()) {
+  _pressedCustomCallback = callback;
+}
+
+void ResetInput::setPin(uint32_t pin) {
+  _pin = pin;
+}
+
+void ResetInput::_pressedCallback() {
+#if defined(ARDUINO_NANO_RP2040_CONNECT)
+  if(digitalRead(PIN_RECONFIGURE) == HIGH){
+#else
+  if(digitalRead(PIN_RECONFIGURE) == LOW){
+#endif
+#if !defined(ARDUINO_NANO_RP2040_CONNECT) && !defined(ARDUINO_SAMD_MKRWIFI1010)
+    LEDFeedbackClass::getInstance().stop();
+#endif
+    _startPressed = micros();
+    _pressed = true;
+#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_GIGA)
+    digitalWrite(LED_RECONFIGURE, LOW);
+#else
+    digitalWrite(LED_RECONFIGURE, HIGH);
+#endif
+  } else {
+#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_GIGA)
+    digitalWrite(LED_RECONFIGURE, HIGH);
+#else
+    digitalWrite(LED_RECONFIGURE, LOW);
+#endif
+
+    _pressed = false;
+    if(_startPressed != 0 && micros() - _startPressed > RESET_HOLD_TIME){
+      _fireEvent = true;
+    }else{
+      LEDFeedbackClass::getInstance().restart();
+    }
+    _startPressed = 0;
+  }
+
+  if (_pressedCustomCallback) {
+    _pressedCustomCallback();
+  }
+}

src/Utility/ResetInput/ResetInput.h

@@ -0,0 +1,32 @@
+/*
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#pragma once
+
+#include "Arduino.h"
+
+class ResetInput{
+public:
+  static ResetInput& getInstance();
+  // Setup the interrupt pin
+  void begin();
+  // Monitor if the event is fired
+  bool isEventFired();
+  // Add a custom function to be called when the pin status changes. It must be set before calling the begin method
+  void setPinChangedCallback(void (*callback)());
+  // Set the pin to be monitored. It must be set before calling the begin method
+  void setPin(uint32_t pin);
+private:
+  ResetInput();
+  static inline void (*_pressedCustomCallback)();
+  uint32_t _pin;
+  static inline volatile bool _pressed;
+  static inline volatile bool _fireEvent;
+  static inline volatile uint32_t _startPressed;
+  static void _pressedCallback();
+};