CM-386 / Reduce payload size

.gitignore

@@ -1,4 +1,4 @@
-*.bin
-*.elf
+build
 *~
-
+.project
+.cproject

.travis.yml

@@ -0,0 +1,15 @@
+language: cpp
+sudo: enabled
+
+before_script:
+  - cd test && mkdir build && cd build
+
+script:
+  - cmake ..
+  - make
+  - ./testArduinoCloudThing
+
+after_script:
+  - cd ..
+  - rm -rf build
+

src/ArduinoCloudProperty.hpp

@@ -1,10 +1,27 @@
 #ifndef ARDUINO_CLOUD_PROPERTY_HPP_
 #define ARDUINO_CLOUD_PROPERTY_HPP_
 
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
 #include <Arduino.h>
 
 #include "lib/tinycbor/cbor-lib.h"
 
+/******************************************************************************
+ * TYPEDEF
+ ******************************************************************************/
+
+/******************************************************************************
+ * TYPEDEF
+ ******************************************************************************/
+
+enum class CloudProtocol {
+  V1, /* [{"n": "test", "vb": true}] */
+  V2  /* [{0: "test", 4: true}]      */
+};
+
 enum class Permission {
   Read, Write, ReadWrite
 };
@@ -17,8 +34,31 @@ enum class UpdatePolicy {
   OnChange, TimeInterval
 };
 
+/* Source: https://tools.ietf.org/html/rfc8428#section-6 */
+enum class CborIntegerMapKey : int
+{
+   BaseVersion  = -1, /* bver */
+   BaseName     = -2, /* bn   */
+   BaseTime     = -3, /* bt   */
+   BaseUnit     = -4, /* bu   */
+   BaseValue    = -5, /* bv   */
+   BaseSum      = -6, /* bs   */
+   Name         =  0, /* n    */
+   Unit         =  1, /* u    */
+   Value        =  2, /* v    */
+   StringValue  =  3, /* vs   */
+   BooleanValue =  4, /* vb   */
+   Sum          =  5, /* s    */
+   Time         =  6, /* t    */
+   UpdateTime   =  7, /* ut   */
+   DataValue    =  8  /* vd   */
+};
+
 typedef void(*UpdateCallbackFunc)(void);
 
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
 
 template <typename T>
 class ArduinoCloudProperty {
@@ -40,7 +80,7 @@ class ArduinoCloudProperty {
   bool shouldBeUpdated        () const;
   void execCallbackOnChange   ();
 
-  void append                 (CborEncoder * encoder);
+  void append                 (CborEncoder * encoder, CloudProtocol const cloud_protocol);
 
 private:
 
@@ -59,14 +99,24 @@ class ArduinoCloudProperty {
   unsigned long      _last_updated_millis,
                      _update_interval_millis;
 
-  void appendValue(CborEncoder * mapEncoder) const;
+  void appendValue(CborEncoder * mapEncoder, CloudProtocol const cloud_protocol) const;
   bool isValueDifferent(T const lhs, T const rhs) const;
 
+  T getInitialMinDeltaPropertyValue() const;
+
 };
 
+/******************************************************************************
+ * PROTOTYPE FREE FUNCTIONs
+ ******************************************************************************/
+
 template <typename T>
 inline bool operator == (ArduinoCloudProperty<T> const & lhs, ArduinoCloudProperty<T> const & rhs) { return (lhs.name() == rhs.name()); }
 
+/******************************************************************************
+ * TEMPLATE IMPLEMENTATION
+ ******************************************************************************/
+
 #include "ArduinoCloudProperty.ipp"
 
 #endif /* ARDUINO_CLOUD_PROPERTY_HPP_ */

src/ArduinoCloudProperty.ipp

@@ -1,3 +1,6 @@
+/******************************************************************************
+ * CTOR/DTOR
+ ******************************************************************************/
 
 template <typename T>
 ArduinoCloudProperty<T>::ArduinoCloudProperty(T & property, String const & name, Permission const permission)
@@ -8,13 +11,17 @@ ArduinoCloudProperty<T>::ArduinoCloudProperty(T & property, String const & name,
   _update_callback_func(NULL),
   _update_policy(UpdatePolicy::OnChange),
   _has_been_updated_once(false),
-  _min_delta_property(T(0)),
+  _min_delta_property(getInitialMinDeltaPropertyValue()),
   _min_time_between_updates_millis(0),
   _last_updated_millis(0),
   _update_interval_millis(0)
 {
 }
 
+/******************************************************************************
+ * PUBLIC MEMBER FUNCTIONS
+ ******************************************************************************/
+
 template <typename T>
 void ArduinoCloudProperty<T>::writeByCloud(T const val) {
   if(isWriteableByCloud()) {
@@ -69,14 +76,16 @@ void ArduinoCloudProperty<T>::execCallbackOnChange() {
 }
 
 template <typename T>
-void ArduinoCloudProperty<T>::append(CborEncoder * encoder) {
+void ArduinoCloudProperty<T>::append(CborEncoder * encoder, CloudProtocol const cloud_protocol) {
   if (isReadableByCloud()) {
     CborEncoder mapEncoder;
 
     cbor_encoder_create_map(encoder, &mapEncoder, CborIndefiniteLength);
-    cbor_encode_text_stringz(&mapEncoder, "n");
+
+    if     (cloud_protocol == CloudProtocol::V1) cbor_encode_text_stringz(&mapEncoder, "n");
+    else if(cloud_protocol == CloudProtocol::V2) cbor_encode_int         (&mapEncoder, static_cast<int>(CborIntegerMapKey::Name));    
     cbor_encode_text_stringz(&mapEncoder, _name.c_str());
-    appendValue(&mapEncoder);
+    appendValue(&mapEncoder, cloud_protocol);
     cbor_encoder_close_container(encoder, &mapEncoder);
 
     _shadow_property = _property;
@@ -85,27 +94,35 @@ void ArduinoCloudProperty<T>::append(CborEncoder * encoder) {
   }
 }
 
+/******************************************************************************
+ * PRIVATE MEMBER FUNCTIONS 
+ ******************************************************************************/
+
 template <>
-inline void ArduinoCloudProperty<bool>::appendValue(CborEncoder * mapEncoder) const {
-  cbor_encode_text_stringz(mapEncoder, "vb");
+inline void ArduinoCloudProperty<bool>::appendValue(CborEncoder * mapEncoder, CloudProtocol const cloud_protocol) const {
+  if     (cloud_protocol == CloudProtocol::V1) cbor_encode_text_stringz(mapEncoder, "vb");
+  else if(cloud_protocol == CloudProtocol::V2) cbor_encode_int         (mapEncoder, static_cast<int>(CborIntegerMapKey::BooleanValue));    
   cbor_encode_boolean(mapEncoder, _property);
 }
 
 template <>
-inline void ArduinoCloudProperty<int>::appendValue(CborEncoder * mapEncoder) const {
-  cbor_encode_text_stringz(mapEncoder, "v");
+inline void ArduinoCloudProperty<int>::appendValue(CborEncoder * mapEncoder, CloudProtocol const cloud_protocol) const {
+  if     (cloud_protocol == CloudProtocol::V1) cbor_encode_text_stringz(mapEncoder, "v");
+  else if(cloud_protocol == CloudProtocol::V2) cbor_encode_int         (mapEncoder, static_cast<int>(CborIntegerMapKey::Value));    
   cbor_encode_int(mapEncoder, _property);
 }
 
 template <>
-inline void ArduinoCloudProperty<float>::appendValue(CborEncoder * mapEncoder) const {
-  cbor_encode_text_stringz(mapEncoder, "v");
+inline void ArduinoCloudProperty<float>::appendValue(CborEncoder * mapEncoder, CloudProtocol const cloud_protocol) const {
+  if     (cloud_protocol == CloudProtocol::V1) cbor_encode_text_stringz(mapEncoder, "v");
+  else if(cloud_protocol == CloudProtocol::V2) cbor_encode_int         (mapEncoder, static_cast<int>(CborIntegerMapKey::Value));    
   cbor_encode_float(mapEncoder, _property);
 }
 
 template <>
-inline void ArduinoCloudProperty<String>::appendValue(CborEncoder * mapEncoder) const {
-  cbor_encode_text_stringz(mapEncoder, "vs");
+inline void ArduinoCloudProperty<String>::appendValue(CborEncoder * mapEncoder, CloudProtocol const cloud_protocol) const {
+  if     (cloud_protocol == CloudProtocol::V1) cbor_encode_text_stringz(mapEncoder, "vs");
+  else if(cloud_protocol == CloudProtocol::V2) cbor_encode_int         (mapEncoder, static_cast<int>(CborIntegerMapKey::StringValue));
   cbor_encode_text_stringz(mapEncoder, _property.c_str());
 }
 
@@ -128,3 +145,23 @@ template <>
 inline bool ArduinoCloudProperty<String>::isValueDifferent(String const lhs, String const rhs) const {
   return (lhs != rhs);
 }
+
+template <>
+inline bool ArduinoCloudProperty<bool>::getInitialMinDeltaPropertyValue() const {
+  return false;
+}
+
+template <>
+inline int ArduinoCloudProperty<int>::getInitialMinDeltaPropertyValue() const {
+  return 0;
+}
+
+template <>
+inline float ArduinoCloudProperty<float>::getInitialMinDeltaPropertyValue() const {
+  return 0.0f;
+}
+
+template <>
+inline String ArduinoCloudProperty<String>::getInitialMinDeltaPropertyValue() const {
+  return String("");
+}

src/ArduinoCloudPropertyContainer.cpp

@@ -1,5 +1,13 @@
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
 #include "ArduinoCloudPropertyContainer.hpp"
 
+/******************************************************************************
+ * PUBLIC MEMBER FUNCTIONS
+ ******************************************************************************/
+
 bool ArduinoCloudPropertyContainer::isPropertyInContainer(Type const type, String const & name) {
   if      (type == Type::Bool  ) return isPropertyInList(_bool_property_list,   name);
   else if (type == Type::Int   ) return isPropertyInList(_int_property_list,    name);
@@ -19,9 +27,9 @@ int ArduinoCloudPropertyContainer::getNumOfChangedProperties() {
   return num_changes_properties;
 }
 
-void ArduinoCloudPropertyContainer::appendChangedProperties(CborEncoder * arrayEncoder) {
-  appendChangedProperties<bool>  (_bool_property_list,   arrayEncoder);
-  appendChangedProperties<int>   (_int_property_list,    arrayEncoder);
-  appendChangedProperties<float> (_float_property_list,  arrayEncoder);
-  appendChangedProperties<String>(_string_property_list, arrayEncoder);
+void ArduinoCloudPropertyContainer::appendChangedProperties(CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol) {
+  appendChangedProperties<bool>  (_bool_property_list,   arrayEncoder, cloud_protocol);
+  appendChangedProperties<int>   (_int_property_list,    arrayEncoder, cloud_protocol);
+  appendChangedProperties<float> (_float_property_list,  arrayEncoder, cloud_protocol);
+  appendChangedProperties<String>(_string_property_list, arrayEncoder, cloud_protocol);
 }

src/ArduinoCloudPropertyContainer.hpp

@@ -1,17 +1,25 @@
 #ifndef ARDUINO_CLOUD_PROPERTY_CONTAINER_NEW_H_
 #define ARDUINO_CLOUD_PROPERTY_CONTAINER_NEW_H_
 
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
 #include "ArduinoCloudProperty.hpp"
 
 #include "lib/tinycbor/cbor-lib.h"
 #include "lib/LinkedList/LinkedList.h"
 
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
+
 class ArduinoCloudPropertyContainer {
 public:
 
   bool isPropertyInContainer    (Type const type, String const & name);
   int  getNumOfChangedProperties();
-  void appendChangedProperties  (CborEncoder * arrayEncoder);
+  void appendChangedProperties  (CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol);
 
   inline ArduinoCloudProperty<bool>   * getPropertyBool  (String const & name) { return getProperty(_bool_property_list,   name); }
   inline ArduinoCloudProperty<int>    * getPropertyInt   (String const & name) { return getProperty(_int_property_list,    name); }
@@ -40,10 +48,14 @@ class ArduinoCloudPropertyContainer {
   int getNumOfChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list);
 
   template <typename T>
-  void appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder);
+  void appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol);
 
 };
 
+/******************************************************************************
+ * TEMPLATE IMPLEMENTATION
+ ******************************************************************************/
+
 #include "ArduinoCloudPropertyContainer.ipp"
 
 #endif /* ARDUINO_CLOUD_PROPERTY_CONTAINER_NEW_H_ */

src/ArduinoCloudPropertyContainer.ipp

@@ -1,3 +1,6 @@
+/******************************************************************************
+ * PRIVATE MEMBER FUNCTIONS
+ ******************************************************************************/
 
 template <typename T>
 bool ArduinoCloudPropertyContainer::isPropertyInList(LinkedList<ArduinoCloudProperty<T> *> & list, String const & name) {
@@ -32,11 +35,11 @@ int ArduinoCloudPropertyContainer::getNumOfChangedProperties(LinkedList<ArduinoC
 }
 
 template <typename T>
-void ArduinoCloudPropertyContainer::appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder) {
+void ArduinoCloudPropertyContainer::appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol) {
   for (int i = 0; i < list.size(); i++) {
     ArduinoCloudProperty<T> * p = list.get(i);
     if (p->shouldBeUpdated() && p->isReadableByCloud()) {
-      p->append(arrayEncoder);
+      p->append(arrayEncoder, cloud_protocol);
     }
   }
 }