Merge branch 'dev-2.9.3'

sivar2311 · sivar2311 · commit cdb822ea391e · 2021-04-05T15:58:06.000+02:00
diff --git a/library.json b/library.json
@@ -13,7 +13,7 @@
       "maintainer": true
     }
   ],
-  "version": "2.9.2",
+  "version": "2.9.3",
   "frameworks": "arduino",
   "platforms": [
     "espressif8266",
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=SinricPro
-version=2.9.2
+version=2.9.3
 author=Boris Jaeger <sivar2311@gmail.com>
 maintainer=Boris Jaeger <sivar2311@gmail.com>
 sentence=Library for https://sinric.pro - simple way to connect your device to alexa
diff --git a/src/Capabilities/RangeController.h b/src/Capabilities/RangeController.h
@@ -4,96 +4,123 @@
 #include "SinricProRequest.h"
 
 /**
- * @brief RangeController
+ * @brief RangeControllerFloatInt
  * @ingroup Capabilities
  **/
 template <typename T>
 class RangeController {
   public:
+
     RangeController() { static_cast<T &>(*this).requestHandlers.push_back(std::bind(&RangeController<T>::handleRangeController, this, std::placeholders::_1)); }
     /**
      * @brief Callback definition for onRangeValue function
      * 
      * Gets called when device receive a `setRangeValue` reuqest \n
      * @param[in]   deviceId    String which contains the ID of device
-     * @param[in]   rangeValue  Integer 0..3 for range value device has to be set
-     * @param[out]  rangeValue  Integer 0..3 returning the current range value
+     * @param[in]   rangeValue  for range value device has to be set
+     * @param[out]  rangeValue  returning the current range value
      * @return      the success of the request
      * @retval      true        request handled properly
      * @retval      false       request was not handled properly because of some error
      * 
      * @section SetRangeValueCallback Example-Code
      * @snippet callbacks.cpp onRangeValue
      **/
-    using SetRangeValueCallback = std::function<bool(const String &, int &)>;
+
+    using GenericRangeValueCallback_int   = bool (*)(const String &, const String &, int &);
+    using GenericRangeValueCallback_float = bool (*)(const String &, const String &, float &);
+
+    struct GenericRangeValueCallback {
+      GenericRangeValueCallback() : type(type_unknown) {}
+      GenericRangeValueCallback(GenericRangeValueCallback_int cb)   : type(type_int), cb_int(cb) {}
+      GenericRangeValueCallback(GenericRangeValueCallback_float cb) : type(type_float), cb_float(cb) {}
+      enum {
+        type_unknown,
+        type_int,
+        type_float
+      } type;
+      union {
+        GenericRangeValueCallback_int   cb_int;
+        GenericRangeValueCallback_float cb_float;
+      };
+    };
+
+    using SetRangeValueCallback = bool (*)(const String &, int &);
+//    using SetRangeValueCallback = std::function<bool(const String &, int &)>;
 
     /**
      * @brief Callback definition for onRangeValue function on a specific instance
      * 
      * Gets called when device receive a `setRangeValue` reuqest \n
      * @param[in]   deviceId    String which contains the ID of device
      * @param[in]   instance    String instance name
-     * @param[in]   rangeValue  Integer 0..3 for range value device has to be set
-     * @param[out]  rangeValue  Integer 0..3 returning the current range value
+     * @param[in]   rangeValue  for range value device has to be set
+     * @param[out]  rangeValue  returning the current range value
      * @return      the success of the request
      * @retval      true        request handled properly
      * @retval      false       request was not handled properly because of some error
      * 
      * @section GenericSetRangeValueCallback Example-Code
      * @snippet callbacks.cpp onRangeValueGeneric
      **/
-    using GenericSetRangeValueCallback = std::function<bool(const String &, const String &, int &)>;
+     using GenericSetRangeValueCallback_int = GenericRangeValueCallback_int;
+     using GenericSetRangeValueCallback_float = GenericRangeValueCallback_float;
 
     /**
      * @brief Callback definition for onAdjustRangeValue function
      * 
      * Gets called when device receive a `adjustRangeValue` reuqest \n
      * @param[in]   deviceId    String which contains the ID of device
-     * @param[in]   rangeValue  Integer -3..3 delta value for range value have to change
-     * @param[out]  rangeValue  Integer 3..3 returning the absolute range value 
+     * @param[in]   rangeValue  delta value for range value have to change
+     * @param[out]  rangeValue  returning the absolute range value 
      * @return      the success of the request
      * @retval      true        request handled properly
      * @retval      false       request was not handled properly because of some error
      * 
      * @section AdjustRangeValueCallback Example-Code
      * @snippet callbacks.cpp onAdjustRangeValue
      **/
-    using AdjustRangeValueCallback = std::function<bool(const String &, int &)>;
+    using AdjustRangeValueCallback = bool (*)(const String &, int &);
+//    using AdjustRangeValueCallback = std::function<bool(const String &, int &)>;
 
     /**
      * @brief Callback definition for onAdjustRangeValue function on a specific instance for custom devices
      * 
      * Gets called when device receive a `adjustRangeValue` reuqest \n
      * @param[in]   deviceId    String which contains the ID of device
      * @param[in]   instance    String instance name
-     * @param[in]   rangeValue  Integer -3..3 delta value for range value have to change
-     * @param[out]  rangeValue  Integer 3..3 returning the absolute range value 
+     * @param[in]   rangeValue  delta value for range value have to change
+     * @param[out]  rangeValue  returning the absolute range value 
      * @return      the success of the request
      * @retval      true        request handled properly
      * @retval      false       request was not handled properly because of some error
      * 
      * @section GenericAdjustRangeValueCallback Example-Code
      * @snippet callbacks.cpp onAdjustRangeValueGeneric
      **/
-    using GenericAdjustRangeValueCallback = std::function<bool(const String&, const String&, int&)>;
+    using GenericAdjustRangeValueCallback_int   = GenericRangeValueCallback_int;
+    using GenericAdjustRangeValueCallback_float = GenericRangeValueCallback_float;
 
     void onRangeValue(SetRangeValueCallback cb);
-    void onRangeValue(const String& instance, GenericSetRangeValueCallback cb);
+    void onRangeValue(const String& instance, GenericSetRangeValueCallback_int cb);
+    void onRangeValue(const String& instance, GenericSetRangeValueCallback_float cb);
 
     void onAdjustRangeValue(AdjustRangeValueCallback cb);
-    void onAdjustRangeValue(const String& instance, GenericAdjustRangeValueCallback cb);
+    void onAdjustRangeValue(const String& instance, GenericAdjustRangeValueCallback_int cb);
+    void onAdjustRangeValue(const String& instance, GenericAdjustRangeValueCallback_float cb);
 
     bool sendRangeValueEvent(int rangeValue, String cause = "PHYSICAL_INTERACTION");
     bool sendRangeValueEvent(const String& instance, int rangeValue, String cause = "PHYSICAL_INTERACTION");
+    bool sendRangeValueEvent(const String& instance, float rangeValue, String cause = "PHYSICAL_INTERACTION");
 
   protected:
     bool handleRangeController(SinricProRequest &request);
 
   private:
     SetRangeValueCallback setRangeValueCallback;
-    std::map<String, GenericSetRangeValueCallback> genericSetRangeValueCallback;
+    std::map<String, GenericRangeValueCallback> genericSetRangeValueCallback;
     AdjustRangeValueCallback adjustRangeValueCallback;
-    std::map<String, GenericAdjustRangeValueCallback> genericAdjustRangeValueCallback;
+    std::map<String, GenericRangeValueCallback> genericAdjustRangeValueCallback;
 };
 
 /**
@@ -115,8 +142,13 @@ void RangeController<T>::onRangeValue(SetRangeValueCallback cb) {
  * @see GenericSetRangeValueCallback
  */
 template <typename T>
-void RangeController<T>::onRangeValue(const String& instance, GenericSetRangeValueCallback cb) {
-  genericSetRangeValueCallback[instance] = cb;
+void RangeController<T>::onRangeValue(const String& instance, GenericSetRangeValueCallback_int cb) {
+  genericSetRangeValueCallback[instance] = GenericRangeValueCallback(cb);
+}
+
+template <typename T>
+void RangeController<T>::onRangeValue(const String& instance, GenericSetRangeValueCallback_float cb) {
+  genericSetRangeValueCallback[instance] = GenericRangeValueCallback(cb);
 }
 
 /**
@@ -131,10 +163,14 @@ void RangeController<T>::onAdjustRangeValue(AdjustRangeValueCallback cb) {
 }
 
 template <typename T>
-void RangeController<T>::onAdjustRangeValue(const String &instance, GenericAdjustRangeValueCallback cb) {
-  genericAdjustRangeValueCallback[instance] = cb;
+void RangeController<T>::onAdjustRangeValue(const String &instance, GenericAdjustRangeValueCallback_int cb) {
+  genericAdjustRangeValueCallback[instance] = GenericRangeValueCallback(cb);
 }
 
+template <typename T>
+void RangeController<T>::onAdjustRangeValue(const String &instance, GenericAdjustRangeValueCallback_float cb) {
+  genericAdjustRangeValueCallback[instance] = GenericRangeValueCallback(cb);
+}
 
 /**
  * @brief Send `rangeValue` event to report curent rangeValue to SinricPro server
@@ -177,39 +213,87 @@ bool RangeController<T>::sendRangeValueEvent(const String& instance, int rangeVa
   return device.sendEvent(eventMessage);
 }
 
+template <typename T>
+bool RangeController<T>::sendRangeValueEvent(const String& instance, float rangeValue, String cause){
+  T &device = static_cast<T &>(*this);
+
+  DynamicJsonDocument eventMessage = device.prepareEvent("setRangeValue", cause.c_str());
+  eventMessage["payload"]["instanceId"] = instance;
+
+  JsonObject event_value = eventMessage["payload"]["value"];
+  event_value["rangeValue"] = rangeValue;
+  return device.sendEvent(eventMessage);
+}
+
 template <typename T>
 bool RangeController<T>::handleRangeController(SinricProRequest &request) {
   T &device = static_cast<T &>(*this);
 
   bool success = false;
 
   if (request.action == "setRangeValue") {
-    int rangeValue = request.request_value["rangeValue"] | 0;
-    if (request.instance != "") {
-      if (genericSetRangeValueCallback.find(request.instance) != genericSetRangeValueCallback.end()) 
-        success = genericSetRangeValueCallback[request.instance](device.deviceId, request.instance, rangeValue);
-    } else {
+
+    if (request.instance == "") {
+
+      int rangeValue = request.request_value["rangeValue"];
       if (setRangeValueCallback) success = setRangeValueCallback(device.deviceId, rangeValue);
+      request.response_value["rangeValue"] = rangeValue;
+      return success;
+
+    } else {
+
+      if (genericSetRangeValueCallback.find(request.instance) == genericSetRangeValueCallback.end()) return false;
+
+      auto& cb = genericSetRangeValueCallback[request.instance];
+
+      if (cb.type == GenericRangeValueCallback::type_float) {
+        float value = request.request_value["rangeValue"];
+        success = cb.cb_float(device.deviceId, request.instance, value);
+        request.response_value["rangeValue"] = value;
+        return success;
+      }
+
+      if (cb.type == GenericRangeValueCallback::type_int) {
+        int value = request.request_value["rangeValue"];
+        success = cb.cb_int(device.deviceId, request.instance, value);
+        request.response_value["rangeValue"] = value;
+        return success;
+      }
     }
-    request.response_value["rangeValue"] = rangeValue;
-    return success;
   }
 
   if (request.action == "adjustRangeValue") {
-    int rangeValueDelta = request.request_value["rangeValueDelta"] | 0;
-    if (request.instance != "") {
-      if (genericAdjustRangeValueCallback.find(request.instance) != genericAdjustRangeValueCallback.end()) 
-        success = genericAdjustRangeValueCallback[request.instance](device.deviceId, request.instance, rangeValueDelta);
+
+    if (request.instance == "") {
+
+      int rangeValue = request.request_value["rangeValueDelta"];
+      if (setRangeValueCallback) success = setRangeValueCallback(device.deviceId, rangeValue);
+      request.response_value["rangeValue"] = rangeValue;
+      return success;
+
     } else {
-      if (adjustRangeValueCallback)
-        success = adjustRangeValueCallback(device.deviceId, rangeValueDelta);
+
+      if (genericSetRangeValueCallback.find(request.instance) == genericSetRangeValueCallback.end()) return false;
+
+      auto& cb = genericAdjustRangeValueCallback[request.instance];
+
+      if (cb.type == GenericRangeValueCallback::type_float) {
+        float value = request.request_value["rangeValueDelta"];
+        success = cb.cb_float(device.deviceId, request.instance, value);
+        request.response_value["rangeValue"] = value;
+        return success;
+      }
+
+      if (cb.type == GenericRangeValueCallback::type_int) {
+        int value = request.request_value["rangeValueDelta"];
+        success = cb.cb_int(device.deviceId, request.instance, value);
+        request.response_value["rangeValue"] = value;
+        return success;
+      }
     }
-    
-    request.response_value["rangeValue"] = rangeValueDelta;
-    return success;
   }
 
-  return success;
+  return false;
 }
 
 #endif
diff --git a/src/SinricProConfig.h b/src/SinricProConfig.h
@@ -25,7 +25,7 @@
 // Version Configuration
 #define SINRICPRO_VERSION_MAJOR     2
 #define SINRICPRO_VERSION_MINOR     9
-#define SINRICPRO_VERSION_REVISION  2
+#define SINRICPRO_VERSION_REVISION  3
 #define SINRICPRO_VERSION STR(SINRICPRO_VERSION_MAJOR) "." STR(SINRICPRO_VERSION_MINOR) "." STR(SINRICPRO_VERSION_REVISION)
 #define SINRICPRO_VERSION_STR "SinricPro (v" SINRICPRO_VERSION ")"
 #define SINRICPRO_VERISON_INT SINRICPRO_VERSION_MAJOR * 1000000 + SINRICPRO_VERSION_MINOR * 1000 + SINRICPRO_VERSION_REVISION
diff --git a/src/SinricProDevice.h b/src/SinricProDevice.h
@@ -80,7 +80,9 @@ bool SinricProDevice::sendEvent(JsonDocument& event) {
     return false;
   }
   String eventName = event["payload"]["action"] | ""; // get event name
-
+  String eventInstance = event["payload"]["instanceId"] | "";
+  if (eventInstance != "") eventName += "_" + eventInstance;
+  
   LeakyBucket_t bucket; // leaky bucket algorithm is used to prevent flooding the server
 
   // get leaky bucket for event from eventFilter

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`"maintainer": true`
`14`	`14`	`}`
`15`	`15`	`],`
`16`		`- "version": "2.9.2",`
	`16`	`+ "version": "2.9.3",`
`17`	`17`	`"frameworks": "arduino",`
`18`	`18`	`"platforms": [`
`19`	`19`	`"espressif8266",`