Add example sketch for cloud schedule property

Author: pennam

examples/ArduinoIoTCloud-Schedule/ArduinoIoTCloud-Schedule.ino

@@ -0,0 +1,54 @@
+/*
+  This sketch demonstrates how to use cloud schedule data type.
+
+  This sketch is compatible with:
+   - MKR 1000
+   - MKR WIFI 1010
+   - MKR GSM 1400
+   - MKR NB 1500
+   - MKR WAN 1300/1310
+   - Nano 33 IoT
+   - ESP 8266
+*/
+
+#include "arduino_secrets.h"
+#include "thingProperties.h"
+
+#if defined(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); ) { }
+
+  /* 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);
+
+  setDebugMessageLevel(DBG_INFO);
+  ArduinoCloud.printDebugInfo();
+
+  /* Configure a schedule for LED. This should be done with Arduino create Scheduler widget */
+  unsigned int startingFrom = 1635786000;                /* From 01/11/2021 17:00           */
+  unsigned int untilTo = startingFrom + ( DAYS * 28 );   /* To   29/11/2021 17:00           */
+  unsigned int executionPeriod = MINUTES * 6;            /* For         6 minutes           */
+  unsigned int scheduleConfiguration =  134217770;       /* On monday wednesday and friday  */
+
+  led = Schedule(startingFrom, untilTo, executionPeriod, scheduleConfiguration);
+}
+
+void loop() {
+  ArduinoCloud.update();
+
+  /* Activate LED when schedule is active */
+  digitalWrite(LED_BUILTIN, led.isActive());
+  
+}
+

examples/ArduinoIoTCloud-Schedule/arduino_secrets.h

@@ -0,0 +1,34 @@
+#include <Arduino_ConnectionHandler.h>
+
+/* MKR1000, MKR WiFi 1010 */
+#if defined(BOARD_HAS_WIFI)
+  #define SECRET_SSID "YOUR_WIFI_NETWORK_NAME"
+  #define SECRET_PASS "YOUR_WIFI_PASSWORD"
+#endif
+
+/* ESP8266 */
+#if defined(BOARD_ESP8266)
+  #define SECRET_DEVICE_KEY "my-device-password"
+#endif
+
+/* MKR GSM 1400 */
+#if defined(BOARD_HAS_GSM)
+  #define SECRET_PIN ""
+  #define SECRET_APN ""
+  #define SECRET_LOGIN ""
+  #define SECRET_PASS ""
+#endif
+
+/* MKR WAN 1300/1310 */
+#if defined(BOARD_HAS_LORA)
+  #define SECRET_APP_EUI ""
+  #define SECRET_APP_KEY ""
+#endif
+
+/* MKR NB 1500 */
+#if defined(BOARD_HAS_NB)
+  #define SECRET_PIN ""
+  #define SECRET_APN ""
+  #define SECRET_LOGIN ""
+  #define SECRET_PASS ""
+#endif

examples/ArduinoIoTCloud-Schedule/thingProperties.h

@@ -0,0 +1,35 @@
+#include <ArduinoIoTCloud.h>
+#include <Arduino_ConnectionHandler.h>
+
+#define THING_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+#define BOARD_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+
+void onSwitchButtonChange();
+
+bool switchButton;
+CloudSchedule led;
+
+void initProperties() {
+#if defined(BOARD_ESP8266)
+  ArduinoCloud.setBoardId(BOARD_ID);
+  ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
+#endif
+  ArduinoCloud.setThingId(THING_ID);
+#if defined(BOARD_HAS_WIFI) || defined(BOARD_HAS_GSM) || defined(BOARD_HAS_NB)
+  ArduinoCloud.addProperty(switchButton, WRITE, ON_CHANGE);
+  ArduinoCloud.addProperty(led, READWRITE, ON_CHANGE);
+#elif defined(BOARD_HAS_LORA)
+  ArduinoCloud.addProperty(switchButton, 1, WRITE, ON_CHANGE;
+  ArduinoCloud.addProperty(led, 2, READWRITE, ON_CHANGE);
+#endif
+}
+
+#if defined(BOARD_HAS_WIFI)
+  WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_SSID, SECRET_PASS);
+#elif defined(BOARD_HAS_GSM)
+  GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
+#elif defined(BOARD_HAS_LORA)
+  LoRaConnectionHandler ArduinoIoTPreferredConnection(SECRET_APP_EUI, SECRET_APP_KEY, _lora_band::EU868, NULL, _lora_class::CLASS_A);
+#elif defined(BOARD_HAS_NB)
+  NBConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
+#endif