Removing enum class CloudProtocol since the 'decode' function decodes both V1/V2 and encoding will only happen in V2 anymore. Decoding for V2 shall be removed at a later point in time (#19)

aentinger · web-flow · commit cbe49da79ef1 · 2019-02-12T10:30:34.000+01:00
diff --git a/ArduinoCloudProperty.hpp b/ArduinoCloudProperty.hpp
@@ -34,11 +34,6 @@
  * TYPEDEF
  ******************************************************************************/
 
-enum class CloudProtocol {
-  V1, /* [{"n": "test", "vb": true}] */
-  V2  /* [{0: "test", 4: true}]      */
-};
-
 enum class Permission {
   Read, Write, ReadWrite
 };
@@ -97,7 +92,7 @@ class ArduinoCloudProperty {
   bool shouldBeUpdated        ();
   void execCallbackOnChange   ();
 
-  void append                 (CborEncoder * encoder, CloudProtocol const cloud_protocol);
+  void append                 (CborEncoder * encoder);
 
 private:
 
@@ -117,7 +112,7 @@ class ArduinoCloudProperty {
   unsigned long      _last_updated_millis,
                      _update_interval_millis;
 
-  void appendValue(CborEncoder * mapEncoder, CloudProtocol const cloud_protocol) const;
+  void appendValue(CborEncoder * mapEncoder) const;
   bool isValueDifferent(T const lhs, T const rhs) const;
 
   T getInitialMinDeltaPropertyValue() const;
diff --git a/ArduinoCloudProperty.ipp b/ArduinoCloudProperty.ipp
@@ -103,16 +103,14 @@ void ArduinoCloudProperty<T>::execCallbackOnChange() {
 }
 
 template <typename T>
-void ArduinoCloudProperty<T>::append(CborEncoder * encoder, CloudProtocol const cloud_protocol) {
+void ArduinoCloudProperty<T>::append(CborEncoder * encoder) {
   if (isReadableByCloud()) {
     CborEncoder mapEncoder;
 
-    cbor_encoder_create_map(encoder, &mapEncoder, CborIndefiniteLength);
-    
-    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, cloud_protocol);
+    cbor_encoder_create_map     (encoder, &mapEncoder, CborIndefiniteLength);
+    cbor_encode_int             (&mapEncoder, static_cast<int>(CborIntegerMapKey::Name));    
+    cbor_encode_text_stringz    (&mapEncoder, _name.c_str());
+    appendValue                 (&mapEncoder);
     cbor_encoder_close_container(encoder, &mapEncoder);
 
     _shadow_property = _property;
@@ -126,30 +124,26 @@ void ArduinoCloudProperty<T>::append(CborEncoder * encoder, CloudProtocol const
  ******************************************************************************/
 
 template <>
-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));    
+inline void ArduinoCloudProperty<bool>::appendValue(CborEncoder * mapEncoder) const {
+  cbor_encode_int    (mapEncoder, static_cast<int>(CborIntegerMapKey::BooleanValue));    
   cbor_encode_boolean(mapEncoder, _property);
 }
 
 template <>
-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));    
+inline void ArduinoCloudProperty<int>::appendValue(CborEncoder * mapEncoder) const {
+  cbor_encode_int(mapEncoder, static_cast<int>(CborIntegerMapKey::Value));    
   cbor_encode_int(mapEncoder, _property);
 }
 
 template <>
-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));    
+inline void ArduinoCloudProperty<float>::appendValue(CborEncoder * mapEncoder) const {
+  cbor_encode_int  (mapEncoder, static_cast<int>(CborIntegerMapKey::Value));    
   cbor_encode_float(mapEncoder, _property);
 }
 
 template <>
-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));
+inline void ArduinoCloudProperty<String>::appendValue(CborEncoder * mapEncoder) const {
+  cbor_encode_int         (mapEncoder, static_cast<int>(CborIntegerMapKey::StringValue));
   cbor_encode_text_stringz(mapEncoder, _property.c_str());
 }
 
diff --git a/ArduinoCloudPropertyContainer.cpp b/ArduinoCloudPropertyContainer.cpp
@@ -44,9 +44,9 @@ int ArduinoCloudPropertyContainer::getNumOfChangedProperties() {
   return num_changes_properties;
 }
 
-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);
+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);
 }
diff --git a/ArduinoCloudPropertyContainer.hpp b/ArduinoCloudPropertyContainer.hpp
@@ -36,7 +36,7 @@ class ArduinoCloudPropertyContainer {
 
   bool isPropertyInContainer    (Type const type, String const & name);
   int  getNumOfChangedProperties();
-  void appendChangedProperties  (CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol);
+  void appendChangedProperties  (CborEncoder * arrayEncoder);
 
   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); }
@@ -65,7 +65,7 @@ class ArduinoCloudPropertyContainer {
   int getNumOfChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list);
 
   template <typename T>
-  void appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol);
+  void appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder);
 
 };
 
diff --git a/ArduinoCloudPropertyContainer.ipp b/ArduinoCloudPropertyContainer.ipp
@@ -52,11 +52,11 @@ int ArduinoCloudPropertyContainer::getNumOfChangedProperties(LinkedList<ArduinoC
 }
 
 template <typename T>
-void ArduinoCloudPropertyContainer::appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol) {
+void ArduinoCloudPropertyContainer::appendChangedProperties(LinkedList<ArduinoCloudProperty<T> *> & list, CborEncoder * arrayEncoder) {
   for (int i = 0; i < list.size(); i++) {
     ArduinoCloudProperty<T> * p = list.get(i);
     if (p->shouldBeUpdated() && p->isReadableByCloud()) {
-      p->append(arrayEncoder, cloud_protocol);
+      p->append(arrayEncoder);
     }
   }
 }
diff --git a/ArduinoCloudThing.cpp b/ArduinoCloudThing.cpp
@@ -56,8 +56,7 @@ static void utox8(uint32_t val, char* s) {
  * CTOR/DTOR
  ******************************************************************************/
 
-ArduinoCloudThing::ArduinoCloudThing(CloudProtocol const cloud_protocol)
-: _cloud_protocol(cloud_protocol) {
+ArduinoCloudThing::ArduinoCloudThing() {
 #ifdef ARDUINO_ARCH_SAMD
     #define SERIAL_NUMBER_WORD_0    *(volatile uint32_t*)(0x0080A00C)
     #define SERIAL_NUMBER_WORD_1    *(volatile uint32_t*)(0x0080A040)
@@ -100,7 +99,7 @@ int ArduinoCloudThing::encode(uint8_t * data, size_t const size) {
           return -1;
       }
 
-      _property_cont.appendChangedProperties(&arrayEncoder, _cloud_protocol);
+      _property_cont.appendChangedProperties(&arrayEncoder);
 
       err = cbor_encoder_close_container(&encoder, &arrayEncoder);
 
@@ -224,10 +223,12 @@ ArduinoCloudThing::MapParserState ArduinoCloudThing::handle_MapKey(CborValue * v
 
   if(cbor_value_at_end(value_iter)) {
     next_state = MapParserState::LeaveMap;
-    // If the key is a string means that the Map use the string keys (protocol V1)
-    // https://tools.ietf.org/html/rfc8428#section-4.3
-    // example [{"n": "temperature", "v": 25}]
-  } else if(cbor_value_is_text_string(value_iter)) {
+  }
+  /* If the key is a string means that the Map use the string keys (protocol V1)
+   * https://tools.ietf.org/html/rfc8428#section-4.3
+   * Example [{"n": "temperature", "v": 25}]
+   */
+  else if(cbor_value_is_text_string(value_iter)) {
         char * val      = 0;
         size_t val_size = 0;
         if(cbor_value_dup_text_string(value_iter, &val, &val_size, value_iter) == CborNoError) {
@@ -242,9 +243,11 @@ ArduinoCloudThing::MapParserState ArduinoCloudThing::handle_MapKey(CborValue * v
           else                              next_state = MapParserState::UndefinedKey;
           free(val);
         }
-        // If the key is a number means that the Map use the CBOR Label (protocol V2)
-        // example [{0: "temperature", 2: 25}]
-  } else if (cbor_value_is_integer(value_iter)) {
+  }
+  /* If the key is a number means that the Map use the CBOR Label (protocol V2)
+   * Example [{0: "temperature", 2: 25}]
+   */
+  else if (cbor_value_is_integer(value_iter)) {
         int val = 0;
         if(cbor_value_get_int(value_iter, &val) == CborNoError) {
           if(cbor_value_advance(value_iter) == CborNoError) {
diff --git a/ArduinoCloudThing.h b/ArduinoCloudThing.h
@@ -47,7 +47,7 @@ static long const DAYS      = 86400;
 class ArduinoCloudThing {
 
 public:
-  ArduinoCloudThing(CloudProtocol const cloud_protocol = CloudProtocol::V2);
+  ArduinoCloudThing();
 
   void begin();
 
@@ -64,7 +64,6 @@ class ArduinoCloudThing {
 
 private:
 
-  CloudProtocol           const _cloud_protocol;
   bool                          _status = OFF;
   char                          _uuid[33];
   ArduinoCloudPropertyContainer _property_cont;
@@ -96,7 +95,7 @@ class ArduinoCloudThing {
     inline T const get  () const { return _entry; }
 
     inline bool    isSet() const { return _is_set; }
-    inline bool    reset()       { _is_set = false; }
+    inline void    reset()       { _is_set = false; }
 
   private:
 

Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,9 @@ int ArduinoCloudPropertyContainer::getNumOfChangedProperties() {`
`44`	`44`	`return num_changes_properties;`
`45`	`45`	`}`
`46`	`46`
`47`		`-void ArduinoCloudPropertyContainer::appendChangedProperties(CborEncoder * arrayEncoder, CloudProtocol const cloud_protocol) {`
`48`		`- appendChangedProperties<bool> (_bool_property_list, arrayEncoder, cloud_protocol);`
`49`		`- appendChangedProperties<int> (_int_property_list, arrayEncoder, cloud_protocol);`
`50`		`- appendChangedProperties<float> (_float_property_list, arrayEncoder, cloud_protocol);`
`51`		`- appendChangedProperties<String>(_string_property_list, arrayEncoder, cloud_protocol);`
	`47`	`+void ArduinoCloudPropertyContainer::appendChangedProperties(CborEncoder * arrayEncoder) {`
	`48`	`+ appendChangedProperties<bool> (_bool_property_list, arrayEncoder);`
	`49`	`+ appendChangedProperties<int> (_int_property_list, arrayEncoder);`
	`50`	`+ appendChangedProperties<float> (_float_property_list, arrayEncoder);`
	`51`	`+ appendChangedProperties<String>(_string_property_list, arrayEncoder);`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,11 +52,11 @@ int ArduinoCloudPropertyContainer::getNumOfChangedProperties(LinkedList<ArduinoC`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`template <typename T>`
`55`		`-void ArduinoCloudPropertyContainer::appendChangedProperties(LinkedList<ArduinoCloudProperty<T> > & list, CborEncoder arrayEncoder, CloudProtocol const cloud_protocol) {`
	`55`	`+void ArduinoCloudPropertyContainer::appendChangedProperties(LinkedList<ArduinoCloudProperty<T> > & list, CborEncoder arrayEncoder) {`
`56`	`56`	`for (int i = 0; i < list.size(); i++) {`
`57`	`57`	`ArduinoCloudProperty<T> * p = list.get(i);`
`58`	`58`	`if (p->shouldBeUpdated() && p->isReadableByCloud()) {`
`59`		`- p->append(arrayEncoder, cloud_protocol);`
	`59`	`+ p->append(arrayEncoder);`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`}`