Skip to content

Commit 45bf266

Browse files
zfieldszfields
committed
chore: clean examples
- Remove/replace deprecated API calls - Minimize file inclusions - Fix whitespace
1 parent dfd0378 commit 45bf266

15 files changed

+60
-36
lines changed

‎examples/ArduinoIoTCloud-Advanced/ArduinoIoTCloud-Advanced.ino

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
- https://github.com/arduino-libraries/ArduinoIoTCloud#what
1111
*/
1212

13+
#include <ArduinoIoTCloud.h>
14+
1315
#include "arduino_secrets.h"
1416
#include "thingProperties.h"
1517

‎examples/ArduinoIoTCloud-Advanced/arduino_secrets.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#include <ArduinoIoTCloud.h>
2-
#include <Arduino_ConnectionHandler.h>
1+
#include <AIoTC_Config.h>
32

43
/* A complete list of supported boards with WiFi is available here:
54
* https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -9,7 +8,7 @@
98
#define SECRET_PASS "YOUR_WIFI_PASSWORD"
109
#endif
1110

12-
/* ESP8266 ESP32*/
11+
/* ESP8266 ESP32 */
1312
#if defined(BOARD_HAS_SECRET_KEY)
1413
#define SECRET_DEVICE_KEY "my-device-password"
1514
#endif

‎examples/ArduinoIoTCloud-Advanced/thingProperties.h

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
#include <ArduinoIoTCloud.h>
2+
3+
#include "arduino_secrets.h"
4+
15
#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
26
defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
37
#error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
@@ -20,13 +24,13 @@ void initProperties() {
2024
ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
2125
#endif
2226
#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
23-
ArduinoCloud.addProperty(switchButton, WRITE, ON_CHANGE, onSwitchButtonChange);
24-
ArduinoCloud.addProperty(location, READ, ON_CHANGE);
25-
ArduinoCloud.addProperty(color, READWRITE, ON_CHANGE, onColorChange);
27+
ArduinoCloud.addProperty(switchButton, Permission::Write).onUpdate(onSwitchButtonChange);
28+
ArduinoCloud.addProperty(location, Permission::Read).publishOnChange(0.0f);
29+
ArduinoCloud.addProperty(color, Permission::ReadWrite).onUpdate(onColorChange);
2630
#elif defined(BOARD_HAS_LORA)
27-
ArduinoCloud.addProperty(switchButton, 1, WRITE, ON_CHANGE, onSwitchButtonChange);
28-
ArduinoCloud.addProperty(location, 2, READ, ON_CHANGE);
29-
ArduinoCloud.addProperty(color, 3, READWRITE, ON_CHANGE, onColorChange);
31+
ArduinoCloud.addProperty(switchButton, 1, Permission::Write).onUpdate(onSwitchButtonChange);
32+
ArduinoCloud.addProperty(location, 2, Permission::Read).publishOnChange(0.0f);
33+
ArduinoCloud.addProperty(color, 3, Permission::ReadWrite).onUpdate(onColorChange);
3034
#endif
3135
}
3236

‎examples/ArduinoIoTCloud-Basic/ArduinoIoTCloud-Basic.ino

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
- https://github.com/arduino-libraries/ArduinoIoTCloud#what
1515
*/
1616

17+
#include <ArduinoIoTCloud.h>
18+
1719
#include "arduino_secrets.h"
1820
#include "thingProperties.h"
1921

‎examples/ArduinoIoTCloud-Basic/arduino_secrets.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#include <ArduinoIoTCloud.h>
2-
#include <Arduino_ConnectionHandler.h>
1+
#include <AIoTC_Config.h>
32

43
/* A complete list of supported boards with WiFi is available here:
54
* https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -9,7 +8,7 @@
98
#define SECRET_PASS "YOUR_WIFI_PASSWORD"
109
#endif
1110

12-
/* ESP8266 ESP32*/
11+
/* ESP8266 ESP32 */
1312
#if defined(BOARD_HAS_SECRET_KEY)
1413
#define SECRET_DEVICE_KEY "my-device-password"
1514
#endif

‎examples/ArduinoIoTCloud-Basic/thingProperties.h

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
#include <ArduinoIoTCloud.h>
2+
3+
#include "arduino_secrets.h"
4+
15
#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
26
defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
37
#error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
@@ -23,9 +27,9 @@ void initProperties() {
2327
ArduinoCloud.addProperty(potentiometer, Permission::Read).publishOnChange(10);
2428
ArduinoCloud.addProperty(seconds, Permission::Read).publishOnChange(1);
2529
#elif defined(BOARD_HAS_LORA)
26-
ArduinoCloud.addProperty(led, 1, READWRITE, ON_CHANGE, onLedChange);
27-
ArduinoCloud.addProperty(potentiometer, 2, READ, ON_CHANGE);
28-
ArduinoCloud.addProperty(seconds, 3, READ, 5 * MINUTES);
30+
ArduinoCloud.addProperty(led, 1, Permission::ReadWrite).onUpdate(onLedChange);
31+
ArduinoCloud.addProperty(potentiometer, 2, Permission::Read).publishOnChange(10);
32+
ArduinoCloud.addProperty(seconds, 3, Permission::Read).publishEvery(5 * MINUTES);
2933
#endif
3034
}
3135

‎examples/ArduinoIoTCloud-Callbacks/ArduinoIoTCloud-Callbacks.ino

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
- https://github.com/arduino-libraries/ArduinoIoTCloud#what
2727
*/
2828

29+
#include <ArduinoIoTCloud.h>
30+
2931
#include "arduino_secrets.h"
3032
#include "thingProperties.h"
3133

‎examples/ArduinoIoTCloud-Callbacks/arduino_secrets.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#include <ArduinoIoTCloud.h>
2-
#include <Arduino_ConnectionHandler.h>
1+
#include <AIoTC_Config.h>
32

43
/* A complete list of supported boards with WiFi is available here:
54
* https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -9,7 +8,7 @@
98
#define SECRET_PASS "YOUR_WIFI_PASSWORD"
109
#endif
1110

12-
/* ESP8266 ESP32*/
11+
/* ESP8266 ESP32 */
1312
#if defined(BOARD_HAS_SECRET_KEY)
1413
#define SECRET_DEVICE_KEY "my-device-password"
1514
#endif

‎examples/ArduinoIoTCloud-Callbacks/thingProperties.h

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
#include <ArduinoIoTCloud.h>
2+
3+
#include "arduino_secrets.h"
4+
15
#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
26
defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
37
#error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"

‎examples/ArduinoIoTCloud-DeferredOTA/ArduinoIoTCloud-DeferredOTA.ino

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
- https://github.com/arduino-libraries/ArduinoIoTCloud/#ota
1717
*/
1818

19+
#include <ArduinoIoTCloud.h>
20+
1921
#include "arduino_secrets.h"
2022
#include "thingProperties.h"
2123

@@ -40,7 +42,7 @@ bool ask_user_via_serial() {
4042
if (Serial.available()) {
4143
char c = Serial.read();
4244
if (c == 'y' || c == 'Y') {
43-
return true;
45+
return true;
4446
}
4547
}
4648
return false;

‎examples/ArduinoIoTCloud-DeferredOTA/arduino_secrets.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#include <ArduinoIoTCloud.h>
2-
#include <Arduino_ConnectionHandler.h>
1+
#include <AIoTC_Config.h>
32

43
/* A complete list of supported boards with WiFi is available here:
54
* https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -9,7 +8,7 @@
98
#define SECRET_PASS "YOUR_WIFI_PASSWORD"
109
#endif
1110

12-
/* ESP8266 ESP32*/
11+
/* ESP8266 ESP32 */
1312
#if defined(BOARD_HAS_SECRET_KEY)
1413
#define SECRET_DEVICE_KEY "my-device-password"
1514
#endif

‎examples/ArduinoIoTCloud-DeferredOTA/thingProperties.h

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
#include <ArduinoIoTCloud.h>
2+
3+
#include "arduino_secrets.h"
4+
15
#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_ETHERNET))
26
#error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
37
#endif

‎examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
77
*/
88

9+
#include <ArduinoIoTCloud.h>
10+
911
#include "arduino_secrets.h"
1012
#include "thingProperties.h"
1113

@@ -207,7 +209,7 @@ void loop() {
207209
if(daily.isActive()) {
208210
Serial.println("Daily schedule is active");
209211
}
210-
212+
211213
/* Activate LED when the weekly schedule is active */
212214
digitalWrite(LED_BUILTIN, weekly.isActive());
213215

@@ -220,5 +222,4 @@ void loop() {
220222
if(yearly.isActive()) {
221223
Serial.println("Yearly schedule is active");
222224
}
223-
224225
}

‎examples/ArduinoIoTCloud-Schedule/arduino_secrets.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
#include <ArduinoIoTCloud.h>
2-
#include <Arduino_ConnectionHandler.h>
1+
#include <AIoTC_Config.h>
32

43
/* A complete list of supported boards with WiFi is available here:
54
* https://github.com/arduino-libraries/ArduinoIoTCloud/#what
@@ -9,7 +8,7 @@
98
#define SECRET_PASS "YOUR_WIFI_PASSWORD"
109
#endif
1110

12-
/* ESP8266 ESP32*/
11+
/* ESP8266 ESP32 */
1312
#if defined(BOARD_HAS_SECRET_KEY)
1413
#define SECRET_DEVICE_KEY "my-device-password"
1514
#endif

‎examples/ArduinoIoTCloud-Schedule/thingProperties.h

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
#include <ArduinoIoTCloud.h>
2+
3+
#include "arduino_secrets.h"
4+
15
#if !(defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_LORA) || \
26
defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT))
37
#error "Please check Arduino IoT Cloud supported boards list: https://github.com/arduino-libraries/ArduinoIoTCloud/#what"
@@ -24,16 +28,16 @@ void initProperties() {
2428
ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
2529
#endif
2630
#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB) || defined(BOARD_HAS_ETHERNET) || defined(BOARD_HAS_CATM1_NBIOT)
27-
ArduinoCloud.addProperty(switchButton, WRITE, ON_CHANGE);
28-
ArduinoCloud.addProperty(oneShot, READWRITE, ON_CHANGE);
29-
ArduinoCloud.addProperty(minute, READWRITE, ON_CHANGE);
30-
ArduinoCloud.addProperty(hourly, READWRITE, ON_CHANGE);
31-
ArduinoCloud.addProperty(daily, READWRITE, ON_CHANGE);
32-
ArduinoCloud.addProperty(weekly, READWRITE, ON_CHANGE);
33-
ArduinoCloud.addProperty(monthly, READWRITE, ON_CHANGE);
34-
ArduinoCloud.addProperty(yearly, READWRITE, ON_CHANGE);
31+
ArduinoCloud.addProperty(switchButton, Permission::Write).onUpdate(nullptr);
32+
ArduinoCloud.addProperty(oneShot, Permission::ReadWrite).onUpdate(nullptr);
33+
ArduinoCloud.addProperty(minute, Permission::ReadWrite).onUpdate(nullptr);
34+
ArduinoCloud.addProperty(hourly, Permission::ReadWrite).onUpdate(nullptr);
35+
ArduinoCloud.addProperty(daily, Permission::ReadWrite).onUpdate(nullptr);
36+
ArduinoCloud.addProperty(weekly, Permission::ReadWrite).onUpdate(nullptr);
37+
ArduinoCloud.addProperty(monthly, Permission::ReadWrite).onUpdate(nullptr);
38+
ArduinoCloud.addProperty(yearly, Permission::ReadWrite).onUpdate(nullptr);
3539
#elif defined(BOARD_HAS_LORA)
36-
ArduinoCloud.addProperty(switchButton, 1, WRITE, ON_CHANGE);
40+
ArduinoCloud.addProperty(switchButton, 1, Permission::Write).onUpdate(nullptr);
3741
#endif
3842
}
3943

0 commit comments

Comments
 (0)