use network configurator in iotCloud

fabik111 · fabik111 · commit 957be759b321 · 2025-05-15T15:40:41.000+02:00
update example of sketch that uses the NetworkConfigurator

use NetworkConfigurator wrappers for agentsManager

update ci test for networkConfigurator

add Arduino_NetworkConfigurator dep to library.properties
diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml
@@ -22,11 +22,14 @@ jobs:
         # Install the ArduinoIoTCloud library from the repository
         - source-path: ./
         - name: Arduino_ConnectionHandler
+        - name: ArduinoBLE
         - name: ArduinoHttpClient
         - name: Arduino_DebugUtils
         - name: ArduinoMqttClient
         - name: Arduino_SecureElement
         - name: Arduino_CloudUtils
+        - name: Arduino_KVStore
+        - name: Arduino_NetworkConfigurator
       # sketch paths to compile (recursive) for all boards
       UNIVERSAL_SKETCH_PATHS: |
         - examples/ArduinoIoTCloud-Advanced
@@ -195,6 +198,7 @@ jobs:
               - name: Arduino_Cellular
               - name: Blues Wireless Notecard
             sketch-paths: |
+              - examples/ArduinoIoTCloud-NetConfig
               - examples/ArduinoIoTCloud-DeferredOTA
               - examples/ArduinoIoTCloud-Notecard
               - examples/ArduinoIoTCloud-Schedule
@@ -208,6 +212,7 @@ jobs:
             libraries: |
               - name: Blues Wireless Notecard
             sketch-paths: |
+              - examples/ArduinoIoTCloud-NetConfig
               - examples/ArduinoIoTCloud-DeferredOTA
               - examples/ArduinoIoTCloud-Notecard
               - examples/ArduinoIoTCloud-Schedule
@@ -223,6 +228,7 @@ jobs:
               - name: ArduinoECCX08
               - name: Blues Wireless Notecard
             sketch-paths: |
+              - examples/ArduinoIoTCloud-NetConfig
               - examples/ArduinoIoTCloud-DeferredOTA
               - examples/ArduinoIoTCloud-Notecard
               - examples/ArduinoIoTCloud-Schedule
@@ -238,6 +244,7 @@ jobs:
               - name: ArduinoECCX08
               - name: Blues Wireless Notecard
             sketch-paths: |
+              - examples/ArduinoIoTCloud-NetConfig
               - examples/ArduinoIoTCloud-DeferredOTA
               - examples/ArduinoIoTCloud-Notecard
               - examples/ArduinoIoTCloud-Schedule
@@ -252,6 +259,7 @@ jobs:
               - name: Arduino_Cellular
               - name: Blues Wireless Notecard
             sketch-paths: |
+              - examples/ArduinoIoTCloud-NetConfig
               - examples/ArduinoIoTCloud-Notecard
               - examples/ArduinoIoTCloud-Schedule
               - examples/utility/Provisioning
@@ -264,6 +272,7 @@ jobs:
             libraries: |
               - name: Blues Wireless Notecard
             sketch-paths: |
+              - examples/ArduinoIoTCloud-NetConfig
               - examples/ArduinoIoTCloud-Notecard
               - examples/ArduinoIoTCloud-Schedule
           # Nano ESP32
diff --git a/examples/ArduinoIoTCloud-NetConfig/ArduinoIoTCloud-NetConfig.ino b/examples/ArduinoIoTCloud-NetConfig/ArduinoIoTCloud-NetConfig.ino
@@ -0,0 +1,62 @@
+/*
+  This sketch demonstrates how to exchange data between your board and the Arduino IoT Cloud.
+
+  * Connect a potentiometer (or other analog sensor) to A0.
+  * When the potentiometer (or sensor) value changes the data is sent to the Cloud.
+  * When you flip the switch in the Cloud dashboard the onboard LED lights gets turned ON or OFF.
+
+  IMPORTANT:
+  This sketch works with WiFi, GSM, NB, Ethernet and Lora enabled boards supported by Arduino IoT Cloud.
+  On a LoRa board, if it is configured as a class A device (default and preferred option),
+  values from Cloud dashboard are received only after a value is sent to Cloud.
+
+  The full list of compatible boards can be found here:
+   - https://github.com/arduino-libraries/ArduinoIoTCloud#what
+*/
+
+#include "thingProperties.h"
+
+#if !defined(LED_BUILTIN) && !defined(ARDUINO_NANO_ESP32)
+static int const LED_BUILTIN = 2;
+#endif
+
+void setup() {
+  /* Initialize serial and wait up to 5 seconds for port to open */
+  Serial.begin(9600);
+  for(unsigned long const serialBeginTime = millis(); !Serial && (millis() - serialBeginTime <= 5000); ) { }
+
+  /* Set the debug message level:
+   * - DBG_ERROR: Only show error messages
+   * - DBG_WARNING: Show warning and error messages
+   * - DBG_INFO: Show info, warning, and error messages
+   * - DBG_DEBUG: Show debug, info, warning, and error messages
+   * - DBG_VERBOSE: Show all messages
+   */
+  setDebugMessageLevel(DBG_INFO);
+
+  /* Configure LED pin as an output */
+  pinMode(LED_BUILTIN, OUTPUT);
+
+  /* This function takes care of connecting your sketch variables to the ArduinoIoTCloud object */
+  initProperties();
+
+  /* Initialize Arduino IoT Cloud library */
+  ArduinoCloud.begin(ArduinoIoTPreferredConnection);
+
+  ArduinoCloud.printDebugInfo();
+}
+
+void loop() {
+  ArduinoCloud.update();
+  potentiometer = analogRead(A0);
+  seconds = millis() / 1000;
+}
+
+/*
+ * 'onLedChange' is called when the "led" property of your Thing changes
+ */
+void onLedChange() {
+  Serial.print("LED set to ");
+  Serial.println(led);
+  digitalWrite(LED_BUILTIN, led);
+}
diff --git a/examples/ArduinoIoTCloud-NetConfig/thingProperties.h b/examples/ArduinoIoTCloud-NetConfig/thingProperties.h
@@ -0,0 +1,47 @@
+#if !defined(ARDUINO_SAMD_MKRWIFI1010) && !defined(ARDUINO_SAMD_NANO_33_IOT) &&  !defined(ARDUINO_NANO_RP2040_CONNECT) \
+  && !defined(ARDUINO_PORTENTA_H7_M7) && !defined(ARDUINO_NICLA_VISION) && !defined(ARDUINO_OPTA) && !defined(ARDUINO_GIGA) \
+  && !defined(ARDUINO_UNOR4_WIFI) && !defined(ARDUINO_PORTENTA_C33)
+#error "This example is not compatible with this board."
+#endif
+#include <ArduinoIoTCloud.h>
+#include <Arduino_ConnectionHandler.h>
+#include "ConfiguratorAgents/agents/BLE/BLEAgent.h"
+#include "ConfiguratorAgents/agents/Serial/SerialAgent.h"
+
+void onLedChange();
+
+bool led;
+int potentiometer;
+int seconds;
+
+GenericConnectionHandler ArduinoIoTPreferredConnection;
+KVStore kvStore;
+NetworkConfiguratorClass NetworkConfigurator(ArduinoIoTPreferredConnection);
+BLEAgentClass BLEAgent;
+SerialAgentClass SerialAgent;
+
+void initProperties() {
+  NetworkConfigurator.addAgent(BLEAgent);
+  NetworkConfigurator.addAgent(SerialAgent);
+  NetworkConfigurator.setStorage(kvStore);
+
+  /* For changing the default reset pin uncomment and set your preferred pin.
+   * Use DISABLE_PIN for disabling the reset procedure.
+   * 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/
+   */
+  //NetworkConfigurator.setReconfigurePin(your_pin);
+
+  /* Otherwise if you need to monitor the pin status changes
+   * you can set a custom callback function that is fired on every change
+   */
+  //NetworkConfigurator.setPinChangedCallback(your_callback);
+
+  ArduinoCloud.setConfigurator(NetworkConfigurator);
+
+  ArduinoCloud.addProperty(led, Permission::Write).onUpdate(onLedChange);
+  ArduinoCloud.addProperty(potentiometer, Permission::Read).publishOnChange(10);
+  ArduinoCloud.addProperty(seconds, Permission::Read).publishOnChange(1);
+
+}
diff --git a/library.properties b/library.properties
@@ -8,4 +8,4 @@ category=Communication
 url=https://github.com/arduino-libraries/ArduinoIoTCloud
 architectures=mbed,samd,esp8266,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_opta,mbed_giga,renesas_portenta,renesas_uno,mbed_edge,stm32
 includes=ArduinoIoTCloud.h
-depends=Arduino_ConnectionHandler,Arduino_DebugUtils,Arduino_SecureElement,ArduinoMqttClient,ArduinoECCX08,RTCZero,Adafruit SleepyDog Library,ArduinoHttpClient,Arduino_CloudUtils,ArduinoBearSSL
+depends=Arduino_ConnectionHandler,Arduino_DebugUtils,Arduino_SecureElement,ArduinoMqttClient,ArduinoECCX08,RTCZero,Adafruit SleepyDog Library,ArduinoHttpClient,Arduino_CloudUtils,ArduinoBearSSL,Arduino_NetworkConfigurator
diff --git a/src/AIoTC_Config.h b/src/AIoTC_Config.h
@@ -148,6 +148,14 @@
   #define BOARD_STM32H7
 #endif
 
+#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) ||  defined(ARDUINO_NANO_RP2040_CONNECT) \
+  || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_OPTA) || defined(ARDUINO_GIGA) \
+  || defined(ARDUINO_UNOR4_WIFI) || defined(ARDUINO_PORTENTA_C33)
+  #define NETWORK_CONFIGURATOR_ENABLED (1)
+#else
+  #define NETWORK_CONFIGURATOR_ENABLED (0)
+#endif
+
 /******************************************************************************
  * CONSTANTS
  ******************************************************************************/
diff --git a/src/ArduinoIoTCloud.cpp b/src/ArduinoIoTCloud.cpp
@@ -27,6 +27,9 @@
 
 ArduinoIoTCloudClass::ArduinoIoTCloudClass()
 : _connection{nullptr}
+#if NETWORK_CONFIGURATOR_ENABLED
+, _configurator{nullptr}
+#endif
 , _time_service(TimeService)
 , _thing_id{"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}
 , _lib_version{AIOT_CONFIG_LIB_VERSION}
diff --git a/src/ArduinoIoTCloud.h b/src/ArduinoIoTCloud.h
@@ -25,6 +25,9 @@
 #include <AIoTC_Config.h>
 
 #include <Arduino_ConnectionHandler.h>
+#if NETWORK_CONFIGURATOR_ENABLED
+#include <NetworkConfigurator.h>
+#endif
 
 #if defined(DEBUG_ERROR) || defined(DEBUG_WARNING) || defined(DEBUG_INFO) || defined(DEBUG_DEBUG) || defined(DEBUG_VERBOSE)
 #  include <Arduino_DebugUtils.h>
@@ -101,6 +104,9 @@ class ArduinoIoTCloudClass
     inline unsigned long getInternalTime()              { return _time_service.getTime(); }
     inline unsigned long getLocalTime()                 { return _time_service.getLocalTime(); }
 
+    #if NETWORK_CONFIGURATOR_ENABLED
+    inline void setConfigurator(NetworkConfiguratorClass & configurator) { _configurator = &configurator; }
+    #endif
     void addCallback(ArduinoIoTCloudEvent const event, OnCloudEventCallback callback);
 
 #define addProperty( v, ...) addPropertyReal(v, #v, __VA_ARGS__)
@@ -146,6 +152,9 @@ class ArduinoIoTCloudClass
   protected:
 
     ConnectionHandler * _connection;
+    #if NETWORK_CONFIGURATOR_ENABLED
+    NetworkConfiguratorClass * _configurator;
+    #endif
     TimeServiceClass & _time_service;
     String _thing_id;
     String _lib_version;
diff --git a/src/ArduinoIoTCloudTCP.cpp b/src/ArduinoIoTCloudTCP.cpp
diff --git a/src/ArduinoIoTCloudTCP.h b/src/ArduinoIoTCloudTCP.h
