SinricPro Library
|
Device to control Window Air Conditioner. More...
Public Types | |
using | PowerStateCallback = std::function< bool(const String &, bool &)> |
Callback definition for onPowerState function. More... | |
using | SetRangeValueCallback = std::function< bool(const String &, int &)> |
Callback definition for onRangeValue function. More... | |
using | GenericSetRangeValueCallback = std::function< bool(const String &, const String &, int &)> |
Callback definition for onRangeValue function on a specific instance. More... | |
using | AdjustRangeValueCallback = std::function< bool(const String &, int &)> |
Callback definition for onAdjustRangeValue function. More... | |
using | GenericAdjustRangeValueCallback = std::function< bool(const String &, const String &, int &)> |
Callback definition for onAdjustRangeValue function on a specific instance for custom devices. More... | |
using | ThermostatModeCallback = std::function< bool(const String &, String &)> |
Callback definition for onThermostatMode function. More... | |
using | SetTargetTemperatureCallback = std::function< bool(const String &, float &)> |
Callback definition for onTargetTemperature function. More... | |
using | AdjustTargetTemperatureCallback = std::function< bool(const String &, float &)> |
Callback definition for onAdjustTargetTemperature function. More... | |
Public Member Functions | |
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... | |
void | onRangeValue (SetRangeValueCallback cb) |
Set callback function for setRangeValue request. More... | |
void | onRangeValue (const String &instance, GenericSetRangeValueCallback cb) |
Set callback function for setRangeValue request on a specific instance (custom device) 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... | |
bool | sendRangeValueEvent (const String &instance, int rangeValue, String cause="PHYSICAL_INTERACTION") |
Send rangeValue event to report curent rangeValue to SinricPro server for a specific instance (custom device) More... | |
void | onThermostatMode (ThermostatModeCallback cb) |
Set callback function for setThermostatMode request. More... | |
void | onTargetTemperature (SetTargetTemperatureCallback cb) |
Set callback function for targetTemperature request. More... | |
void | onAdjustTargetTemperature (AdjustTargetTemperatureCallback cb) |
Set callback function for adjustTargetTemperature request. More... | |
bool | sendThermostatModeEvent (String thermostatMode, String cause="PHYSICAL_INTERACTION") |
Send thermostatMode event to report a the new mode the device has been set to. More... | |
bool | sendTargetTemperatureEvent (float temperature, String cause="PHYSICAL_INTERACTION") |
Send targetTemperature event to report target temperature change. More... | |
Device to control Window Air Conditioner.
Support
AUTO
, COOL
, HEAT
|
inherited |
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 -3..3 delta value for range value have to change |
[out] | rangeValue | Integer 3..3 returning the absolute range value |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Callback definition for onAdjustTargetTemperature function.
Gets called when device receive a adjustTargetTemperature
reuqest
[in] | deviceId | String which contains the ID of device |
[in] | temperature | Float relative temperature device should change about |
[out] | temperature | Float absolute temperature device is set to |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Callback definition for onAdjustRangeValue function on a specific instance for custom devices.
Gets called when device receive a adjustRangeValue
reuqest
[in] | deviceId | String which contains the ID of device |
[in] | instance | String instance name |
[in] | rangeValue | Integer -3..3 delta value for range value have to change |
[out] | rangeValue | Integer 3..3 returning the absolute range value |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Callback definition for onRangeValue function on a specific instance.
Gets called when device receive a setRangeValue
reuqest
[in] | deviceId | String which contains the ID of device |
[in] | instance | String instance name |
[in] | rangeValue | Integer 0..3 for range value device has to be set |
[out] | rangeValue | Integer 0..3 returning the current 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 |
|
inherited |
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..3 for range value device has to be set |
[out] | rangeValue | Integer 0..3 returning the current range value |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Callback definition for onTargetTemperature function.
Gets called when device receive a targetTemperature
request
[in] | deviceId | String which contains the ID of device |
[in] | temperature | Float device is requested to set the target temperature to |
[out] | temperature | Float target temperature temperature device is set to |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Callback definition for onThermostatMode function.
Gets called when device receive a setThermostatMode
request
[in] | deviceId | String which contains the ID of device |
[in] | mode | String with mode device should set to |
[out] | mode | String device mode is set to |
true | request handled properly |
false | request was not handled properly because of some error |
|
inherited |
Set callback function for adjustRangeValue
request.
cb | Function pointer to a AdjustRangeValueCallback function |
|
inherited |
Set callback function for adjustTargetTemperature
request.
cb | Function pointer to a AdjustTargetTemperatureCallback function |
|
inherited |
Set callback function for powerState
request.
cb | Function pointer to a PowerStateCallback function |
|
inherited |
Set callback function for setRangeValue
request on a specific instance (custom device)
instance | String instance name (custom device) |
cb | Function pointer to a GenericSetRangeValueCallback function |
|
inherited |
Set callback function for setRangeValue
request.
cb | Function pointer to a SetRangeValueCallback function |
|
inherited |
Set callback function for targetTemperature
request.
cb | Function pointer to a SetTargetTemperatureCallback function |
|
inherited |
Set callback function for setThermostatMode
request.
cb | Function pointer to a ThermostatModeCallback 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 |
|
inherited |
Send rangeValue
event to report curent rangeValue to SinricPro server for a specific instance (custom device)
instance | String instance name |
rangeValue | Value between 0..3 |
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 |
|
inherited |
Send rangeValue
event to report curent rangeValue to SinricPro server.
rangeValue | Value between 0..3 |
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 |
|
inherited |
Send targetTemperature
event to report target temperature change.
temperature | Float with actual target temperature the device is set to |
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 |
|
inherited |
Send thermostatMode
event to report a the new mode the device has been set to.
thermostatMode | String with actual mode (AUTO , COOL , HEAT ) the device is set to |
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 |