Add Property write policy to manually handle local values update

Author: pennam

src/property/Property.cpp

@@ -29,6 +29,7 @@ Property::Property()
 , _min_delta_property{0.0f}
 , _min_time_between_updates_millis{DEFAULT_MIN_TIME_BETWEEN_UPDATES_MILLIS}
 , _permission{Permission::Read}
+, _write_policy{WritePolicy::Auto}
 , _get_time_func{nullptr}
 , _update_callback_func{nullptr}
 , _on_sync_callback_func{nullptr}
@@ -102,6 +103,18 @@ Property & Property::encodeTimestamp()
   return (*this);
 }
 
+Property & Property::writeOnChange()
+{
+  _write_policy = WritePolicy::Auto;
+  return (*this);
+}
+
+Property & Property::writeOnDemand()
+{
+  _write_policy = WritePolicy::Manual;
+  return (*this);
+}
+
 void Property::setTimestamp(unsigned long const timestamp)
 {
   _timestamp = timestamp;

src/property/Property.h

@@ -125,6 +125,10 @@ enum class UpdatePolicy {
   OnChange, TimeInterval, OnDemand
 };
 
+enum class WritePolicy {
+  Auto, Manual
+};
+
 typedef void(*UpdateCallbackFunc)(void);
 typedef unsigned long(*GetTimeCallbackFunc)();
 class Property;
@@ -147,6 +151,8 @@ class Property
     Property & publishEvery(unsigned long const seconds);
     Property & publishOnDemand();
     Property & encodeTimestamp();
+    Property & writeOnChange();
+    Property & writeOnDemand();
 
     inline String name() const {
       return _name;
@@ -160,6 +166,9 @@ class Property
     inline bool   isWriteableByCloud() const {
       return (_permission == Permission::Write) || (_permission == Permission::ReadWrite);
     }
+    inline bool   isWritableOnChange() const {
+      return _write_policy == WritePolicy::Auto;
+    }
 
     void setTimestamp(unsigned long const timestamp);
     bool shouldBeUpdated();
@@ -209,6 +218,7 @@ class Property
 
   private:
     Permission         _permission;
+    WritePolicy        _write_policy;
     GetTimeCallbackFunc _get_time_func;
     UpdateCallbackFunc _update_callback_func;
     OnSyncCallbackFunc _on_sync_callback_func;
@@ -219,7 +229,7 @@ class Property
                        _has_been_appended_but_not_sended;
     /* Variables used for UpdatePolicy::TimeInterval */
     unsigned long      _last_updated_millis,
-             _update_interval_millis;
+                       _update_interval_millis;
     /* Variables used for reconnection sync*/
     unsigned long      _last_local_change_timestamp;
     unsigned long      _last_cloud_change_timestamp;

src/property/PropertyContainer.cpp

@@ -121,7 +121,9 @@ void updateProperty(PropertyContainer & prop_cont, String propertyName, unsigned
     if (is_sync_message) {
       property->execCallbackOnSync();
     } else {
-      property->fromCloudToLocal();
+      if (property->isWritableOnChange()) {
+        property->fromCloudToLocal();
+      }
       property->execCallbackOnChange();
       property->provideEcho();
     }