Storage and Memory optimization (#33)

* wrap BLE enable/disable of AgentsManager

* optimize storage and mem consumption for final cloud sketch

* make AgentManager as singleton

move cbor encoders and decoders obj instance to include file to save 2kB of flash mem

Author: fabik111

examples/auto-retry/auto-retry.ino

@@ -79,9 +79,9 @@ void setup() {
 
 void loop() {
   if (provisioningCompleted && networkConfigured) {
-    AgentsManager.disconnect();
-    if (AgentsManager.isBLEAgentEnabled()) {
-      AgentsManager.enableBLEAgent(false);
+    NetworkConfigurator.configurationCompleted();
+    if (NetworkConfigurator.isBLEenabled()) {
+      NetworkConfigurator.enableBLE(false);
     }
   }
   if (provisioningCompleted == false && ProvisioningSystem.poll()) {
@@ -109,8 +109,8 @@ void loop() {
     if (digitalRead(RESETCRED_BUTTON) == HIGH) {
 #endif
       Serial.println("Update config");
-      if (!AgentsManager.isBLEAgentEnabled()) {
-        AgentsManager.enableBLEAgent(true);
+      if (!NetworkConfigurator.isBLEenabled()) {
+        NetworkConfigurator.enableBLE(true);
       }
 
       networkConfigured = false;

examples/auto-retry/provisioning.cpp

@@ -43,8 +43,8 @@ void display_freeram(){
   Serial.println(freeRam());
 }
 #define PROVISIONING_SERVICEID_FOR_AGENTMANAGER 0xB1
-Provisioning::Provisioning(AgentsManagerClass &agc)
-  : _agentManager{ &agc } {
+Provisioning::Provisioning() {
+  _agentManager = &AgentsManagerClass::getInstance();
 }
 
 void Provisioning::begin() {
@@ -100,4 +100,4 @@ void Provisioning::setTimestamp(uint64_t ts) {
   _ts = ts;
   Serial.print("received TS: ");
   Serial.println(_ts);
-}
+}

examples/auto-retry/provisioning.h

@@ -4,7 +4,7 @@
 
 class Provisioning {
 public:
-  Provisioning(AgentsManagerClass &agc);
+  Provisioning();
   void begin();
   void end();
   bool poll();
@@ -16,4 +16,4 @@ class Provisioning {
   static inline bool _reqReceived = false;
   static void getIdRequestHandler();
   static void setTimestamp(uint64_t ts);
-};
+};

examples/auto-retry/thingProperties.h

@@ -3,7 +3,6 @@
 #include <ArduinoIoTCloud.h>
 #include <GenericConnectionHandler.h>
 #include "NetworkConfigurator.h"
-#include "ConfiguratorAgents/AgentsManager.h"
 #if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
 #include "ConfiguratorAgents/agents/BLE/BLEAgent.h"
 #endif
@@ -17,15 +16,20 @@ void onCounterChange();
 
 int counter;
 GenericConnectionHandler ArduinoIoTPreferredConnection;
-NetworkConfiguratorClass NetworkConfigurator(ArduinoIoTPreferredConnection);
-Provisioning ProvisioningSystem(AgentsManager);
+Provisioning ProvisioningSystem;
 KVStore kvstore;
+
+#if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
+BLEAgentClass BLEAgent;
+#endif
+SerialAgentClass SerialAgent;
+NetworkConfiguratorClass NetworkConfigurator(ArduinoIoTPreferredConnection);
 void initProperties() {
 
   ArduinoCloud.addProperty(counter, READWRITE, ON_CHANGE, onCounterChange);
   NetworkConfigurator.setStorage(kvstore);
 #if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
-  AgentsManager.addAgent(BLEAgent);
+  NetworkConfigurator.addAgent(BLEAgent);
 #endif
-  AgentsManager.addAgent(SerialAgent);
+ NetworkConfigurator.addAgent(SerialAgent);
 }

examples/network-setting/network-setting.ino

@@ -31,9 +31,9 @@ DeviceMode deviceMode = DeviceMode::CONFIG;
 void changeMode(DeviceMode nextMode){
   if(nextMode == DeviceMode::RUN){
     if(deviceMode == DeviceMode::CONFIG){
-      AgentsManager.disconnect();
-      if (AgentsManager.isBLEAgentEnabled()) {
-        AgentsManager.enableBLEAgent(false);
+      NetworkConfigurator.configurationCompleted();
+      if (NetworkConfigurator.isBLEenabled()) {
+        NetworkConfigurator.enableBLE(false);
       }
     }
     deviceMode = DeviceMode::RUN;
@@ -102,8 +102,8 @@ void loop() {
     if (digitalRead(RESETCRED_BUTTON) == HIGH) {
 #endif
       Serial.println("Update config");
-      if (!AgentsManager.isBLEAgentEnabled()) {
-        AgentsManager.enableBLEAgent(true);
+      if (!NetworkConfigurator.isBLEenabled()) {
+        NetworkConfigurator.enableBLE(true);
       }
     }
 
@@ -127,4 +127,4 @@ void loop() {
 */
 void onCounterChange()  {
   // Add your code here to act upon Counter change
-}
+}

examples/network-setting/thingProperties.h

@@ -3,7 +3,6 @@
 #include <ArduinoIoTCloud.h>
 #include <GenericConnectionHandler.h>
 #include "NetworkConfigurator.h"
-#include "ConfiguratorAgents/AgentsManager.h"
 #include <Arduino_KVStore.h>
 #if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
 #include "ConfiguratorAgents/agents/BLE/BLEAgent.h"
@@ -18,17 +17,22 @@ void onCounterChange();
 int counter;
 
 GenericConnectionHandler ArduinoIoTPreferredConnection;
-NetworkConfiguratorClass NetworkConfigurator(ArduinoIoTPreferredConnection);
 KVStore kvstore;
 
+#if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
+BLEAgentClass BLEAgent;
+#endif
+SerialAgentClass SerialAgent;
+NetworkConfiguratorClass NetworkConfigurator(ArduinoIoTPreferredConnection);
+
 void initProperties(){
 
   ArduinoCloud.addProperty(counter, READWRITE, ON_CHANGE, onCounterChange);
   NetworkConfigurator.setStorage(kvstore);
 #if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
-  AgentsManager.addAgent(BLEAgent);
+ NetworkConfigurator.addAgent(BLEAgent);
 #endif
-  AgentsManager.addAgent(SerialAgent);
+ NetworkConfigurator.addAgent(SerialAgent);
 }
 
 

examples/provisioning/ClaimingHandler.cpp

@@ -10,10 +10,18 @@
 #include "SecretsHelper.h"
 #include "Arduino_DebugUtils.h"
 #include "Utility/LEDFeedback/LEDFeedback.h"
+#if !defined(ARDUINO_SAMD_MKRGSM1400) && !defined(ARDUINO_SAMD_MKRNB1500) && !defined(ARDUINO_SAMD_MKRWAN1300) && !defined(ARDUINO_SAMD_MKRWAN1310)
+#define BOARD_HAS_BLE
+#endif
+#ifdef BOARD_HAS_BLE
+#include <ArduinoBLE.h>
+#include "utility/HCI.h"
+#endif
+
 #define PROVISIONING_SERVICEID_FOR_AGENTMANAGER 0xB1
 
-ClaimingHandlerClass::ClaimingHandlerClass(AgentsManagerClass &agc) {
-  _agentManager = &agc;
+ClaimingHandlerClass::ClaimingHandlerClass() {
+  _agentManager = &AgentsManagerClass::getInstance();
 }
 
 bool ClaimingHandlerClass::begin(SecureElement *secureElement, String *uhwid, ClearStoredCredentialsHandler clearStoredCredentials) {
@@ -29,6 +37,10 @@ bool ClaimingHandlerClass::begin(SecureElement *secureElement, String *uhwid, Cl
     return false;
   }
 
+  if(!_agentManager->addRequestHandler(RequestType::GET_BLE_MAC_ADDRESS, getBLEMacAddressRequestCb)) {
+    return false;
+  }
+
   if (!_agentManager->addReturnTimestampCallback(setTimestamp)) {
     return false;
   }
@@ -55,8 +67,9 @@ void ClaimingHandlerClass::poll() {
   _agentManager->poll();
 
   switch (_receivedEvent) {
-    case ClaimingReqEvents::GET_ID: getIdReqHandler          (); break;
-    case ClaimingReqEvents::RESET:  resetStoredCredReqHandler(); break;
+    case ClaimingReqEvents::GET_ID:              getIdReqHandler           (); break;
+    case ClaimingReqEvents::RESET:               resetStoredCredReqHandler (); break;
+    case ClaimingReqEvents::GET_BLE_MAC_ADDRESS: getBLEMacAddressReqHandler(); break;
   }
   _receivedEvent = ClaimingReqEvents::NONE;
   return;
@@ -117,6 +130,35 @@ void ClaimingHandlerClass::resetStoredCredReqHandler() {
 
 }
 
+void ClaimingHandlerClass::getBLEMacAddressReqHandler() {
+  uint8_t mac[6] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
+#ifdef BOARD_HAS_BLE
+  bool activated = false;
+  ConfiguratorAgent * connectedAgent = _agentManager->getConnectedAgent();
+  if(!_agentManager->isBLEAgentEnabled() || (connectedAgent != nullptr &&
+    connectedAgent->getAgentType() != ConfiguratorAgent::AgentTypes::BLE)) {
+      activated = true;
+      BLE.begin();
+  }
+
+  HCI.readBdAddr(mac);
+
+  for(int i = 0; i < 3; i++){
+    uint8_t byte = mac[i];
+    mac[i] = mac[5-i];
+    mac[5-i] = byte;
+  }
+  if (activated) {
+    BLE.end();
+  }
+#endif
+
+  ProvisioningOutputMessage outputMsg;
+  outputMsg.type = MessageOutputType::BLE_MAC_ADDRESS;
+  outputMsg.m.BLEMacAddress = mac;
+  _agentManager->sendMsg(outputMsg);
+}
+
 void ClaimingHandlerClass::getIdRequestCb() {
   _receivedEvent = ClaimingReqEvents::GET_ID;
 }
@@ -129,6 +171,10 @@ void ClaimingHandlerClass::resetStoredCredRequestCb() {
   _receivedEvent = ClaimingReqEvents::RESET;
 }
 
+void ClaimingHandlerClass::getBLEMacAddressRequestCb() {
+  _receivedEvent = ClaimingReqEvents::GET_BLE_MAC_ADDRESS;
+}
+
 bool ClaimingHandlerClass::sendStatus(StatusMessage msg) {
   ProvisioningOutputMessage statusMsg = { MessageOutputType::STATUS, { msg } };
   return _agentManager->sendMsg(statusMsg);

examples/provisioning/ClaimingHandler.h

@@ -11,10 +11,10 @@
 #include "ConfiguratorAgents/AgentsManager.h"
 #include <Arduino_SecureElement.h>
 
-typedef bool (*ClearStoredCredentialsHandler)(); 
+typedef bool (*ClearStoredCredentialsHandler)();
 class ClaimingHandlerClass {
 public:
-  ClaimingHandlerClass(AgentsManagerClass &agc);
+  ClaimingHandlerClass();
   bool begin(SecureElement *secureElement, String *uhwid, ClearStoredCredentialsHandler clearStoredCredentials);
   void end();
   void poll();
@@ -26,7 +26,8 @@ class ClaimingHandlerClass {
   };
   enum class ClaimingReqEvents { NONE,
                                  GET_ID,
-                                 RESET };
+                                 RESET,
+                                 GET_BLE_MAC_ADDRESS };
   static inline ClaimingReqEvents _receivedEvent = ClaimingReqEvents::NONE;
   ClaimingHandlerStates _state = ClaimingHandlerStates::END;
   AgentsManagerClass *_agentManager = nullptr;
@@ -35,8 +36,10 @@ class ClaimingHandlerClass {
   ClearStoredCredentialsHandler _clearStoredCredentials = nullptr;
   void getIdReqHandler();
   void resetStoredCredReqHandler();
+  void getBLEMacAddressReqHandler();
   bool sendStatus(StatusMessage msg);
   static void getIdRequestCb();
   static void setTimestamp(uint64_t ts);
   static void resetStoredCredRequestCb();
-};
+  static void getBLEMacAddressRequestCb();
+};

examples/provisioning/provisioning.ino

@@ -29,6 +29,10 @@ void display_freeram();
 #define RESETCRED_BUTTON 13
 #endif
 
+#define CLEAR_CREDENTIALS_ON_RESET true
+#define CLEAR_ON_RESET true
+
+
 enum class DeviceState { FIRST_CONFIG,
                          CSR,
                          BEGIN_CLOUD,
@@ -123,12 +127,15 @@ void setup() {
 #endif
 
 #if defined(ARDUINO_OPTA) 
-  if(digitalRead(RESETCRED_BUTTON) == LOW){
+  if(CLEAR_ON_RESET ||digitalRead(RESETCRED_BUTTON) == LOW){
 #else
-  if (digitalRead(RESETCRED_BUTTON) == HIGH) {
+  if (CLEAR_ON_RESET ||digitalRead(RESETCRED_BUTTON) == HIGH) {
 #endif
     Serial.println("Resetting cred");
     NetworkConfigurator.resetStoredConfiguration();
+    if (CLEAR_CREDENTIALS_ON_RESET) {
+      clearStoredCredentials();
+    }
   }
 
   NetworkConfigurator.updateNetworkOptions();
@@ -196,9 +203,9 @@ void cloudConnectedHandler(bool connected) {
 
 DeviceState handleBeginCloud() {
   // Close the connection to the peer (App mobile, FE, etc)
-  AgentsManager.disconnect();
-  if (AgentsManager.isBLEAgentEnabled()) {
-    AgentsManager.enableBLEAgent(false);
+  AgentsManagerClass::getInstance().disconnect();
+  if (AgentsManagerClass::getInstance().isBLEAgentEnabled()) {
+    AgentsManagerClass::getInstance().enableBLEAgent(false);
   }
   // Connect to Arduino IoT Cloud
   ArduinoCloud.begin(ArduinoIoTPreferredConnection, false, "mqtts-sa.iot.oniudra.cc");

examples/provisioning/thingProperties.h

@@ -4,7 +4,6 @@
 #include <GenericConnectionHandler.h>
 #include <Arduino_KVStore.h>
 #include "NetworkConfigurator.h"
-#include "ConfiguratorAgents/AgentsManager.h"
 #include "ConfiguratorAgents/agents/BLE/BLEAgent.h"
 #include "ConfiguratorAgents/agents/Serial/SerialAgent.h"
 #include "ClaimingHandler.h"
@@ -14,14 +13,16 @@ void onCounterChange();
 int counter;
 KVStore kvstore;
 GenericConnectionHandler ArduinoIoTPreferredConnection;
+BLEAgentClass BLEAgent;
+SerialAgentClass SerialAgent;
 NetworkConfiguratorClass NetworkConfigurator(ArduinoIoTPreferredConnection);
-ClaimingHandlerClass ClaimingHandler(AgentsManager);
+ClaimingHandlerClass ClaimingHandler;
 
 void initProperties() {
 
   ArduinoCloud.addProperty(counter, READWRITE, ON_CHANGE, onCounterChange);
-  AgentsManager.addAgent(BLEAgent);
-  AgentsManager.addAgent(SerialAgent);
+  AgentsManagerClass::getInstance().addAgent(BLEAgent);
+  AgentsManagerClass::getInstance().addAgent(SerialAgent);
   NetworkConfigurator.setStorage(kvstore);
 }