Merge pull request #64 from arduino-libraries/multi-value-properties

Multi value properties management

Author: Mattia Bertorello

examples/ArduinoIoTCloud_Travis_CI/thingProperties.h

@@ -94,9 +94,9 @@ void initProperties() {
   ArduinoCloud.addProperty(float_property_3, Permission::ReadWrite).publishOnChange(MIN_DELTA_FLOAT_PROPERTY);
   ArduinoCloud.addProperty(float_property_4, Permission::ReadWrite).publishOnChange(MIN_DELTA_FLOAT_PROPERTY).onUpdate(onFloatPropertyChange);
 
-  ArduinoCloud.addProperty(str_property_3, READWRITE, 1 * SECONDS, 0 /* onStringPropertyChange */, "" /* 'minDelta' */, MOST_RECENT_WINS);
-  ArduinoCloud.addProperty(str_property_4, READWRITE, 1 * SECONDS, 0 /* onStringPropertyChange */, "" /* 'minDelta' */, CLOUD_WINS);
-  ArduinoCloud.addProperty(str_property_5, READWRITE, 1 * SECONDS, 0 /* onStringPropertyChange */, "" /* 'minDelta' */, DEVICE_WINS);
+  ArduinoCloud.addProperty(str_property_3, READWRITE, 1 * SECONDS, 0 /* onStringPropertyChange */, 0.0 /* 'minDelta' */, MOST_RECENT_WINS);
+  ArduinoCloud.addProperty(str_property_4, READWRITE, 1 * SECONDS, 0 /* onStringPropertyChange */, 0.0 /* 'minDelta' */, CLOUD_WINS);
+  ArduinoCloud.addProperty(str_property_5, READWRITE, 1 * SECONDS, 0 /* onStringPropertyChange */, 0.0 /* 'minDelta' */, DEVICE_WINS);
 
   ArduinoCloud.addProperty(str_property_6, Permission::ReadWrite).publishEvery(1 * SECONDS).onSync(MOST_RECENT_WINS);
   ArduinoCloud.addProperty(str_property_7, Permission::ReadWrite).publishEvery(1 * SECONDS).onSync(CLOUD_WINS);

examples/MultiValue_example/MultiValue_example.ino

@@ -0,0 +1,77 @@
+#include "arduino_secrets.h"
+/*
+  Sketch generated by the Arduino IoT Cloud Thing "Test_MultiValue"
+  https://create-dev.arduino.cc/cloud/things/06012290-ec85-4f5c-aa00-81c0525efa0c
+
+  Arduino IoT Cloud Properties description
+
+  The following variables are automatically generated and updated when changes are made to the Thing properties
+
+  bool Switch;
+
+  Properties which are marked as READ/WRITE in the Cloud Thing will also have functions
+  which are called when their values are changed from the Dashboard.
+  These functions are generated with the Thing and added at the end of this sketch.
+*/
+
+#include "thingProperties.h"
+
+void setup() {
+  // Initialize serial and wait for port to open:
+  Serial.begin(9600);
+  // This delay gives the chance to wait for a Serial Monitor without blocking if none is found
+  delay(1500);
+
+  // Defined in thingProperties.h
+  initProperties();
+
+  // Connect to Arduino IoT Cloud
+  ArduinoCloud.begin(ArduinoIoTPreferredConnection, "mqtts-sa.iot.oniudra.cc");
+
+  /*
+     The following function allows you to obtain more information
+     related to the state of network and IoT Cloud connection and errors
+     the higher number the more granular information you’ll get.
+     The default is 0 (only errors).
+     Maximum is 4
+  */
+  setDebugMessageLevel(2);
+  ArduinoCloud.printDebugInfo();
+}
+
+float latMov = 45.5058224, lonMov = 9.1628673;
+float latArd = 45.0502078, lonArd = 7.6674765;
+
+float hueRed = 0.0, satRed = 100.0, briRed = 100.0;
+float hueGreen = 80.0, satGreen = 100.0, briGreen = 100.0;
+
+void loop() {
+  ArduinoCloud.update();
+  // Your code here
+
+  Switch = !Switch;
+  if (Switch) {
+    Loc =   { .lat = latMov,   .lon = lonMov };
+    Color = { .hue = hueRed,   .sat = satRed,    .bri = briRed };
+  }  else {
+    Loc =   { .lat = latArd,   .lon = lonArd };
+    Color = { .hue = hueGreen, .sat = satGreen, .bri = briGreen };
+  }
+  delay(5000);
+}
+
+
+void onSwitchChange() {
+  // Do something
+  digitalWrite(LED_BUILTIN, Switch);
+}
+
+void onColorChange() {
+  // Do something
+  Serial.print("Hue = ");
+  Serial.println(Color.getValue().hue);
+  Serial.print("Sat = ");
+  Serial.println(Color.getValue().sat);
+  Serial.print("Bri = ");
+  Serial.println(Color.getValue().bri);
+}

examples/MultiValue_example/arduino_secrets.h

@@ -0,0 +1,2 @@
+#define SECRET_SSID ""
+#define SECRET_PASS ""

examples/MultiValue_example/thingProperties.h

@@ -0,0 +1,24 @@
+#include <ArduinoIoTCloud.h>
+#include <WiFiConnectionManager.h>
+
+// Set the Thing Id value
+const char THING_ID[] = "";
+
+const char SSID[]     = SECRET_SSID;    // Network SSID (name)
+const char PASS[]     = SECRET_PASS;    // Network password (use for WPA, or use as key for WEP)
+
+void onSwitchChange();
+void onColorChange();
+
+bool Switch;
+CloudLocation Loc;
+CloudColor Color;
+
+void initProperties() {
+  ArduinoCloud.setThingId(THING_ID);
+  ArduinoCloud.addProperty(Switch, READWRITE, ON_CHANGE, onSwitchChange);
+  ArduinoCloud.addProperty(Loc, READ, ON_CHANGE, NULL);
+  ArduinoCloud.addProperty(Color, READWRITE, ON_CHANGE, onColorChange);
+}
+
+ConnectionManager *ArduinoIoTPreferredConnection = new WiFiConnectionManager(SSID, PASS);

src/ArduinoIoTCloud.cpp

@@ -51,15 +51,6 @@ static unsigned long getTime() {
   return time;
 }
 
-static unsigned long getTimestamp() {
-  #ifdef ARDUINO_ARCH_SAMD
-  return rtc.getEpoch();
-  #else
-#warning "No RTC available on this architecture - ArduinoIoTCloud will not keep track of local change timestamps ."
-  return 0;
-  #endif
-}
-
 ArduinoIoTCloudClass::ArduinoIoTCloudClass() :
   _thing_id(""),
   _bearSslClient(NULL),
@@ -226,11 +217,8 @@ void ArduinoIoTCloudClass::update(CallbackFunc onSyncCompleteCallback) {
 }
 
 void ArduinoIoTCloudClass::update(int const reconnectionMaxRetries, int const reconnectionTimeoutMs, CallbackFunc onSyncCompleteCallback) {
-  unsigned long const timestamp = getTimestamp();
-  //check if a property is changed
-  if (timestamp != 0) {
-    Thing.updateTimestampOnChangedProperties(timestamp);
-  }
+  // Check if a primitive property wrapper is locally changed
+  Thing.updateTimestampOnLocallyChangedProperties();
 
   connectionCheck();
   if (iotStatus != ArduinoIoTConnectionStatus::CONNECTED) {

src/ArduinoIoTCloud.h

@@ -22,6 +22,11 @@
 #include <ArduinoIoTCloudBearSSL.h>
 #include <ArduinoCloudThing.h>
 #include "ConnectionManager.h"
+#include "types/CloudWrapperBool.h"
+#include "types/CloudWrapperFloat.h"
+#include "types/CloudWrapperInt.h"
+#include "types/CloudWrapperString.h"
+
 
 #include "CloudSerial.h"
 
@@ -113,10 +118,7 @@ class ArduinoIoTCloudClass {
 
     static unsigned long const DEFAULT_MIN_TIME_BETWEEN_UPDATES_MILLIS = 500; /* Data rate throttled to 2 Hz */
 
-
-
-    template<typename T, typename N = T>
-    void addPropertyReal(T & property, String name, permissionType permission_type = READWRITE, long seconds = ON_CHANGE, void(*fn)(void) = NULL, N minDelta = N(0), void(*synFn)(ArduinoCloudProperty<T> property) = CLOUD_WINS) {
+    void addPropertyReal(ArduinoCloudProperty& property, String name, permissionType permission_type = READWRITE, long seconds = ON_CHANGE, void(*fn)(void) = NULL, float minDelta = 0.0f, void(*synFn)(ArduinoCloudProperty& property) = CLOUD_WINS) {
       Permission permission = Permission::ReadWrite;
       if (permission_type == READ) {
         permission = Permission::Read;
@@ -127,15 +129,42 @@ class ArduinoIoTCloudClass {
       }
 
       if (seconds == ON_CHANGE) {
-        Thing.addPropertyReal(property, name, permission).publishOnChange((T)minDelta, DEFAULT_MIN_TIME_BETWEEN_UPDATES_MILLIS).onUpdate(fn).onSync(synFn);
+        Thing.addPropertyReal(property, name, permission).publishOnChange(minDelta, DEFAULT_MIN_TIME_BETWEEN_UPDATES_MILLIS).onUpdate(fn).onSync(synFn);
       } else {
         Thing.addPropertyReal(property, name, permission).publishEvery(seconds).onUpdate(fn).onSync(synFn);
       }
     }
-
-    template <typename T>
-    ArduinoCloudProperty<T> addPropertyReal(T & property, String const & name, Permission const permission) {
-      return Thing.addPropertyReal(property, name, permission);
+    void addPropertyReal(bool& property, String name, permissionType permission_type = READWRITE, long seconds = ON_CHANGE, void(*fn)(void) = NULL, float minDelta = 0.0f, void(*synFn)(ArduinoCloudProperty & property) = CLOUD_WINS) {
+      ArduinoCloudProperty *p = new CloudWrapperBool(property);
+      addPropertyReal(*p, name, permission_type, seconds, fn, minDelta, synFn);
+    }
+    ArduinoCloudProperty& addPropertyReal(bool& property, String name, Permission const permission) {
+      ArduinoCloudProperty *p = new CloudWrapperBool(property);
+      return Thing.addPropertyReal(*p, name, permission);
+    }
+    void addPropertyReal(float& property, String name, permissionType permission_type = READWRITE, long seconds = ON_CHANGE, void(*fn)(void) = NULL, float minDelta = 0.0f, void(*synFn)(ArduinoCloudProperty & property) = CLOUD_WINS) {
+      ArduinoCloudProperty *p = new CloudWrapperFloat(property);
+      addPropertyReal(*p, name, permission_type, seconds, fn, minDelta, synFn);
+    }
+    ArduinoCloudProperty& addPropertyReal(float& property, String name, Permission const permission) {
+      ArduinoCloudProperty *p = new CloudWrapperFloat(property);
+      return Thing.addPropertyReal(*p, name, permission);
+    }
+    void addPropertyReal(int& property, String name, permissionType permission_type = READWRITE, long seconds = ON_CHANGE, void(*fn)(void) = NULL, float minDelta = 0.0, void(*synFn)(ArduinoCloudProperty & property) = CLOUD_WINS) {
+      ArduinoCloudProperty *p = new CloudWrapperInt(property);
+      addPropertyReal(*p, name, permission_type, seconds, fn, minDelta, synFn);
+    }
+    ArduinoCloudProperty& addPropertyReal(int& property, String name, Permission const permission) {
+      ArduinoCloudProperty *p = new CloudWrapperInt(property);
+      return Thing.addPropertyReal(*p, name, permission);
+    }
+    void addPropertyReal(String& property, String name, permissionType permission_type = READWRITE, long seconds = ON_CHANGE, void(*fn)(void) = NULL, float minDelta = 0.0f, void(*synFn)(ArduinoCloudProperty & property) = CLOUD_WINS) {
+      ArduinoCloudProperty *p = new CloudWrapperString(property);
+      addPropertyReal(*p, name, permission_type, seconds, fn, minDelta, synFn);
+    }
+    ArduinoCloudProperty& addPropertyReal(String& property, String name, Permission const permission) {
+      ArduinoCloudProperty *p = new CloudWrapperString(property);
+      return Thing.addPropertyReal(*p, name, permission);
     }
 
     void connectionCheck();
@@ -146,7 +175,6 @@ class ArduinoIoTCloudClass {
       return _brokerPort;
     }
     void printDebugInfo();
-
     void addCallback(ArduinoIoTCloudEvent const event, OnCloudEventCallback callback);
 
   protected:
@@ -201,7 +229,6 @@ class ArduinoIoTCloudClass {
                          _on_disconnect_event_callback;
 
     static void execCloudEventCallback(OnCloudEventCallback & callback, void * callback_arg);
-
 };
 
 extern ArduinoIoTCloudClass ArduinoCloud;