Implement feature for optional encoding of timestamps in CBOR map

Author: aentinger

src/ArduinoIoTCloud.cpp

@@ -30,6 +30,18 @@ void ArduinoIoTCloudClass::push()
   requestUpdateForAllProperties(_property_container);
 }
 
+bool ArduinoIoTCloudClass::setTimestamp(String const & prop_name, unsigned long const timestamp)
+{
+  Property * p = getProperty(_property_container, prop_name);
+
+  if (p == nullptr)
+    return false;
+
+  p->setTimestamp(timestamp);
+
+  return true;
+}
+
 void ArduinoIoTCloudClass::addCallback(ArduinoIoTCloudEvent const event, OnCloudEventCallback callback)
 {
   _cloud_event_callback[static_cast<size_t>(event)] = callback;

src/ArduinoIoTCloud.h

@@ -88,6 +88,7 @@ class ArduinoIoTCloudClass
     virtual void printDebugInfo() = 0;
 
             void push();
+            bool setTimestamp(String const & prop_name, unsigned long const timestamp);
 
     inline void     setThingId (String const thing_id)  { _thing_id = thing_id; };
     inline String & getThingId ()                       { return _thing_id; };

src/property/Property.cpp

@@ -45,7 +45,11 @@ Property::Property()
       _identifier(0),
       _attributeIdentifier(0),
       _lightPayload(false),
-      _update_requested(false) {
+      _update_requested(false),
+      _encode_timestamp(false),
+      _timestamp(0)
+{
+
 }
 
 /******************************************************************************
@@ -85,6 +89,17 @@ Property & Property::publishOnDemand() {
   return (*this);
 }
 
+Property & Property::encodeTimestamp()
+{
+  _encode_timestamp = true;
+  return (*this);
+}
+
+void Property::setTimestamp(unsigned long const timestamp)
+{
+  _timestamp = timestamp;
+}
+
 bool Property::shouldBeUpdated() {
   if (!_has_been_updated_once) {
     return true;
@@ -170,7 +185,8 @@ void Property::appendAttributeName(String attributeName, std::function<void (Cbo
     _attributeIdentifier++;
   }
   CborEncoder mapEncoder;
-  cbor_encoder_create_map(encoder, &mapEncoder, 2);
+  unsigned int num_map_properties = _encode_timestamp ? 3 : 2;
+  cbor_encoder_create_map(encoder, &mapEncoder, num_map_properties);
   cbor_encode_int(&mapEncoder, static_cast<int>(CborIntegerMapKey::Name));
 
   // if _lightPayload is true, the property and attribute identifiers will be encoded instead of the property name
@@ -187,7 +203,15 @@ void Property::appendAttributeName(String attributeName, std::function<void (Cbo
     }
     cbor_encode_text_stringz(&mapEncoder, completeName.c_str());
   }
+  /* Encode the value */
   appendValue(mapEncoder);
+  /* Encode the timestamp if that has been required. */
+  if(_encode_timestamp)
+  {
+    cbor_encode_int (&mapEncoder, static_cast<int>(CborIntegerMapKey::Time));
+    cbor_encode_uint(&mapEncoder, _timestamp);
+  }
+  /* Close the container */
   cbor_encoder_close_container(encoder, &mapEncoder);
 }
 

src/property/Property.h

@@ -139,6 +139,7 @@ class Property {
     Property & publishOnChange(float const min_delta_property, unsigned long const min_time_between_updates_millis = 0);
     Property & publishEvery(unsigned long const seconds);
     Property & publishOnDemand();
+    Property & encodeTimestamp();
 
     inline String name() const {
       return _name;
@@ -153,6 +154,7 @@ class Property {
       return (_permission == Permission::Write) || (_permission == Permission::ReadWrite);
     }
 
+    void setTimestamp(unsigned long const timestamp);
     bool shouldBeUpdated();
     void requestUpdate();
     void execCallbackOnChange();
@@ -215,6 +217,9 @@ class Property {
     bool               _lightPayload;
     /* Indicates whether a property update has been requested in case of the OnDemand update policy. */
     bool               _update_requested;
+    /* Indicates whether the timestamp shall be encoded in the property or not */
+    bool               _encode_timestamp;
+    unsigned long      _timestamp;
 };
 
 /******************************************************************************