Extracting CBOR encode functionality into static class CBOREncoder

Author: aentinger

src/ArduinoIoTCloudLPWAN.cpp

@@ -25,6 +25,8 @@
 
 #include<ArduinoIoTCloudLPWAN.h>
 
+#include "cbor/CBOREncoder.h"
+
 /******************************************************************************
    CONSTANTS
  ******************************************************************************/
@@ -126,7 +128,7 @@ void ArduinoIoTCloudLPWAN::disconnect()
 void ArduinoIoTCloudLPWAN::sendPropertiesToCloud()
 {
   uint8_t data[CBOR_LORA_MSG_MAX_SIZE];
-  int const length = _thing.encode(data, sizeof(data), true);
+  int const length = CBOREncoder::encode(_property_container, data, sizeof(data), true);
   if (length > 0) {
     writeProperties(data, length);
   }

src/ArduinoIoTCloudTCP.cpp

@@ -29,6 +29,8 @@
   #include "tls/utility/CryptoUtil.h"
 #endif
 
+#include "cbor/CBOREncoder.h"
+
 /******************************************************************************
    GLOBAL VARIABLES
  ******************************************************************************/
@@ -284,7 +286,7 @@ void ArduinoIoTCloudTCP::handleMessage(int length)
 void ArduinoIoTCloudTCP::sendPropertiesToCloud()
 {
   uint8_t data[MQTT_TRANSMIT_BUFFER_SIZE];
-  int const length = _thing.encode(data, sizeof(data));
+  int const length = CBOREncoder::encode(_property_container, data, sizeof(data));
   if (length > 0)
   {
     /* If properties have been encoded store them in the back-up buffer

src/cbor/ArduinoCloudThing.cpp

@@ -48,30 +48,6 @@ void ArduinoCloudThing::begin(PropertyContainer * property_container)
   _property_container = property_container;
 }
 
-int ArduinoCloudThing::encode(uint8_t * data, size_t const size, bool lightPayload) {
-
-  // check if backing storage and cloud has diverged
-  // time interval may be elapsed or property may be changed
-  CborEncoder encoder, arrayEncoder;
-
-  cbor_encoder_init(&encoder, data, size, 0);
-
-  if (cbor_encoder_create_array(&encoder, &arrayEncoder, CborIndefiniteLength) != CborNoError) {
-    return -1;
-  }
-
-  if (appendChangedProperties(*_property_container, &arrayEncoder, lightPayload) < 1) {
-    return -1;
-  }
-
-  if (cbor_encoder_close_container(&encoder, &arrayEncoder) != CborNoError) {
-    return -1;
-  }
-
-  int const bytes_encoded = cbor_encoder_get_buffer_size(&encoder, data);
-  return bytes_encoded;
-}
-
 void ArduinoCloudThing::decode(uint8_t const * const payload, size_t const length, bool isSyncMessage) {
   _isSyncMessage = isSyncMessage;
 

src/cbor/ArduinoCloudThing.h

@@ -81,9 +81,6 @@ class ArduinoCloudThing {
 
     void begin(PropertyContainer * property_container);
 
-    /* encode return > 0 if a property has changed and encodes the changed properties in CBOR format into the provided buffer */
-    /* if lightPayload is true the integer identifier of the property will be encoded in the message instead of the property name in order to reduce the size of the message payload*/
-    int encode(uint8_t * data, size_t const size, bool lightPayload = false);
     /* decode a CBOR payload received from the cloud */
     void decode(uint8_t const * const payload, size_t const length, bool isSyncMessage = false);
 

src/cbor/CBOREncoder.cpp

@@ -0,0 +1,51 @@
+/*
+   This file is part of ArduinoIoTCloud.
+
+   Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to [email protected].
+*/
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include "CBOREncoder.h"
+
+#include "lib/tinycbor/cbor-lib.h"
+
+/******************************************************************************
+ * PUBLIC MEMBER FUNCTIONS
+ ******************************************************************************/
+
+int CBOREncoder::encode(PropertyContainer & property_container, uint8_t * data, size_t const size, bool lightPayload)
+{
+  CborEncoder encoder, arrayEncoder;
+
+  cbor_encoder_init(&encoder, data, size, 0);
+
+  if (cbor_encoder_create_array(&encoder, &arrayEncoder, CborIndefiniteLength) != CborNoError)
+    return -1;
+
+  /* Check if backing storage and cloud has diverged
+   * time interval may be elapsed or property may be changed
+   * and if that's the case encode the property into the CBOR.
+   */
+  if (appendChangedProperties(property_container, &arrayEncoder, lightPayload) < 1)
+    return -1;
+
+  if (cbor_encoder_close_container(&encoder, &arrayEncoder) != CborNoError)
+    return -1;
+
+  int const bytes_encoded = cbor_encoder_get_buffer_size(&encoder, data);
+  return bytes_encoded;
+}

src/cbor/CBOREncoder.h

@@ -0,0 +1,47 @@
+/*
+   This file is part of ArduinoIoTCloud.
+
+   Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to [email protected].
+*/
+
+#ifndef ARDUINO_CBOR_CBOR_ENCODER_H_
+#define ARDUINO_CBOR_CBOR_ENCODER_H_
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include "../property/PropertyContainer.h"
+
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
+
+class CBOREncoder
+{
+
+public:
+
+    /* encode return > 0 if a property has changed and encodes the changed properties in CBOR format into the provided buffer */
+    /* if lightPayload is true the integer identifier of the property will be encoded in the message instead of the property name in order to reduce the size of the message payload*/
+    static int encode(PropertyContainer & property_container, uint8_t * data, size_t const size, bool lightPayload = false);
+
+private:
+
+  CBOREncoder() { }
+  CBOREncoder(CborEncoder const &) { }
+
+};
+
+#endif /* ARDUINO_CBOR_CBOR_ENCODER_H_ */