ESP32 compile error is resolved. Examples for ESP32 are added. Documentation is improved.

examples/CrossListening/CrossListening-esp32/CrossListening-esp32.ino

@@ -0,0 +1,189 @@
+/**
+ * @file CrossListening-esp32.ino
+ * @date 24.03.2020
+ * @author Grandeur Technologies
+ *
+ * Copyright (c) 2019 Grandeur Technologies LLP. All rights reserved.
+ * This file is part of the Arduino SDK for Grandeur Cloud.
+ *
+ * Apollo.h is used for device's communication with Grandeur Cloud.
+ * WiFi.h is used for handling device's WiFi.
+ * 
+ * Cross listening means when the device listens for updates from the app and the app
+ * listens for updates from the device.
+ * This example illustrates pretty much every basic thing you'd need in order to monitor /
+ * control your device through Grandeur Cloud. Here are some of those:
+ * 1. Listen to the cloud for updates in parms variables.
+ * 2. Publish updates in summary and parms variables to the cloud every 5 seconds.
+ * 3. Controlling SDK's internal valve. This helps if you want to run the SDK only when a
+ * certain condition is true; in our case, if the WiFi is connected.
+*/
+
+#include <Apollo.h>
+#include <WiFi.h>
+
+// Device's connection configurations
+String apiKey = "YOUR-PROJECT-APIKEY";
+String deviceID = "YOUR-DEVICE-ID";
+String token = "YOUR-ACCESS-TOKEN";
+const char* ssid = "YOUR-WIFI-SSID";
+const char* passphrase = "YOUR-WIFI-PASSWORD";
+
+// Declaring and initializing other variables
+unsigned long current = millis();
+Project myProject;
+Device myDevice;
+int statePin = 4;
+int voltagePin = 2;
+
+// Function prototypes
+void WiFiEventCallback(WiFiEvent_t event);
+void setupWiFi(void);
+void connectionCallback(JSONObject updateObject);
+void initializeState(JSONObject getResult);
+void parmsUpdatedCallback(JSONObject updatedParms);
+void summarySetCallback(JSONObject setResult);
+void parmsSetCallback(JSONObject setResult);
+
+
+void setup() {
+  Serial.begin(9600);
+  // This sets up the device WiFi.
+  setupWiFi();
+  // This initializes the SDK's configurations and returns a new object of Project class.
+  myProject = apollo.init(apiKey, token);
+  // Getting object of Device class.
+  myDevice = myProject.device(deviceID);
+  // This schedules the connectionCallback() function to be called when connection with the cloud
+  // is made/broken.
+  myProject.onConnection(connectionCallback);
+  // This schedules parmsUpdatedCallback() function to be called when variable stored
+  // in device's parms are changed on the Cloud.
+  myDevice.onParms(parmsUpdatedCallback);
+}
+
+void loop() {
+  // In this loop() function, after every five seconds, we send the updated values of our
+  // device's voltage and state to the Cloud.
+  if(myProject.isConnected()) {
+    if(millis() - current >= 5000) {
+      // This if-condition makes sure that the code inside this block runs only after
+      // every five seconds.
+
+      Serial.println("Setting Summary");
+      JSONObject summary;
+      summary["voltage"] = analogRead(voltagePin);
+      // This updates the summary of our device on the Cloud and schedules summarySetCallback()
+      // function to be called when the Cloud responds with the SUMMARY UPDATED message.
+      myDevice.setSummary(summary, summarySetCallback);
+
+      Serial.println("Setting Parms");
+      JSONObject parms;
+      parms["state"] = digitalRead(statePin);
+      // This updates the parms of our device on the Cloud and schedules parmsSetCallback()
+      // function to be called when the Cloud responds with the PARMS UPDATED message.
+      myDevice.setParms(parms, parmsSetCallback);
+
+      // This updates the millis counter for
+      // the five seconds scheduler.
+      current = millis();
+    }
+  }
+
+  // This runs the SDK only when the WiFi is connected.
+  myProject.loop(WiFi.status() == WL_CONNECTED);
+}
+
+void WiFiEventCallback(WiFiEvent_t event) {
+  switch(event) {
+    case SYSTEM_EVENT_STA_GOT_IP:
+      // This runs when the device connects with WiFi.
+      Serial.printf("\nDevice has successfully connected to WiFi. Its IP Address is: %s\n",
+        WiFi.localIP().toString().c_str());
+      break;
+    case SYSTEM_EVENT_STA_DISCONNECTED:
+      // This runs when the device disconnects with WiFi.
+      Serial.println("Device is disconnected from WiFi.");
+      break;
+    default: break;
+  }
+}
+
+void setupWiFi(void) {
+  // Disconnecting WiFi if it"s already connected
+  WiFi.disconnect();
+  // Setting it to Station mode which basically scans for nearby WiFi routers
+  WiFi.mode(WIFI_STA);
+  // Setting WiFi event handler
+  WiFi.onEvent(WiFiEventCallback);
+  // Begin connecting to WiFi
+  WiFi.begin(ssid, passphrase);
+  Serial.printf("\nDevice is connecting to WiFi using SSID %s and Passphrase %s.\n", ssid, passphrase);
+}
+
+void connectionCallback(bool state) {
+  switch(state) {
+    case CONNECTED:
+      // On successful connection with the cloud, we initialize the device's *state*.
+      // To do that, we get device parms from the cloud and set the *state pin* to the
+      // value of *state* in those parms.
+      Serial.println("Device is connected to the cloud.");
+      myDevice.getParms(initializeState);
+      Serial.println("Listening for parms update from the cloud...");
+      // Initializing the millis counter for the five
+      // seconds timer.
+      current = millis();
+      break;
+    case DISCONNECTED:
+      Serial.println("Device is disconnected from the cloud.");
+      break;
+  }
+}
+
+void initializeState(JSONObject getResult) {
+  // This function sets the *state pin* to the *state value* that we received in parms
+  // from the cloud.
+  if(getResult["code"] == "DEVICE-PARMS-FETCHED") {
+    int state = getResult["deviceParms"]["state"];
+    digitalWrite(statePin, state);
+    return;
+  }
+  // If the parms could not be fetched.
+  Serial.println("Failed to Fetch Parms");
+  return;
+}
+
+void parmsUpdatedCallback(JSONObject updatedParms) {
+  // This function gets the *updated state* from the device parms and set the *state pin*
+  // with *state value*.
+  Serial.printf("Updated State is: %d\n", (bool) updatedParms["state"]);
+  digitalWrite(statePin, (bool) updatedParms["state"]); 
+}
+
+void summarySetCallback(JSONObject setResult) {
+  if(setResult["code"] == "DEVICE-SUMMARY-UPDATED") {
+    Serial.printf("Voltage is updated to: %d\n", (int) setResult["update"]["voltage"]);
+
+    /* You can set some pins or trigger events here which depend on successful
+    ** device summary update.
+    */
+    return;
+  }
+  // If the summary could not be updated.
+  Serial.println("Failed to Update Summary");
+  return;
+}
+
+void parmsSetCallback(JSONObject setResult) {
+  if(setResult["code"] == "DEVICE-PARMS-UPDATED") {
+    Serial.printf("State is updated to: %d\n", (bool) setResult["update"]["state"]);
+
+    /* You can set some pins or trigger events here which depend on successful
+    ** device parms update.
+    */
+    return;
+  }
+  // If the parms could not be updated.
+  Serial.println("Failed to Update Parms");
+  return;
+}

examples/CrossListening/CrossListening.ino → examples/CrossListening/CrossListening-esp8266/CrossListening-esp8266.ino

@@ -1,5 +1,5 @@
 /**
- * @file CrossListening.ino
+ * @file CrossListening-esp8266.ino
  * @date 24.03.2020
  * @author Grandeur Technologies
  *

examples/DashListening-App/DashListening-App-esp32/DashListening-App-esp32.ino

@@ -0,0 +1,172 @@
+/**
+ * @file DashListening-App-esp32.ino
+ * @date 24.03.2020
+ * @author Grandeur Technologies
+ *
+ * Copyright (c) 2019 Grandeur Technologies LLP. All rights reserved.
+ * This file is part of the Arduino SDK for Grandeur Cloud.
+ *
+ * Apollo.h is used for device's communication to Grandeur Cloud.
+ * WiFi.h is used for handling device's WiFi.
+ * 
+ * Dash listening is for one-way listening.
+ * This example illustrates the use case of an app listening for updates from the device.
+ * It would be useful in building a DEVICE MONITOR which would show how your devices are
+ * behaving in terms of their energy units consumed for example.
+*/
+
+#include <Apollo.h>
+#include <WiFi.h>
+
+// Device's connection configurations
+String apiKey = "YOUR-PROJECT-APIKEY";
+String deviceID = "YOUR-DEVICE-ID";
+String token = "YOUR-ACCESS-TOKEN";
+const char* ssid = "YOUR-WIFI-SSID";
+const char* passphrase = "YOUR-WIFI-PASSWORD";
+
+// Declaring and initializing other variables
+unsigned long current = millis();
+Project myProject;
+Device myDevice;
+int statePin = 4;
+int voltagePin = 2;
+
+// Function prototypes
+void WiFiEventCallback(WiFiEvent_t event);
+void setupWiFi(void);
+void connectionCallback(bool state);
+void initializeState(JSONObject getResult);
+void summarySetCallback(JSONObject setResult);
+void parmsSetCallback(JSONObject setResult);
+
+void setup() {
+  Serial.begin(9600);
+  // This sets up the device WiFi.
+  setupWiFi();
+  // This initializes the SDK's configurations and returns a new object of Project class.
+  myProject = apollo.init(apiKey, token);
+  // Getting object of Device class.
+  myDevice = myProject.device(deviceID);
+  // This schedules the connectionCallback() function to be called when connection with the cloud
+  // is made/broken.
+  myProject.onConnection(connectionCallback);
+}
+
+void loop() {
+  // In this loop() function, after every five seconds, we send the updated values of our
+  // device's voltage and state to the Cloud.
+  if(myProject.isConnected()) {
+    if(millis() - current >= 5000) {
+      // This if-condition makes sure that the code inside this block runs only after
+      // every five seconds.
+
+      Serial.println("Setting Summary");
+      JSONObject summary;
+      summary["voltage"] = analogRead(voltagePin);
+      // This updates the summary of our device on the Cloud and schedules summarySetCallback()
+      // function to be called when the Cloud responds with the SUMMARY UPDATED message.
+      myDevice.setSummary(summary, summarySetCallback);
+
+      Serial.println("Setting Parms");
+      JSONObject parms;
+      parms["state"] = digitalRead(statePin);
+      // This updates the parms of our device on the Cloud and schedules parmsSetCallback()
+      // function to be called when the Cloud responds with the PARMS UPDATED message.
+      myDevice.setParms(parms, parmsSetCallback);
+
+      // This updates the millis counter for
+      // the five seconds scheduler.
+      current = millis();
+    }
+  }
+
+  // This runs the SDK only when the WiFi is connected.
+  myProject.loop(WiFi.status() == WL_CONNECTED);
+}
+
+void WiFiEventCallback(WiFiEvent_t event) {
+  switch(event) {
+    case SYSTEM_EVENT_STA_GOT_IP:
+      // This runs when the device connects with WiFi.
+      Serial.printf("\nDevice has successfully connected to WiFi. Its IP Address is: %s\n",
+        WiFi.localIP().toString().c_str());
+      break;
+    case SYSTEM_EVENT_STA_DISCONNECTED:
+      // This runs when the device disconnects with WiFi.
+      Serial.println("Device is disconnected from WiFi.");
+      break;
+    default: break;
+  }
+}
+
+void setupWiFi(void) {
+  // Disconnecting WiFi if it"s already connected
+  WiFi.disconnect();
+  // Setting it to Station mode which basically scans for nearby WiFi routers
+  WiFi.mode(WIFI_STA);
+  // Setting WiFi event handler
+  WiFi.onEvent(WiFiEventCallback);
+  // Begin connecting to WiFi
+  WiFi.begin(ssid, passphrase);
+  Serial.printf("\nDevice is connecting to WiFi using SSID %s and Passphrase %s.\n", ssid, passphrase);
+}
+
+void connectionCallback(bool state) {
+  switch(state) {
+    case CONNECTED:
+      // On successful connection with the cloud, we initialize the device's *state*.
+      // To do that, we get device parms from the cloud and set the *state pin* to the value of *state* in those parms.
+      Serial.println("Device is connected to the cloud.");
+      myDevice.getParms(initializeState);
+
+      // Initializing the millis counter for the five
+      // seconds timer.
+      current = millis();
+      break;
+    case DISCONNECTED:
+      Serial.println("Device is disconnected from the cloud.");
+      break;
+  }
+}
+
+void initializeState(JSONObject getResult) {
+  // This function sets the *state pin* to the *state value* that we received in parms
+  // from the cloud.
+  if(getResult["code"] == "DEVICE-PARMS-FETCHED") {
+    int state = getResult["deviceParms"]["state"];
+    digitalWrite(statePin, state);
+    return;
+  }
+  // If the parms could not be fetched.
+  Serial.println("Failed to Fetch Parms");
+  return;
+}
+
+void summarySetCallback(JSONObject setResult) {
+  if(setResult["code"] == "DEVICE-SUMMARY-UPDATED") {
+    Serial.printf("Voltage is updated to: %d\n", (int) setResult["update"]["voltage"]);
+
+    /* You can set some pins or trigger events here which depend on successful
+    ** device summary update.
+    */
+    return;
+  }
+  // If the summary could not be updated.
+  Serial.println("Failed to Update Summary");
+  return;
+}
+
+void parmsSetCallback(JSONObject setResult) {
+  if(setResult["code"] == "DEVICE-PARMS-UPDATED") {
+    Serial.printf("State is updated to: %d\n", (bool) setResult["update"]["state"]);
+
+    /* You can set some pins or trigger events here which depend on successful
+    ** device parms update.
+    */
+    return;
+  }
+  // If the parms could not be updated.
+  Serial.println("Failed to Update Parms");
+  return;
+}

examples/DashListening-App/DashListening-App.ino → examples/DashListening-App/DashListening-App-esp8266/DashListening-App-esp8266.ino

@@ -1,5 +1,5 @@
 /**
- * @file DashListening-App.ino
+ * @file DashListening-App-esp8266.ino
  * @date 24.03.2020
  * @author Grandeur Technologies
  *
@@ -25,7 +25,7 @@ String token = "YOUR-ACCESS-TOKEN";
 String ssid = "YOUR-WIFI-SSID";
 String passphrase = "YOUR-WIFI-PASSWORD";
 
-/// Declaring and initializing other variables
+// Declaring and initializing other variables
 unsigned long current = millis();
 Project myProject;
 Device myDevice;