SinricPro Library
|
Device to control a fan with on / off commands and its speed by a range value. More...
Public Types | |
typedef std::function< bool(const String &, int &)> | SetRangeValueCallback |
Callback definition for onRangeValue function. More... | |
typedef std::function< bool(const String &, int &)> | AdjustRangeValueCallback |
Callback definition for onAdjustRangeValue function. More... | |
typedef std::function< bool(const String &, bool &)> | PowerStateCallback |
Callback definition for onPowerState function. More... | |
Public Member Functions | |
void | onRangeValue (SetRangeValueCallback cb) |
Set callback function for setRangeValue request. More... | |
void | onAdjustRangeValue (AdjustRangeValueCallback cb) |
Set callback function for adjustRangeValue request. More... | |
bool | sendRangeValueEvent (int rangeValue, String cause="PHYSICAL_INTERACTION") |
Send rangeValue event to report curent rangeValue to SinricPro server. More... | |
virtual void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
bool | sendPowerStateEvent (bool state, String cause="PHYSICAL_INTERACTION") |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
Device to control a fan with on / off commands and its speed by a range value.
typedef std::function<bool(const String&, int&)> AdjustRangeValueCallback |
Callback definition for onAdjustRangeValue function.
Gets called when device receive a adjustRangeValue
reuqest
[in] | deviceId | String which contains the ID of device |
[in] | rangeValue | Integer -n..n delta value for range value have to change |
[out] | rangeValue | Integer 0..n returning the absolute range value |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Callback definition for onPowerState function.
Gets called when device receive a setPowerState
reuqest
[in] | deviceId | String which contains the ID of device |
[in] | state | true = device is requested to turn on false = device is requested to turn off |
[out] | state | true = device has been turned on false = device has been turned off |
true | request handled properly |
false | request was not handled properly because of some error |
typedef std::function<bool(const String&, int&)> SetRangeValueCallback |
Callback definition for onRangeValue function.
Gets called when device receive a setRangeValue
reuqest
[in] | deviceId | String which contains the ID of device |
[in] | rangeValue | Integer 0..n for range value device has to be set |
[out] | rangeValue | Integer 0..n returning the current range value |
true | request handled properly |
false | request was not handled properly because of some error |
void onAdjustRangeValue | ( | AdjustRangeValueCallback | cb | ) |
Set callback function for adjustRangeValue
request.
cb | Function pointer to a AdjustRangeValueCallback function |
|
virtualinherited |
Set callback function for powerState
request.
cb | Function pointer to a PowerStateCallback function |
void onRangeValue | ( | SetRangeValueCallback | cb | ) |
Set callback function for setRangeValue
request.
cb | Function pointer to a SetRangeValueCallback function |
|
inherited |
Send setPowerState
event to SinricPro Server indicating actual power state.
state | true = device turned on false = device turned off |
cause | (optional) String reason why event is sent (default = "PHYSICAL_INTERACTION" ) |
true | event has been sent successfully |
false | event has not been sent, maybe you sent to much events in a short distance of time |
bool sendRangeValueEvent | ( | int | rangeValue, |
String | cause = "PHYSICAL_INTERACTION" |
||
) |
Send rangeValue
event to report curent rangeValue to SinricPro server.
rangeValue | Value between 0..n |
cause | (optional) String reason why event is sent (default = "PHYSICAL_INTERACTION" ) |
true | event has been sent successfully |
false | event has not been sent, maybe you sent to much events in a short distance of time |