chore: clean examples

zfields · zfields · commit ab43cf37e55a · 2024-03-30T11:23:55.000-05:00
- Remove/replace deprecated API calls
- Minimize file inclusions
- Fix whitespace
diff --git a/examples/ArduinoIoTCloud-Advanced/ArduinoIoTCloud-Advanced.ino b/examples/ArduinoIoTCloud-Advanced/ArduinoIoTCloud-Advanced.ino
@@ -10,6 +10,9 @@
    - https://github.com/arduino-libraries/ArduinoIoTCloud#what
 */
 
+#include <ArduinoIoTCloud.h>
+
+#include "arduino_secrets.h"
 #include "thingProperties.h"
 
 void setup() {
diff --git a/examples/ArduinoIoTCloud-Advanced/arduino_secrets.h b/examples/ArduinoIoTCloud-Advanced/arduino_secrets.h
@@ -1,4 +1,4 @@
-#include <Arduino_ConnectionHandler.h>
+#include <AIoTC_Config.h>
 
 /* A complete list of supported boards with WiFi is available here:
  * https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -8,7 +8,7 @@
   #define SECRET_PASS "YOUR_WIFI_PASSWORD"
 #endif
 
-/* ESP8266 ESP32*/
+/* ESP8266 ESP32 */
 #if defined(BOARD_HAS_SECRET_KEY)
   #define SECRET_DEVICE_KEY "my-device-password"
 #endif
diff --git a/examples/ArduinoIoTCloud-Advanced/thingProperties.h b/examples/ArduinoIoTCloud-Advanced/thingProperties.h
@@ -1,5 +1,6 @@
 #include <ArduinoIoTCloud.h>
 #include <Arduino_ConnectionHandler.h>
+
 #include "arduino_secrets.h"
 
 #if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
@@ -24,13 +25,13 @@ void initProperties() {
   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)
-  ArduinoCloud.addProperty(switchButton, WRITE, ON_CHANGE, onSwitchButtonChange);
-  ArduinoCloud.addProperty(location, READ, ON_CHANGE);
-  ArduinoCloud.addProperty(color, READWRITE, ON_CHANGE, onColorChange);
+  ArduinoCloud.addProperty(switchButton, Permission::Write).onUpdate(onSwitchButtonChange);
+  ArduinoCloud.addProperty(location, Permission::Read).publishOnChange(0.0f);
+  ArduinoCloud.addProperty(color, Permission::ReadWrite).onUpdate(onColorChange);
 #elif defined(BOARD_HAS_LORA)
-  ArduinoCloud.addProperty(switchButton, 1, WRITE, ON_CHANGE, onSwitchButtonChange);
-  ArduinoCloud.addProperty(location, 2, READ, ON_CHANGE);
-  ArduinoCloud.addProperty(color, 3, READWRITE, ON_CHANGE, onColorChange);
+  ArduinoCloud.addProperty(switchButton, 1, Permission::Write).onUpdate(onSwitchButtonChange);
+  ArduinoCloud.addProperty(location, 2, Permission::Read).publishOnChange(0.0f);
+  ArduinoCloud.addProperty(color, 3, Permission::ReadWrite).onUpdate(onColorChange);
 #endif
 }
 
diff --git a/examples/ArduinoIoTCloud-Basic/ArduinoIoTCloud-Basic.ino b/examples/ArduinoIoTCloud-Basic/ArduinoIoTCloud-Basic.ino
@@ -14,6 +14,9 @@
    - https://github.com/arduino-libraries/ArduinoIoTCloud#what
 */
 
+#include <ArduinoIoTCloud.h>
+
+#include "arduino_secrets.h"
 #include "thingProperties.h"
 
 #if !defined(LED_BUILTIN) && !defined(ARDUINO_NANO_ESP32)
diff --git a/examples/ArduinoIoTCloud-Basic/arduino_secrets.h b/examples/ArduinoIoTCloud-Basic/arduino_secrets.h
@@ -1,4 +1,4 @@
-#include <Arduino_ConnectionHandler.h>
+#include <AIoTC_Config.h>
 
 /* A complete list of supported boards with WiFi is available here:
  * https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -8,7 +8,7 @@
   #define SECRET_PASS "YOUR_WIFI_PASSWORD"
 #endif
 
-/* ESP8266 ESP32*/
+/* ESP8266 ESP32 */
 #if defined(BOARD_HAS_SECRET_KEY)
   #define SECRET_DEVICE_KEY "my-device-password"
 #endif
diff --git a/examples/ArduinoIoTCloud-Basic/thingProperties.h b/examples/ArduinoIoTCloud-Basic/thingProperties.h
@@ -1,5 +1,6 @@
 #include <ArduinoIoTCloud.h>
 #include <Arduino_ConnectionHandler.h>
+
 #include "arduino_secrets.h"
 
 #if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
@@ -27,9 +28,9 @@ void initProperties() {
   ArduinoCloud.addProperty(potentiometer, Permission::Read).publishOnChange(10);
   ArduinoCloud.addProperty(seconds, Permission::Read).publishOnChange(1);
 #elif defined(BOARD_HAS_LORA)
-  ArduinoCloud.addProperty(led, 1, READWRITE, ON_CHANGE, onLedChange);
-  ArduinoCloud.addProperty(potentiometer, 2, READ, ON_CHANGE);
-  ArduinoCloud.addProperty(seconds, 3, READ, 5 * MINUTES);
+  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
 }
 
diff --git a/examples/ArduinoIoTCloud-Callbacks/ArduinoIoTCloud-Callbacks.ino b/examples/ArduinoIoTCloud-Callbacks/ArduinoIoTCloud-Callbacks.ino
@@ -26,6 +26,9 @@
    - https://github.com/arduino-libraries/ArduinoIoTCloud#what
 */
 
+#include <ArduinoIoTCloud.h>
+
+#include "arduino_secrets.h"
 #include "thingProperties.h"
 
 void setup() {
diff --git a/examples/ArduinoIoTCloud-Callbacks/arduino_secrets.h b/examples/ArduinoIoTCloud-Callbacks/arduino_secrets.h
@@ -1,4 +1,4 @@
-#include <Arduino_ConnectionHandler.h>
+#include <AIoTC_Config.h>
 
 /* A complete list of supported boards with WiFi is available here:
  * https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -8,7 +8,7 @@
   #define SECRET_PASS "YOUR_WIFI_PASSWORD"
 #endif
 
-/* ESP8266 ESP32*/
+/* ESP8266 ESP32 */
 #if defined(BOARD_HAS_SECRET_KEY)
   #define SECRET_DEVICE_KEY "my-device-password"
 #endif
diff --git a/examples/ArduinoIoTCloud-Callbacks/thingProperties.h b/examples/ArduinoIoTCloud-Callbacks/thingProperties.h
@@ -1,5 +1,6 @@
 #include <ArduinoIoTCloud.h>
 #include <Arduino_ConnectionHandler.h>
+
 #include "arduino_secrets.h"
 
 #if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
diff --git a/examples/ArduinoIoTCloud-DeferredOTA/ArduinoIoTCloud-DeferredOTA.ino b/examples/ArduinoIoTCloud-DeferredOTA/ArduinoIoTCloud-DeferredOTA.ino
@@ -16,6 +16,9 @@
    - https://github.com/arduino-libraries/ArduinoIoTCloud/#ota
 */
 
+#include <ArduinoIoTCloud.h>
+
+#include "arduino_secrets.h"
 #include "thingProperties.h"
 
 #if !defined(LED_BUILTIN) && !defined(ARDUINO_NANO_ESP32)
@@ -39,7 +42,7 @@ bool ask_user_via_serial() {
   if (Serial.available()) {
     char c = Serial.read();
     if (c == 'y' || c == 'Y') {
-      return true;  
+      return true;
     }
   }
   return false;
diff --git a/examples/ArduinoIoTCloud-DeferredOTA/arduino_secrets.h b/examples/ArduinoIoTCloud-DeferredOTA/arduino_secrets.h
@@ -1,4 +1,4 @@
-#include <Arduino_ConnectionHandler.h>
+#include <AIoTC_Config.h>
 
 /* A complete list of supported boards with WiFi is available here:
  * https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -8,7 +8,7 @@
   #define SECRET_PASS "YOUR_WIFI_PASSWORD"
 #endif
 
-/* ESP8266 ESP32*/
+/* ESP8266 ESP32 */
 #if defined(BOARD_HAS_SECRET_KEY)
   #define SECRET_DEVICE_KEY "my-device-password"
 #endif
diff --git a/examples/ArduinoIoTCloud-DeferredOTA/thingProperties.h b/examples/ArduinoIoTCloud-DeferredOTA/thingProperties.h
@@ -1,5 +1,6 @@
 #include <ArduinoIoTCloud.h>
 #include <Arduino_ConnectionHandler.h>
+
 #include "arduino_secrets.h"
 
 #if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_ETHERNET))
diff --git a/examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino b/examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino
@@ -6,6 +6,9 @@
 
 */
 
+#include <ArduinoIoTCloud.h>
+
+#include "arduino_secrets.h"
 #include "thingProperties.h"
 
 #if !defined(LED_BUILTIN) && !defined(ARDUINO_NANO_ESP32)
@@ -206,7 +209,7 @@ void loop() {
   if(daily.isActive()) {
     Serial.println("Daily schedule is active");
   }
-  
+
   /* Activate LED when the weekly schedule is active */
   digitalWrite(LED_BUILTIN, weekly.isActive());
 
@@ -219,5 +222,4 @@ void loop() {
   if(yearly.isActive()) {
     Serial.println("Yearly schedule is active");
   }
-
 }
diff --git a/examples/ArduinoIoTCloud-Schedule/arduino_secrets.h b/examples/ArduinoIoTCloud-Schedule/arduino_secrets.h
@@ -1,4 +1,4 @@
-#include <Arduino_ConnectionHandler.h>
+#include <AIoTC_Config.h>
 
 /* A complete list of supported boards with WiFi is available here:
  * https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -8,7 +8,7 @@
   #define SECRET_PASS "YOUR_WIFI_PASSWORD"
 #endif
 
-/* ESP8266 ESP32*/
+/* ESP8266 ESP32 */
 #if defined(BOARD_HAS_SECRET_KEY)
   #define SECRET_DEVICE_KEY "my-device-password"
 #endif
diff --git a/examples/ArduinoIoTCloud-Schedule/thingProperties.h b/examples/ArduinoIoTCloud-Schedule/thingProperties.h
@@ -1,5 +1,6 @@
 #include <ArduinoIoTCloud.h>
 #include <Arduino_ConnectionHandler.h>
+
 #include "arduino_secrets.h"
 
 #if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
@@ -28,16 +29,16 @@ void initProperties() {
   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)
-  ArduinoCloud.addProperty(switchButton, WRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(oneShot, READWRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(minute, READWRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(hourly, READWRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(daily, READWRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(weekly, READWRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(monthly, READWRITE, ON_CHANGE);
-  ArduinoCloud.addProperty(yearly, READWRITE, ON_CHANGE);
+  ArduinoCloud.addProperty(switchButton, Permission::Write).onUpdate(nullptr);
+  ArduinoCloud.addProperty(oneShot, Permission::ReadWrite).onUpdate(nullptr);
+  ArduinoCloud.addProperty(minute, Permission::ReadWrite).onUpdate(nullptr);
+  ArduinoCloud.addProperty(hourly, Permission::ReadWrite).onUpdate(nullptr);
+  ArduinoCloud.addProperty(daily, Permission::ReadWrite).onUpdate(nullptr);
+  ArduinoCloud.addProperty(weekly, Permission::ReadWrite).onUpdate(nullptr);
+  ArduinoCloud.addProperty(monthly, Permission::ReadWrite).onUpdate(nullptr);
+  ArduinoCloud.addProperty(yearly, Permission::ReadWrite).onUpdate(nullptr);
 #elif defined(BOARD_HAS_LORA)
-  ArduinoCloud.addProperty(switchButton, 1, WRITE, ON_CHANGE);
+  ArduinoCloud.addProperty(switchButton, 1, Permission::Write).onUpdate(nullptr);
 #endif
 }
 
