Merge pull request #131 from imbeacon/master

Telemetry class updates & RPC_Response backward compatibility

Author: imbeacon

examples/0002-arduino_rpc/0002-arduino_rpc.ino

@@ -178,7 +178,7 @@ RPC_Response processTemperatureChange(const RPC_Data &data) {
   // Just an response example
   StaticJsonDocument<JSON_OBJECT_SIZE(1)> doc;
   doc[RPC_RESPONSE_KEY] = 42;
-  return doc;
+  return RPC_Response(doc);
 }
 
 /// @brief Processes function for RPC call "example_set_switch"
@@ -202,7 +202,7 @@ RPC_Response processSwitchChange(const RPC_Data &data) {
   // Just an response example
   StaticJsonDocument<JSON_OBJECT_SIZE(1)> doc;
   doc[RPC_RESPONSE_KEY] = 22.02;
-  return doc;
+  return RPC_Response(doc);
 }
 
 const uint8_t callback_size = 2U;

examples/0010-esp8266_esp32_rpc/0010-esp8266_esp32_rpc.ino

@@ -244,7 +244,7 @@ RPC_Response processTemperatureChange(const RPC_Data &data) {
   // Just an response example
   StaticJsonDocument<JSON_OBJECT_SIZE(1)> doc;
   doc[RPC_RESPONSE_KEY] = 42;
-  return doc;
+  return RPC_Response(doc);
 }
 
 /// @brief Processes function for RPC call "example_set_switch"
@@ -272,7 +272,7 @@ RPC_Response processSwitchChange(const RPC_Data &data) {
   // Just an response example
   StaticJsonDocument<JSON_OBJECT_SIZE(1)> doc;
   doc[RPC_RESPONSE_KEY] = 22.02;
-  return doc;
+  return RPC_Response(doc);
 }
 
 const std::array<RPC_Callback, 2U> callbacks = {

library.json

@@ -7,7 +7,7 @@
         "url": "https://github.com/thingsboard/thingsboard-arduino-sdk"
     },
     "dependencies": {
-        "bblanchon/ArduinoJson": "^6.20.1",
+        "bblanchon/ArduinoJson": "^6.21.1",
         "thingsboard/TBPubSubClient": "https://github.com/thingsboard/pubsubclient.git#v2.9.1",
         "arduino-libraries/ArduinoHttpClient" : "^0.4.0"
     },

src/Attribute_Request_Callback.h

@@ -7,9 +7,11 @@
 #ifndef Attribute_Request_Callback_h
 #define Attribute_Request_Callback_h
 
+// Local includes.
+#include "Configuration.h"
+
 // Library includes.
 #include <ArduinoJson.h>
-#include "Configuration.h"
 #if THINGSBOARD_ENABLE_STL
 #include <functional>
 #include <vector>

src/RPC_Callback.h

@@ -9,9 +9,9 @@
 
 // Local includes.
 #include "Configuration.h"
+#include "RPC_Response.h"
 
 // Library includes.
-#include <Telemetry.h>
 #if THINGSBOARD_ENABLE_STL
 #include <functional>
 #endif // THINGSBOARD_ENABLE_STL
@@ -25,8 +25,6 @@ constexpr char RPC_CB_NULL[] PROGMEM = "Server-side RPC callback is NULL";
 constexpr char RPC_CB_NULL[] = "Server-side RPC callback is NULL";
 #endif // THINGSBOARD_ENABLE_PROGMEM
 
-// Convenient aliases
-using RPC_Response = JsonVariant;
 // JSON variant const (read only twice as small as JSON variant), is used to communicate RPC parameters to the client
 using RPC_Data = const JsonVariantConst;
 

src/RPC_Response.h

@@ -0,0 +1,38 @@
+/*
+  RPC_Response.h - Library API for sending data to the ThingsBoard
+  Based on PubSub MQTT library.
+  Created by Olender M. Oct 2018.
+  Released into the public domain.
+*/
+#ifndef RPC_RESPONSE_H
+#define RPC_RESPONSE_H
+
+#include <Telemetry.h>
+
+class RPC_Response : public JsonVariant {
+public:
+
+    RPC_Response()
+      : JsonVariant() {
+    }
+
+    RPC_Response(JsonVariant variant)
+      : JsonVariant(variant) {
+    }
+
+    RPC_Response(Telemetry telemetry) {
+        StaticJsonDocument<JSON_OBJECT_SIZE(1)> jsonBuffer;
+        const JsonVariant object = jsonBuffer.to<JsonVariant>();
+        if (!telemetry.SerializeKeyValue(object)) {
+            return;
+        }
+        this->set(object);
+    }
+
+    template <typename T>
+    RPC_Response(const char *key, T value)
+      : RPC_Response(Telemetry(key, value)) {
+    }
+};
+
+#endif //RPC_RESPONSE_H

src/Telemetry.h

@@ -7,8 +7,14 @@
 #ifndef Telemetry_h
 #define Telemetry_h
 
+// Local includes.
+#include "Configuration.h"
+
 // Library includes.
 #include <ArduinoJson.h>
+#if THINGSBOARD_ENABLE_STL
+#include <type_traits>
+#endif // THINGSBOARD_ENABLE_STL
 
 /// @brief Telemetry record class, allows to store different data using a common interface.
 class Telemetry {
@@ -17,24 +23,23 @@ class Telemetry {
     inline Telemetry()
       : m_type(DataType::TYPE_NONE), m_key(NULL), m_value() { }
 
+    /// @brief Constructs telemetry record from integer value
     /// @brief Constructs telemetry record from integer value
     /// @tparam T Type of the passed value, is required to be integral,
     /// to ensure this constructor isn't used instead of the float one by mistake
     /// @param key Key of the key value pair we want to create
     /// @param val Value of the key value pair we want to create
     template <typename T,
-              typename = ARDUINOJSON_NAMESPACE::enable_if<ARDUINOJSON_NAMESPACE::is_integral<T>::value>>
+#if THINGSBOARD_ENABLE_STL
+              // Standard library is_integral, includes bool, char, signed char, unsigned char, short, unsigned short, int, unsigned int, long, unsigned long, long long, and unsigned long longy
+              typename std::enable_if<std::is_integral<T>::value>::type* = nullptr>
+#else
+              // Workaround for ArduinoJson version after 6.21.0, to still be able to access internal enable_if and is_integral declarations, previously accessible with ARDUINOJSON_NAMESPACE
+              typename ArduinoJson::ARDUINOJSON_VERSION_NAMESPACE::detail::enable_if<ArduinoJson::ARDUINOJSON_VERSION_NAMESPACE::detail::is_integral<T>::value>::type* = nullptr>
+#endif // THINGSBOARD_ENABLE_STL
     inline Telemetry(const char *key, T val)
-      : m_type(DataType::TYPE_INT), m_key(key), m_value()   {
-      m_value.integer = val;
-    }
-
-    /// @brief Constructs telemetry record from boolean value
-    /// @param key Key of the key value pair we want to create
-    /// @param val Value of the key value pair we want to create
-    inline Telemetry(const char *key, bool val)
-      : m_type(DataType::TYPE_BOOL), m_key(key), m_value()  {
-      m_value.boolean = val;
+            : m_type(DataType::TYPE_INT), m_key(key), m_value()   {
+        m_value.integer = val;
     }
 
     /// @brief Constructs telemetry record from float value
@@ -49,8 +54,8 @@ class Telemetry {
     /// @param key Key of the key value pair we want to create
     /// @param val Value of the key value pair we want to create
     inline Telemetry(const char *key, const char *val)
-      : m_type(DataType::TYPE_STR), m_key(key), m_value()   {
-      m_value.str = val;
+            : m_type(DataType::TYPE_STR), m_key(key), m_value()   {
+        m_value.str = val;
     }
 
     /// @brief Whether this record is empty or not
@@ -65,10 +70,6 @@ class Telemetry {
     inline bool SerializeKeyValue(const JsonVariant &jsonObj) const {
       if (m_key) {
         switch (m_type) {
-          case DataType::TYPE_BOOL:
-            jsonObj[m_key] = m_value.boolean;
-            return true;
-            break;
           case DataType::TYPE_INT:
             jsonObj[m_key] = m_value.integer;
             return true;
@@ -89,9 +90,6 @@ class Telemetry {
       }
 
       switch (m_type) {
-        case DataType::TYPE_BOOL:
-          return jsonObj.set(m_value.boolean);
-          break;
         case DataType::TYPE_INT:
           return jsonObj.set(m_value.integer);
           break;
@@ -112,15 +110,13 @@ class Telemetry {
     // Data container
     union Data {
       const char  *str;
-      bool        boolean;
       int         integer;
       float       real;
     };
 
     // Data type inside a container
     enum class DataType: const uint8_t {
       TYPE_NONE,
-      TYPE_BOOL,
       TYPE_INT,
       TYPE_REAL,
       TYPE_STR

src/ThingsBoard.h

@@ -637,11 +637,11 @@ class ThingsBoardSized {
     // Telemetry API
 
     /// @brief Attempts to send telemetry data with the given key and value of the given type
-    /// @tparam T Type of the data value we want to send
+    /// @tparam T Type of the passed value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @return Whether sending the data was successful or not
-    template<class T>
+    template<typename T>
     inline bool sendTelemetryData(const char *key, T value) {
       return sendKeyValue(key, value);
     }
@@ -811,45 +811,45 @@ class ThingsBoardSized {
     // Attribute API
 
     /// @brief Attempts to send attribute data with the given key and value of the given type
-    /// @tparam T Type of the data value we want to send
+    /// @tparam T Type of the passed value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @return Whether sending the data was successful or not
-    template<class T>
-    inline bool sendAttributeData(const char *attrName, T value) {
-      return sendKeyValue(attrName, value, false);
+    template<typename T>
+    inline bool sendAttributeData(const char *key, T value) {
+      return sendKeyValue(key, value, false);
     }
 
     /// @brief Attempts to send integer attribute data with the given key and value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @return Whether sending the data was successful or not
-    inline bool sendAttributeInt(const char *attrName, int value) {
-      return sendKeyValue(attrName, value, false);
+    inline bool sendAttributeInt(const char *key, int value) {
+      return sendKeyValue(key, value, false);
     }
 
     /// @brief Attempts to send boolean attribute data with the given key and value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @return Whether sending the data was successful or not
-    inline bool sendAttributeBool(const char *attrName, bool value) {
-      return sendKeyValue(attrName, value, false);
+    inline bool sendAttributeBool(const char *key, bool value) {
+      return sendKeyValue(key, value, false);
     }
 
     /// @brief Attempts to send float attribute data with the given key and value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @return Whether sending the data was successful or not
-    inline bool sendAttributeFloat(const char *attrName, float value) {
-      return sendKeyValue(attrName, value, false);
+    inline bool sendAttributeFloat(const char *key, float value) {
+      return sendKeyValue(key, value, false);
     }
 
     /// @brief Attempts to send string attribute data with the given key and value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @return Whether sending the data was successful or not
-    inline bool sendAttributeString(const char *attrName, const char *value) {
-      return sendKeyValue(attrName, value, false);
+    inline bool sendAttributeString(const char *key, const char *value) {
+      return sendKeyValue(key, value, false);
     }
 
     /// @brief Attempts to send aggregated attribute data
@@ -1845,7 +1845,7 @@ class ThingsBoardSized {
     }
 
     /// @brief Attempts to send a single key-value pair with the given key and value of the given type
-    /// @tparam T Type of the data value we want to send
+    /// @tparam T Type of the passed value
     /// @param key Key of the key value pair we want to send
     /// @param value Value of the key value pair we want to send
     /// @param telemetry Whether the data we want to send should be sent as an attribute or telemetry data value