enable or disable every type of agent

Author: fabik111

src/Arduino_NetworkConfigurator.cpp

@@ -34,7 +34,6 @@ NetworkConfiguratorClass::NetworkConfiguratorClass(ConnectionHandler &connection
     _state{ NetworkConfiguratorStates::END },
     _connectionHandler{ &connectionHandler },
     _connectionHandlerIstantiated{ false },
-    _bleEnabled{ true },
     _kvstore{ nullptr },
     _connectionTimeout{ NC_CONNECTION_TIMEOUT_ms, NC_CONNECTION_TIMEOUT_ms },
     _connectionRetryTimer{ NC_CONNECTION_RETRY_TIMER_ms, NC_CONNECTION_RETRY_TIMER_ms },
@@ -200,13 +199,12 @@ void NetworkConfiguratorClass::addReconfigurePinCallback(ResetInput::ResetInputC
   _resetInput->setPinChangedCallback(callback);
 }
 
-bool NetworkConfiguratorClass::isBLEenabled() {
-  return _agentsManager->isBLEAgentEnabled();
+bool NetworkConfiguratorClass::isAgentEnabled(ConfiguratorAgent::AgentTypes type) {
+  return _agentsManager->isAgentEnabled(type);
 }
 
-void NetworkConfiguratorClass::enableBLE(bool enable) {
-  _bleEnabled = enable;
-  _agentsManager->enableBLEAgent(enable);
+void NetworkConfiguratorClass::enableAgent(ConfiguratorAgent::AgentTypes type, bool enable) {
+  _agentsManager->enableAgent(type, enable);
 }
 
 void NetworkConfiguratorClass::disconnectAgent() {
@@ -469,7 +467,7 @@ NetworkConfiguratorStates NetworkConfiguratorClass::handleReadStorage() {
 
   if(_kvstore->exists(START_BLE_AT_STARTUP_KEY)) {
     if(_kvstore->getBool(START_BLE_AT_STARTUP_KEY)) {
-      _agentsManager->enableBLEAgent(true);
+      _agentsManager->startAgent(ConfiguratorAgent::AgentTypes::BLE);
     }
     _kvstore->remove(START_BLE_AT_STARTUP_KEY);
   }
@@ -525,9 +523,6 @@ NetworkConfiguratorStates NetworkConfiguratorClass::handleConnecting() {
   ConnectionResult res = connectToNetwork(&err);
 
   if (res == ConnectionResult::SUCCESS) {
-    if(_agentsManager->isBLEAgentEnabled() && !_bleEnabled) {
-      _agentsManager->enableBLEAgent(false);
-    }
     return NetworkConfiguratorStates::CONFIGURED;
   } else if (res == ConnectionResult::FAILED) {
     sendStatus(err);

src/Arduino_NetworkConfigurator.h

@@ -11,7 +11,7 @@
 #if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include "Arduino.h"
-#include "GenericConnectionHandler.h"
+#include "GenericConnectionHandler.h"//TODO fix include
 #include "ConfiguratorAgents/AgentsManager.h"
 #include <settings/settings.h>
 #include <Arduino_TimedAttempt.h>
@@ -29,6 +29,7 @@ enum class NetworkConfiguratorStates { ZERO_TOUCH_CONFIG,
                                        END };
 
 /**
+ * @class NetworkConfiguratorClass
  * @brief Class responsible for managing the network configuration of an Arduino_ConnectionHandler instance.
  * The library provides a way to configure and update
  * the network settings using different interfaces like BLE, Serial, etc.
@@ -70,7 +71,7 @@ class NetworkConfiguratorClass {
 
   /**
    * @brief Resets the stored network configuration.
-   * This method is alternative to the reconfiguration procedure
+   * This method is an alternative to the reconfiguration procedure
    * without forcing the restart of the BLE interface if turned off.
    * @return True if the reset is successful, false otherwise.
    */
@@ -97,7 +98,7 @@ class NetworkConfiguratorClass {
 
   /**
    * @brief Sets the pin used for the reconfiguration procedure.
-   * It must be set before calling the begin() method.
+   * This must be set before calling the begin() method.
    * @param pin The pin number to be used for reconfiguration,
    * internally it's mapped to an interrupt with INPUT_PULLUP mode.
    */
@@ -111,25 +112,27 @@ class NetworkConfiguratorClass {
   void addReconfigurePinCallback(ResetInput::ResetInputCallback callback);
 
   /**
-   * @brief Checks if BLE (Bluetooth Low Energy) is enabled.
-   * @return True if BLE is enabled, false otherwise.
+   * @brief Checks if a specific configuration agent is enabled.
+   * @param type The type of the agent to check (e.g., BLE, Serial).
+   * @return True if the agent is enabled, false otherwise.
    */
-  bool isBLEenabled();
+  bool isAgentEnabled(ConfiguratorAgent::AgentTypes type);
 
   /**
-   * @brief Enables or disables BLE (Bluetooth Low Energy).
-   * @param enable True to enable BLE, false to disable it.
+   * @brief Enables or disables a specific configuration agent.
+   * @param type The type of the agent to enable or disable (e.g., BLE, Serial).
+   * @param enable True to enable the agent, false to disable it.
    */
-  void enableBLE(bool enable);
+  void enableAgent(ConfiguratorAgent::AgentTypes type, bool enable);
 
   /**
-   * @brief Disconnects the current agent from the peer.
+   * @brief Disconnects the current configuration agent from the peer.
    */
   void disconnectAgent();
 
   /**
    * @brief Adds a new configurator agent.
-   * Configurator agents handle the configuration interfaces BLE, Serial, etc.
+   * Configurator agents handle the configuration interfaces such as BLE, Serial, etc.
    * This method should be called before the begin() method.
    * @param agent Reference to a ConfiguratorAgent object.
    * @return True if the agent is added successfully, false otherwise.
@@ -143,7 +146,6 @@ class NetworkConfiguratorClass {
   bool _connectionHandlerIstantiated;
   ResetInput *_resetInput;
   LEDFeedbackClass *_ledFeedback;
-  bool _bleEnabled;
   TimedAttempt _connectionTimeout;
   TimedAttempt _connectionRetryTimer;
   TimedAttempt _optionUpdateTimer;

src/ConfiguratorAgents/AgentsManager.cpp

@@ -36,10 +36,8 @@ bool AgentsManagerClass::begin() {
   }
 
   for (std::list<ConfiguratorAgent *>::iterator agent = _agentsList.begin(); agent != _agentsList.end(); ++agent) {
-    if((*agent)->getAgentType() == ConfiguratorAgent::AgentTypes::BLE) {
-      if (!_bleAgentEnabled) {
-        continue;
-      }
+    if( _enabledAgents[(int)(*agent)->getAgentType()] == false) {
+      continue;
     }
     if ((*agent)->begin() == ConfiguratorAgent::AgentConfiguratorStates::ERROR) {
       DEBUG_ERROR("AgentsManagerClass::%s agent type %d fails", __FUNCTION__, (int)(*agent)->getAgentType());
@@ -64,21 +62,51 @@ AgentsManagerStates AgentsManagerClass::poll() {
   return _state;
 }
 
-void AgentsManagerClass::enableBLEAgent(bool enable) {
-  if (_bleAgentEnabled == enable) {
+void AgentsManagerClass::enableAgent(ConfiguratorAgent::AgentTypes type, bool enable) {
+  bool _agentState = _enabledAgents[(int)type];
+
+  if (_agentState == enable) {
     return;
   }
-  _bleAgentEnabled = enable;
 
+  _enabledAgents[(int)type] = enable;
   if (enable) {
-    startBLEAgent();
+    startAgent(type);
   } else {
-    stopBLEAgent();
+    stopAgent(type);
   }
 }
 
-bool AgentsManagerClass::isBLEAgentEnabled() {
-  return _bleAgentEnabled;
+bool AgentsManagerClass::isAgentEnabled(ConfiguratorAgent::AgentTypes type) {
+  return _enabledAgents[(int)type];
+}
+
+bool AgentsManagerClass::startAgent(ConfiguratorAgent::AgentTypes type) {
+  if (_state == AgentsManagerStates::END) {
+    return false;
+  }
+
+  for (std::list<ConfiguratorAgent *>::iterator agent = _agentsList.begin(); agent != _agentsList.end(); ++agent) {
+    if ((*agent)->getAgentType() == type) {
+      (*agent)->begin();
+      return true;
+    }
+  }
+  return false;
+}
+
+bool AgentsManagerClass::stopAgent(ConfiguratorAgent::AgentTypes type) {
+  for (std::list<ConfiguratorAgent *>::iterator agent = _agentsList.begin(); agent != _agentsList.end(); ++agent) {
+    if ((*agent)->getAgentType() == type) {
+      (*agent)->end();
+      if (*agent == _selectedAgent) {
+        handlePeerDisconnected();
+        _state = AgentsManagerStates::INIT;
+      }
+      return true;
+    }
+  }
+  return false;
 }
 
 bool AgentsManagerClass::end() {
@@ -187,11 +215,12 @@ AgentsManagerClass::AgentsManagerClass():
   _returnNetworkSettingsCb{ nullptr },
   _selectedAgent{ nullptr },
   _instances{ 0 },
-  _bleAgentEnabled{ true },
   _initStatusMsg{ StatusMessage::NONE },
   _statusRequest{ .completion = 0, .pending = false, .key = RequestType::NONE },
   _state{ AgentsManagerStates::END }
-  {}
+  {
+    memset(_enabledAgents, 0x01, sizeof(_enabledAgents));
+  }
 
 AgentsManagerStates AgentsManagerClass::handleInit() {
   AgentsManagerStates nextState = _state;
@@ -369,38 +398,17 @@ bool AgentsManagerClass::sendStatus(StatusMessage msg) {
 void AgentsManagerClass::handlePeerDisconnected() {
   //Peer disconnected, restore all stopped agents
   for (std::list<ConfiguratorAgent *>::iterator agent = _agentsList.begin(); agent != _agentsList.end(); ++agent) {
+    if (_enabledAgents[(int)(*agent)->getAgentType()] == false) {
+      (*agent)->end();
+      continue;
+    }
+
     if (*agent != _selectedAgent) {
-      if ((*agent)->getAgentType() == ConfiguratorAgent::AgentTypes::BLE && !_bleAgentEnabled) {
-        continue;
-      }
       (*agent)->begin();
     }
   }
   _selectedAgent = nullptr;
   return;
 }
 
-void AgentsManagerClass::stopBLEAgent() {
-  for (std::list<ConfiguratorAgent *>::iterator agent = _agentsList.begin(); agent != _agentsList.end(); ++agent) {
-    if ((*agent)->getAgentType() == ConfiguratorAgent::AgentTypes::BLE) {
-      (*agent)->end();
-      if (*agent == _selectedAgent) {
-        handlePeerDisconnected();
-        _state = AgentsManagerStates::INIT;
-      }
-    }
-  }
-}
-
-void AgentsManagerClass::startBLEAgent() {
-  if (_state == AgentsManagerStates::END || !_bleAgentEnabled) {
-    return;
-  }
-  std::for_each(_agentsList.begin(), _agentsList.end(), [](ConfiguratorAgent *agent) {
-    if (agent->getAgentType() == ConfiguratorAgent::AgentTypes::BLE) {
-      agent->begin();
-    }
-  });
-}
-
 #endif // NETWORK_CONFIGURATOR_COMPATIBLE

src/ConfiguratorAgents/AgentsManager.h

@@ -36,9 +36,12 @@ class AgentsManagerClass {
   bool begin();
   bool end();
   void disconnect();
-  AgentsManagerStates poll();
-  void enableBLEAgent(bool enable);
-  bool isBLEAgentEnabled();
+  AgentsManagerStates poll(); //TODO rename to update
+  void enableAgent(ConfiguratorAgent::AgentTypes type, bool enable);
+  bool isAgentEnabled(ConfiguratorAgent::AgentTypes type);
+  // Force starting agent even if disabled
+  bool startAgent(ConfiguratorAgent::AgentTypes type);
+  bool stopAgent(ConfiguratorAgent::AgentTypes type);
   ConfiguratorAgent *getConnectedAgent();
   bool sendMsg(ProvisioningOutputMessage &msg);
   bool addAgent(ConfiguratorAgent &agent);
@@ -54,12 +57,12 @@ class AgentsManagerClass {
   AgentsManagerClass();
   AgentsManagerStates _state;
   std::list<ConfiguratorAgent *> _agentsList;
+  bool _enabledAgents[2];
   ConfiguratorRequestHandler _reqHandlers[6];
   ReturnTimestamp _returnTimestampCb;
   ReturnNetworkSettings _returnNetworkSettingsCb;
   ConfiguratorAgent *_selectedAgent;
   uint8_t _instances;
-  bool _bleAgentEnabled;
   StatusMessage _initStatusMsg;
   NetworkOptions _netOptions;
   typedef struct {
@@ -87,6 +90,4 @@ class AgentsManagerClass {
   bool sendStatus(StatusMessage msg);
 
   void handlePeerDisconnected();
-  void stopBLEAgent();
-  void startBLEAgent();
 };