SinricPro Library
SinricProDevice.h
1 /*
2  * Copyright (c) 2019 Sinric. All rights reserved.
3  * Licensed under Creative Commons Attribution-Share Alike (CC BY-SA)
4  *
5  * This file is part of the Sinric Pro (https://github.com/sinricpro/)
6  */
7 
8 #ifndef _SINRICDEVICE_H_
9 #define _SINRICDEVICE_H_
10 
11 #include "SinricProDeviceInterface.h"
12 #include "LeakyBucket.h"
13 
14 #include <map>
15 
23 class SinricProDevice : public SinricProDeviceInterface {
24  public:
25  SinricProDevice(const char* newDeviceId, unsigned long eventWaitTime=100);
26  virtual ~SinricProDevice();
27  virtual const char* getDeviceId();
28  virtual void begin(SinricProInterface* eventSender);
29  virtual void setEventWaitTime(unsigned long eventWaitTime) { if (eventWaitTime<100) {this->eventWaitTime=100;} else { this->eventWaitTime=eventWaitTime;} }
30 
31  // callback definitions
45  typedef std::function<bool(const String&, bool&)> PowerStateCallback;
46 
47 
48  // standard request handler
49  virtual bool handleRequest(const char* deviceId, const char* action, JsonObject &request_value, JsonObject &response_value);
50 
51  // standard Callbacks
52  virtual void onPowerState(PowerStateCallback cb);
53 
54  // standard events
55  bool sendPowerStateEvent(bool state, String cause = "PHYSICAL_INTERACTION");
56 
57  protected:
58  virtual bool sendEvent(JsonDocument& event);
59  virtual DynamicJsonDocument prepareEvent(const char* deviceId, const char* action, const char* cause);
60  unsigned long getTimestamp();
61  char* deviceId;
62  PowerStateCallback powerStateCallback;
63  private:
64  SinricProInterface* eventSender;
65  unsigned long eventWaitTime;
66  std::map<String, LeakyBucket_t> eventFilter;
67 };
68 
69 SinricProDevice::SinricProDevice(const char* newDeviceId, unsigned long eventWaitTime) :
70  powerStateCallback(nullptr),
71  eventSender(nullptr),
72  eventWaitTime(eventWaitTime) {
73  deviceId = strdup(newDeviceId);
74  if (this->eventWaitTime < 100) this->eventWaitTime = 100;
75 }
76 
77 SinricProDevice::~SinricProDevice() {
78  if (deviceId) free(deviceId);
79 }
80 
81 void SinricProDevice::begin(SinricProInterface* eventSender) {
82  this->eventSender = eventSender;
83 }
84 
85 const char* SinricProDevice::getDeviceId() {
86  return deviceId;
87 }
88 
89 bool SinricProDevice::handleRequest(const char* deviceId, const char* action, JsonObject &request_value, JsonObject &response_value) {
90  if (strcmp(deviceId, this->deviceId) != 0) return false;
91  DEBUG_SINRIC("SinricProDevice::handleRequest()\r\n");
92  bool success = false;
93  String actionString = String(action);
94 
95  if (actionString == "setPowerState" && powerStateCallback) {
96  bool powerState = request_value["state"]=="On"?true:false;
97  success = powerStateCallback(String(deviceId), powerState);
98  response_value["state"] = powerState?"On":"Off";
99  return success;
100  }
101  return success;
102 }
103 
104 DynamicJsonDocument SinricProDevice::prepareEvent(const char* deviceId, const char* action, const char* cause) {
105  if (eventSender) return eventSender->prepareEvent(deviceId, action, cause);
106  DEBUG_SINRIC("[SinricProDevice:prepareEvent()]: Device \"%s\" isn't configured correctly! The \'%s\' event will be ignored.\r\n", deviceId, action);
107  return DynamicJsonDocument(1024);
108 }
109 
110 
111 bool SinricProDevice::sendEvent(JsonDocument& event) {
112  String eventName = event["payload"]["action"] | ""; // get event name
113 
114  LeakyBucket_t bucket; // leaky bucket algorithm is used to prevent flooding the server
115 
116  // get leaky bucket for event from eventFilter
117  if (eventFilter.find(eventName) == eventFilter.end()) { // if there is no bucket ...
118  eventFilter[eventName] = bucket; // ...add a new bucket
119  } else {
120  bucket = eventFilter[eventName]; // else get bucket
121  }
122 
123  if (bucket.addDrop()) { // if we can add a new drop
124  if (eventSender) eventSender->sendMessage(event); // send event
125  eventFilter[eventName] = bucket; // update bucket on eventFilter
126  return true;
127  }
128 
129  eventFilter[eventName] = bucket; // update bucket on eventFilter
130  return false;
131 }
132 
133 unsigned long SinricProDevice::getTimestamp() {
134  if (eventSender) return eventSender->getTimestamp();
135  return 0;
136 }
137 
146  powerStateCallback = cb;
147 }
148 
158 bool SinricProDevice::sendPowerStateEvent(bool state, String cause) {
159  DynamicJsonDocument eventMessage = prepareEvent(deviceId, "setPowerState", cause.c_str());
160  JsonObject event_value = eventMessage["payload"]["value"];
161  event_value["state"] = state?"On":"Off";
162  return sendEvent(eventMessage);
163 }
164 
165 #endif
SinricProDevice::sendPowerStateEvent
bool sendPowerStateEvent(bool state, String cause="PHYSICAL_INTERACTION")
Send setPowerState event to SinricPro Server indicating actual power state.
Definition: SinricProDevice.h:158
SinricProDevice::PowerStateCallback
std::function< bool(const String &, bool &)> PowerStateCallback
Callback definition for onPowerState function.
Definition: SinricProDevice.h:45
SinricProDevice
Base class for all device types.
Definition: SinricProDevice.h:23
SinricProDevice::onPowerState
virtual void onPowerState(PowerStateCallback cb)
Set callback function for powerState request.
Definition: SinricProDevice.h:145