feat: ArduinoIoTCloudNotecard

arduino-libraries · Jul 20, 2024 · 3d8e710 · 3d8e710
1 parent 8b6ff40
commit 3d8e710
Show file tree

Hide file tree

Showing 20 changed files with 830 additions and 48 deletions.
diff --git a/examples/ArduinoIoTCloud-Advanced/ArduinoIoTCloud-Advanced.ino b/examples/ArduinoIoTCloud-Advanced/ArduinoIoTCloud-Advanced.ino
@@ -2,7 +2,7 @@
   This sketch demonstrates how to use more complex cloud data types such as a colour or coordinates.
 
   IMPORTANT:
-  This sketch works with WiFi, GSM, NB, Ethernet and Lora enabled boards supported by Arduino IoT Cloud.
+  This sketch works with Notecard, 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.
 

diff --git a/examples/ArduinoIoTCloud-Advanced/thingProperties.h b/examples/ArduinoIoTCloud-Advanced/thingProperties.h
@@ -2,7 +2,7 @@
 #include <Arduino_ConnectionHandler.h>
 #include "arduino_secrets.h"
 
-#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
+#if !(defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
       defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
   #error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
 #endif
@@ -11,6 +11,14 @@
   #define BOARD_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 #endif
 
+#if defined(USE_NOTECARD)
+  /* The Notecard can provide connectivity to almost any board via ESLOV (I2C)
+   * or UART. An empty string (or the default value provided below) will not
+   * override the Notecard's existing configuration.
+   * Learn more at: https://dev.blues.io */
+  #define NOTECARD_PRODUCT_UID "com.domain.you:product"
+#endif
+
 void onSwitchButtonChange();
 void onColorChange();
 
@@ -23,7 +31,7 @@ void initProperties() {
   ArduinoCloud.setBoardId(BOARD_ID);
   ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
 #endif
-#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
+#if defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
   ArduinoCloud.addProperty(switchButton, Permission::Write).onUpdate(onSwitchButtonChange);
   ArduinoCloud.addProperty(location, Permission::Read).publishOnChange(0.0f);
   ArduinoCloud.addProperty(color, Permission::ReadWrite).onUpdate(onColorChange);
@@ -34,7 +42,9 @@ void initProperties() {
 #endif
 }
 
-#if defined(BOARD_HAS_WIFI)
+#if defined(USE_NOTECARD)
+  NotecardConnectionHandler ArduinoIoTPreferredConnection(NOTECARD_PRODUCT_UID);
+#elif defined(BOARD_HAS_WIFI)
   WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_WIFI_SSID, SECRET_WIFI_PASS);
 #elif defined(BOARD_HAS_GSM)
   GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);

diff --git a/examples/ArduinoIoTCloud-Basic/ArduinoIoTCloud-Basic.ino b/examples/ArduinoIoTCloud-Basic/ArduinoIoTCloud-Basic.ino
@@ -6,7 +6,7 @@
   * 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.
+  This sketch works with Notecard, 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.
 

diff --git a/examples/ArduinoIoTCloud-Basic/thingProperties.h b/examples/ArduinoIoTCloud-Basic/thingProperties.h
@@ -2,7 +2,7 @@
 #include <Arduino_ConnectionHandler.h>
 #include "arduino_secrets.h"
 
-#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
+#if !(defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
       defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
   #error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
 #endif
@@ -11,6 +11,14 @@
   #define BOARD_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 #endif
 
+#if defined(USE_NOTECARD)
+  /* The Notecard can provide connectivity to almost any board via ESLOV (I2C)
+   * or UART. An empty string (or the default value provided below) will not
+   * override the Notecard's existing configuration.
+   * Learn more at: https://dev.blues.io */
+  #define NOTECARD_PRODUCT_UID "com.domain.you:product"
+#endif
+
 void onLedChange();
 
 bool led;
@@ -26,14 +34,16 @@ void initProperties() {
   ArduinoCloud.addProperty(led, Permission::Write).onUpdate(onLedChange);
   ArduinoCloud.addProperty(potentiometer, Permission::Read).publishOnChange(10);
   ArduinoCloud.addProperty(seconds, Permission::Read).publishOnChange(1);
-#elif defined(BOARD_HAS_LORA)
+#elif defined(USE_NOTECARD) || defined(BOARD_HAS_LORA)
   ArduinoCloud.addProperty(led, 1, Permission::ReadWrite).onUpdate(onLedChange);
   ArduinoCloud.addProperty(potentiometer, 2, Permission::Read).publishOnChange(10);
   ArduinoCloud.addProperty(seconds, 3, Permission::Read).publishEvery(5 * MINUTES);
 #endif
 }
 
-#if defined(BOARD_HAS_ETHERNET)
+#if defined(USE_NOTECARD)
+  NotecardConnectionHandler ArduinoIoTPreferredConnection(NOTECARD_PRODUCT_UID);
+#elif defined(BOARD_HAS_ETHERNET)
   /* DHCP mode */
   //EthernetConnectionHandler ArduinoIoTPreferredConnection;
   /* Manual mode. It will fallback in DHCP mode if SECRET_OPTIONAL_IP is invalid or equal to "0.0.0.0" */

diff --git a/examples/ArduinoIoTCloud-Callbacks/ArduinoIoTCloud-Callbacks.ino b/examples/ArduinoIoTCloud-Callbacks/ArduinoIoTCloud-Callbacks.ino
@@ -18,7 +18,7 @@
   One function per event can be assigned.
 
   IMPORTANT:
-  This sketch works with WiFi, GSM, NB, Ethernet and Lora enabled boards supported by Arduino IoT Cloud.
+  This sketch works with Notecard, 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.
 

diff --git a/examples/ArduinoIoTCloud-Callbacks/thingProperties.h b/examples/ArduinoIoTCloud-Callbacks/thingProperties.h
@@ -2,7 +2,7 @@
 #include <Arduino_ConnectionHandler.h>
 #include "arduino_secrets.h"
 
-#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
+#if !(defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
       defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
   #error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
 #endif
@@ -11,14 +11,24 @@
   #define BOARD_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 #endif
 
+#if defined(USE_NOTECARD)
+  /* The Notecard can provide connectivity to almost any board via ESLOV (I2C)
+   * or UART. An empty string (or the default value provided below) will not
+   * override the Notecard's existing configuration.
+   * Learn more at: https://dev.blues.io */
+  #define NOTECARD_PRODUCT_UID "com.domain.you:product"
+#endif
+
 void initProperties() {
 #if defined(BOARD_HAS_SECRET_KEY)
   ArduinoCloud.setBoardId(BOARD_ID);
   ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
 #endif
 }
 
-#if defined(BOARD_HAS_WIFI)
+#if defined(USE_NOTECARD)
+  NotecardConnectionHandler ArduinoIoTPreferredConnection(NOTECARD_PRODUCT_UID);
+#elif defined(BOARD_HAS_WIFI)
   WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_WIFI_SSID, SECRET_WIFI_PASS);
 #elif defined(BOARD_HAS_GSM)
   GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);

diff --git a/examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino b/examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino
@@ -2,7 +2,7 @@
   This sketch demonstrates how to use the cloud schedule variable type.
 
   IMPORTANT:
-  This sketch works with WiFi, GSM, NB and Ethernet enabled boards supported by Arduino IoT Cloud.
+  This sketch works with Notecard, WiFi, GSM, NB and Ethernet enabled boards supported by Arduino IoT Cloud.
 
 */
 

diff --git a/examples/ArduinoIoTCloud-Schedule/thingProperties.h b/examples/ArduinoIoTCloud-Schedule/thingProperties.h
@@ -2,7 +2,7 @@
 #include <Arduino_ConnectionHandler.h>
 #include "arduino_secrets.h"
 
-#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
+#if !(defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
       defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
   #error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
 #endif
@@ -11,6 +11,14 @@
   #define BOARD_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 #endif
 
+#if defined(USE_NOTECARD)
+  /* The Notecard can provide connectivity to almost any board via ESLOV (I2C)
+   * or UART. An empty string (or the default value provided below) will not
+   * override the Notecard's existing configuration.
+   * Learn more at: https://dev.blues.io */
+  #define NOTECARD_PRODUCT_UID "com.domain.you:product"
+#endif
+
 void onSwitchButtonChange();
 
 bool switchButton;
@@ -27,7 +35,7 @@ void initProperties() {
   ArduinoCloud.setBoardId(BOARD_ID);
   ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
 #endif
-#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
+#if defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
   ArduinoCloud.addProperty(switchButton, Permission::Write);
   ArduinoCloud.addProperty(oneShot, Permission::ReadWrite);
   ArduinoCloud.addProperty(minute, Permission::ReadWrite);
@@ -41,7 +49,9 @@ void initProperties() {
 #endif
 }
 
-#if defined(BOARD_HAS_WIFI)
+#if defined(USE_NOTECARD)
+  NotecardConnectionHandler ArduinoIoTPreferredConnection(NOTECARD_PRODUCT_UID);
+#elif defined(BOARD_HAS_WIFI)
   WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_WIFI_SSID, SECRET_WIFI_PASS);
 #elif defined(BOARD_HAS_GSM)
   GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);

diff --git a/examples/utility/ArduinoIoTCloud_Travis_CI/ArduinoIoTCloud_Travis_CI.ino b/examples/utility/ArduinoIoTCloud_Travis_CI/ArduinoIoTCloud_Travis_CI.ino
@@ -4,7 +4,7 @@
    Arduino IoT Cloud API.
 
   IMPORTANT:
-  This sketch works with WiFi, GSM, NB, Ethernet and Lora enabled boards supported by Arduino IoT Cloud.
+  This sketch works with Notecard, 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.
 

diff --git a/examples/utility/ArduinoIoTCloud_Travis_CI/thingProperties.h b/examples/utility/ArduinoIoTCloud_Travis_CI/thingProperties.h
@@ -2,7 +2,7 @@
 #include <Arduino_ConnectionHandler.h>
 #include "arduino_secrets.h"
 
-#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
+#if !(defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
       defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
   #error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
 #endif
@@ -19,6 +19,14 @@
   #define THING_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 #endif
 
+#if defined(USE_NOTECARD)
+  /* The Notecard can provide connectivity to almost any board via ESLOV (I2C)
+   * or UART. An empty string (or the default value provided below) will not
+   * override the Notecard's existing configuration.
+   * Learn more at: https://dev.blues.io */
+  #define NOTECARD_PRODUCT_UID "com.domain.you:product"
+#endif
+
 /******************************************************************************
    GLOBAL CONSTANTS
  ******************************************************************************/
@@ -54,7 +62,9 @@ String str_property_6;
 String str_property_7;
 String str_property_8;
 
-#if defined(BOARD_HAS_WIFI)
+#if defined(USE_NOTECARD)
+  NotecardConnectionHandler ArduinoIoTPreferredConnection(NOTECARD_PRODUCT_UID);
+#elif defined(BOARD_HAS_WIFI)
   WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_WIFI_SSID, SECRET_WIFI_PASS);
 #elif defined(BOARD_HAS_GSM)
   GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
@@ -83,7 +93,7 @@ void onStringPropertyChange();
 /******************************************************************************
    FUNCTIONS
  ******************************************************************************/
-#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined (BOARD_HAS_NB) || defined (BOARD_HAS_CATM1_NBIOT)
+#if defined(USE_NOTECARD) || defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined (BOARD_HAS_NB) || defined (BOARD_HAS_CATM1_NBIOT)
 void initProperties() {
 #if defined(BOARD_HAS_SECRET_KEY)
   ArduinoCloud.setBoardId(BOARD_ID);

diff --git a/src/AIoTC_Config.h b/src/AIoTC_Config.h
@@ -52,6 +52,8 @@
  * AUTOMATICALLY CONFIGURED DEFINES
  ******************************************************************************/
 
+#if !defined(USE_NOTECARD)
+
 #if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT)
   #define OTA_STORAGE_SNU         (1)
 #else
@@ -114,11 +116,6 @@
   #define HAS_TCP
 #endif
 
-#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_OPTA) || defined(ARDUINO_GIGA)
-  #define BEAR_SSL_CLIENT_IBUF_SIZE (16384 + 325) // Allows download from storage API
-  #define BOARD_STM32H7
-#endif
-
 #if defined(ARDUINO_NANO_RP2040_CONNECT)
   #define BEAR_SSL_CLIENT_IBUF_SIZE (16384 + 325) // Allows download from storage API
 #endif
@@ -138,6 +135,13 @@
   #define BOARD_HAS_SECURE_ELEMENT
 #endif
 
+#endif // USE_NOTECARD
+
+#if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_OPTA) || defined(ARDUINO_GIGA)
+  #define BEAR_SSL_CLIENT_IBUF_SIZE (16384 + 325) // Allows download from storage API
+  #define BOARD_STM32H7
+#endif
+
 /******************************************************************************
  * CONSTANTS
  ******************************************************************************/

diff --git a/src/ArduinoIoTCloud.h b/src/ArduinoIoTCloud.h
@@ -161,7 +161,9 @@ class ArduinoIoTCloudClass
     OnCloudEventCallback _cloud_event_callback[3];
 };
 
-#ifdef HAS_TCP
+#if defined(USE_NOTECARD)
+  #include "ArduinoIoTCloudNotecard.h"
+#elif defined(HAS_TCP)
   #include "ArduinoIoTCloudTCP.h"
 #elif defined(HAS_LORA)
   #include "ArduinoIoTCloudLPWAN.h"

diff --git a/src/ArduinoIoTCloudDevice.cpp b/src/ArduinoIoTCloudDevice.cpp
@@ -14,7 +14,7 @@
 
 #include <AIoTC_Config.h>
 
-#ifdef HAS_TCP
+#if defined(USE_NOTECARD) || defined(HAS_TCP)
 
 #include "ArduinoIoTCloudDevice.h"
 #include "interfaces/CloudProcess.h"
@@ -142,4 +142,4 @@ ArduinoCloudDevice::State ArduinoCloudDevice::handleDisconnected() {
   return State::Disconnected;
 }
 
-#endif /* HAS_TCP */
+#endif /* USE_NOTECARD || HAS_TCP */