Merge pull request #26 from grandeurtech/feature-trex

Updated event emitter, class hierarchies, enhancement to device.data().get() and device.data().set(), and support for Var and Callback in examples.

Author: moizhusnain

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

@@ -1,9 +1,9 @@
 /**
  * @file CrossListening-esp32.ino
- * @date 24.03.2020
+ * @date 21.02.2021
  * @author Grandeur Technologies
  *
- * Copyright (c) 2019 Grandeur Technologies LLP. All rights reserved.
+ * Copyright (c) 2021 Grandeur Technologies Inc. All rights reserved.
  * This file is part of the Arduino SDK for Grandeur.
  *
  * Grandeur.h is used for device's communication with Grandeur.
@@ -13,70 +13,78 @@
  * 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. 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.
+ * 1. Listen to Grandeur for updates in device variables.
+ * 2. Publish updates in variables to Grandeur every 5 seconds.
+ * 3. Running the SDK only when a certain condition is true; in our case, if the WiFi is connected.
+ * 
+ * After uploading this sketch to your ESP, go to https://canvas.grandeur.tech and add a button and
+ * a display to control state and monitor voltage variable, respectively.
 */
 
 #include <Grandeur.h>
 #include <WiFi.h>
 
-// Device's connection configurations
+// 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 project;
-Data data;
+// Handles our 5 second timer in loop().
+unsigned long currentTime = millis();
+// Object of Grandeur project.
+Grandeur::Project project;
+// Device data object to get/set/subscribe to device variables.
+Grandeur::Project::Device::Data data;
+// State and voltage pins to set.
 int statePin = 4;
 int voltagePin = 2;
 
-// Function prototypes
+// FUNCTION PROTOTYPES:
+// Handles WiFi connection/disconnection events.
 void WiFiEventCallback(WiFiEvent_t event);
-void setupWiFi(void);
-void connectionCallback(bool state);
-void initializeState(Var getResult);
-void stateUpdatedCallback(bool state, const char* path);
-void voltageSetCallback(Var setResult);
+// Starts the device WiFi.
+void startWiFi(void);
+// Handles Grandeur connection/disconnection events.
+void GrandeurConnectionCallback(bool state);
+// Data get/set/update callback functions:
+void initializeStatePin(const char* code, bool state);
+void setStatePinToNewValue(const char* path, bool state);
+void afterVoltageIsUpdated(const char* code, int voltage);
 
 void setup() {
   Serial.begin(9600);
-  // This sets up the device WiFi.
-  setupWiFi();
+  startWiFi();
   // This initializes the SDK's configurations and returns reference to your project.
   project = grandeur.init(apiKey, token);
-  // Getting reference to your device.
+  // Getting object of your device data.
   data = project.device(deviceID).data();
-  // This schedules the connectionCallback() function to be called when connection with Grandeur
+  // This schedules the GrandeurConnectionCallback() function to be called when connection with Grandeur
   // is made/broken.
-  project.onConnection(connectionCallback);
-  // This schedules stateUpdatedCallback() function to be called when the device state is
-  // changed on Grandeur.
-  data.on("state", stateUpdatedCallback);
+  project.onConnection(GrandeurConnectionCallback);
+  // This schedules setStatePinToNewValue() function to be called when a change in device state occurs
+  // on Grandeur.
+  data.on("state", setStatePinToNewValue);
+  Serial.println("Listening for state update from Grandeur...");
 }
 
 void loop() {
   // In this loop() function, after every five seconds, we send the updated values of our
-  // device's voltage and state to Grandeur.
+  // device's voltage to Grandeur.
   if(project.isConnected()) {
-    if(millis() - current >= 5000) {
+    if(millis() - currentTime >= 5000) {
       // This if-condition makes sure that the code inside this block runs only after
       // every five seconds.
 
-      Serial.println("Setting Voltage");  
+      Serial.println("Setting Voltage");
       int voltage = analogRead(voltagePin);
-      // This updates the voltage of our device on Grandeur and schedules voltageSetCallback()
+      // This updates the voltage of our device on Grandeur and schedules afterVoltageIsUpdated()
       // function to be called when Grandeur responds with the DATA UPDATED message.
-      data.set("voltage", voltage, voltageSetCallback);
+      data.set("voltage", voltage, afterVoltageIsUpdated);
 
-      // This updates the millis counter for
-      // the five seconds scheduler.
-      current = millis();
+      // This updates the current time for the five seconds timer.
+      currentTime = millis();
     }
   }
 
@@ -99,7 +107,7 @@ void WiFiEventCallback(WiFiEvent_t event) {
   }
 }
 
-void setupWiFi(void) {
+void startWiFi(void) {
   // Disconnecting WiFi if it"s already connected
   WiFi.disconnect();
   // Setting it to Station mode which basically scans for nearby WiFi routers
@@ -111,30 +119,29 @@ void setupWiFi(void) {
   Serial.printf("\nDevice is connecting to WiFi using SSID %s and Passphrase %s.\n", ssid, passphrase);
 }
 
-void connectionCallback(bool status) {
+void GrandeurConnectionCallback(bool status) {
   switch(status) {
-    case CONNECTED:
+    case CONNECTED: // Expands to true.
+      Serial.println("Device is connected with Grandeur.");
       // On successful connection with Grandeur, we initialize the device's *state*.
       // To do that, we get device state from Grandeur and set the *state pin* to its
       // value.
-      Serial.println("Device is connected with Grandeur.");
-      data.get("state", initializeState);
-      Serial.println("Listening for state update from Grandeur...");
+      data.get("state", initializeStatePin);
+
       // Initializing the millis counter for the five
       // seconds timer.
-      current = millis();
+      currentTime = millis();
       break;
-    case DISCONNECTED:
+    case DISCONNECTED: // Expands to false.
       Serial.println("Device's connection with Grandeur is broken.");
       break;
   }
 }
 
-void initializeState(Var getResult) {
+void initializeStatePin(const char* code, bool state) {
   // This function sets the *state pin* to the *state value* that we received in data
   // from Grandeur.
-  if(getResult["code"] == "DEVICE-DATA-FETCHED") {
-    int state = getResult["data"];
+  if(strcmp(code, "DEVICE-DATA-FETCHED") == 0) {
     Serial.printf("State is: %d\n", state);
     digitalWrite(statePin, state);
     return;
@@ -144,16 +151,15 @@ void initializeState(Var getResult) {
   return;
 }
 
-void stateUpdatedCallback(bool state, const char* path) {
-  // This function gets the *updated state* from Grandeur and set the *state pin*
-  // with its value.
+void setStatePinToNewValue(const char* path, bool state) {
+  // This function sets the *state pin* to state value.
   Serial.printf("Updated State is: %d\n", state);
   digitalWrite(statePin, state);
 }
 
-void voltageSetCallback(Var setResult) {
-  if(setResult["code"] == "DEVICE-DATA-UPDATED") {
-    Serial.printf("Voltage is updated to: %d\n", (int) setResult["update"]);
+void afterVoltageIsUpdated(const char* code, int voltage) {
+  if(strcmp(code, "DEVICE-DATA-UPDATED") == 0) {
+    Serial.printf("Voltage is updated to: %d\n", voltage);
 
     /* You can set some pins or trigger events here which depend on successful
     ** voltage update.

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

@@ -1,9 +1,9 @@
 /**
  * @file CrossListening-esp8266.ino
- * @date 24.03.2020
+ * @date 21.02.2021
  * @author Grandeur Technologies
  *
- * Copyright (c) 2019 Grandeur Technologies LLP. All rights reserved.
+ * Copyright (c) 2021 Grandeur Technologies Inc. All rights reserved.
  * This file is part of the Arduino SDK for Grandeur.
  *
  * Grandeur.h is used for device's communication with Grandeur.
@@ -13,79 +13,87 @@
  * 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. 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.
+ * 1. Listen to Grandeur for updates in device variables.
+ * 2. Publish updates in variables to Grandeur every 5 seconds.
+ * 3. Running the SDK only when a certain condition is true; in our case, if the WiFi is connected.
+ * 
+ * After uploading this sketch to your ESP, go to https://canvas.grandeur.tech and add a button and
+ * a display to control state and monitor voltage variable, respectively.
 */
 
 #include <Grandeur.h>
 #include <ESP8266WiFi.h>
 
-// Device's connection configurations
+// Device's connection configurations:
 String apiKey = "YOUR-PROJECT-APIKEY";
 String deviceID = "YOUR-DEVICE-ID";
 String token = "YOUR-ACCESS-TOKEN";
-String ssid = "YOUR-WIFI-SSID";
-String passphrase = "YOUR-WIFI-PASSWORD";
+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;
-WiFiEventHandler onWiFiConnectedHandler;
-WiFiEventHandler onWiFiDisconnectedHandler;
+// Handles our 5 second timer in loop().
+unsigned long currentTime = millis();
+// Object of Grandeur project.
+Grandeur::Project project;
+// Device data object to get/set/subscribe to device variables.
+Grandeur::Project::Device::Data data;
+// State and voltage pins to set.
 int statePin = D0;
 int voltagePin = A0;
 
-// Function prototypes
-void setupWiFi(void);
-void connectionCallback(bool state);
-void initializeState(Var getResult);
-void stateUpdatedCallback(bool state, const char* path);
-void voltageSetCallback(Var setResult);
+// FUNCTION PROTOTYPES:
+// These handle WiFi connection/disconnection events.
+WiFiEventHandler onWiFiConnectedHandler;
+WiFiEventHandler onWiFiDisconnectedHandler;
+// Starts the device WiFi.
+void startWiFi(void);
+// Handles Grandeur connection/disconnection events.
+void GrandeurConnectionCallback(bool state);
+// Data get/set/update callback functions:
+void initializeStatePin(const char* code, bool state);
+void setStatePinToNewValue(const char* path, bool state);
+void afterVoltageIsUpdated(const char* code, int voltage);
 
 void setup() {
   Serial.begin(9600);
-  // This sets up the device WiFi.
-  setupWiFi();
+  startWiFi();
   // This initializes the SDK's configurations and returns reference to your project.
   project = grandeur.init(apiKey, token);
-  // Getting reference to your device.
+  // Getting object of your device data.
   data = project.device(deviceID).data();
   // This schedules the connectionCallback() function to be called when connection with Grandeur
   // is made/broken.
-  project.onConnection(connectionCallback);
-  // This schedules stateUpdatedCallback() function to be called when the device state is
-  // changed on Grandeur.
-  data.on("state", stateUpdatedCallback);
+  project.onConnection(GrandeurConnectionCallback);
+  // This schedules setStatePinToNewValue() function to be called when a change in device state occurs
+  // on Grandeur.
+  data.on("state", setStatePinToNewValue);
+  Serial.println("Listening for state update from Grandeur...");
 }
 
 void loop() {
   // In this loop() function, after every five seconds, we send the updated values of our
-  // device's voltage and state to Grandeur.
+  // device's voltage to Grandeur.
   if(project.isConnected()) {
-    if(millis() - current >= 5000) {
+    if(millis() - currentTime >= 5000) {
       // This if-condition makes sure that the code inside this block runs only after
       // every five seconds.
 
-      Serial.println("Setting Voltage");  
+      Serial.println("Setting Voltage");
       int voltage = analogRead(voltagePin);
-      // This updates the voltage of our device on Grandeur and schedules voltageSetCallback()
+      // This updates the voltage of our device on Grandeur and schedules afterVoltageIsUpdated()
       // function to be called when Grandeur responds with the DATA UPDATED message.
-      data.set("voltage", voltage, voltageSetCallback);
+      data.set("voltage", voltage, afterVoltageIsUpdated);
 
-      // This updates the millis counter for
-      // the five seconds scheduler.
-      current = millis();
+      // This updates the current time for the five seconds timer.
+      currentTime = millis();
     }
   }
 
   // This runs the SDK only when the WiFi is connected.
   project.loop(WiFi.status() == WL_CONNECTED);
 }
 
-void setupWiFi(void) {
+void startWiFi(void) {
   // Disconnecting WiFi if it"s already connected
   WiFi.disconnect();
   // Setting it to Station mode which basically scans for nearby WiFi routers
@@ -105,30 +113,29 @@ void setupWiFi(void) {
   Serial.printf("\nDevice is connecting to WiFi using SSID %s and Passphrase %s.\n", ssid.c_str(), passphrase.c_str());
 }
 
-void connectionCallback(bool status) {
+void GrandeurConnectionCallback(bool status) {
   switch(status) {
-    case CONNECTED:
+    case CONNECTED: // Expands to true.
+      Serial.println("Device is connected with Grandeur.");
       // On successful connection with Grandeur, we initialize the device's *state*.
       // To do that, we get device state from Grandeur and set the *state pin* to its
       // value.
-      Serial.println("Device is connected with Grandeur.");
-      data.get("state", initializeState);
-      Serial.println("Listening for state update from Grandeur...");
+      data.get("state", initializeStatePin);
+
       // Initializing the millis counter for the five
       // seconds timer.
-      current = millis();
+      currentTime = millis();
       break;
-    case DISCONNECTED:
+    case DISCONNECTED: // Expands to false.
       Serial.println("Device's connection with Grandeur is broken.");
       break;
   }
 }
 
-void initializeState(Var getResult) {
+void initializeStatePin(const char* code, bool state) {
   // This function sets the *state pin* to the *state value* that we received in data
   // from Grandeur.
-  if(getResult["code"] == "DEVICE-DATA-FETCHED") {
-    int state = getResult["data"];
+  if(strcmp(code, "DEVICE-DATA-FETCHED") == 0) {
     Serial.printf("State is: %d\n", state);
     digitalWrite(statePin, state);
     return;
@@ -138,16 +145,15 @@ void initializeState(Var getResult) {
   return;
 }
 
-void stateUpdatedCallback(bool state, const char* path) {
-  // This function gets the *updated state* from Grandeur and set the *state pin*
-  // with its value.
+void setStatePinToNewValue(const char* path, bool state) {
+  // This function sets the *state pin* to state value.
   Serial.printf("Updated State is: %d\n", state);
   digitalWrite(statePin, state);
 }
 
-void voltageSetCallback(Var setResult) {
-  if(setResult["code"] == "DEVICE-DATA-UPDATED") {
-    Serial.printf("Voltage is updated to: %d\n", (int) setResult["update"]);
+void afterVoltageIsUpdated(const char* code, int voltage) {
+  if(strcmp(code, "DEVICE-DATA-UPDATED") == 0) {
+    Serial.printf("Voltage is updated to: %d\n", voltage);
 
     /* You can set some pins or trigger events here which depend on successful
     ** voltage update.