diff --git a/Doxyfile b/Doxyfile index ffd847b..82da17d 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = . +OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -186,7 +186,7 @@ STRIP_FROM_INC_PATH = # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. -SHORT_NAMES = YES +SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief @@ -864,8 +864,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../esp8266-esp32-sdk \ - ..\esp8266-esp32-sdk\src \ +INPUT = ..\esp8266-esp32-sdk\src \ ..\esp8266-esp32-sdk\README.md \ ..\esp8266-esp32-sdk\src\Capabilities \ documentation.dox @@ -989,7 +988,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = doc-examples/ +EXAMPLE_PATH = doc-examples # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -2544,7 +2543,7 @@ DIRECTORY_GRAPH = YES # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_IMAGE_FORMAT = svg +DOT_IMAGE_FORMAT = png # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. diff --git a/doc-examples/documentation.dox b/doc-examples/documentation.dox deleted file mode 100644 index 0d3cc57..0000000 --- a/doc-examples/documentation.dox +++ /dev/null @@ -1,11 +0,0 @@ -/** - * @defgroup SinricPro SinricPro - * @brief Main instance of SinricProClass - * - * @defgroup Devices Devices - * @brief Available devices - * - * @defgroup Capabilities Capabilities - * @brief Capabilities - * - **/ diff --git a/docs/dir_a3d2086e3c3fe22c73a549735325deec.html b/docs/dir_a3d2086e3c3fe22c73a549735325deec.html deleted file mode 100644 index 1f72c8c..0000000 --- a/docs/dir_a3d2086e3c3fe22c73a549735325deec.html +++ /dev/null @@ -1,98 +0,0 @@ - - -
- - - - -|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
| ▼NSINRICPRO_2_9_17 | SinricPro namespace |
| CSinricProClass | The main class of this library, handling communication between SinricPro Server and your devices |
| CSinricProAirQualitySensor | Device to report air quality events |
| CSinricProBlinds | Device to control interior blinds |
| CSinricProCamera | Camera suporting basic on / off command |
| CSinricProContactsensor | Device to report contact sensor events |
| CSinricProDevice | Base class for all device types |
| CSinricProDimSwitch | Device which supports on / off and dimming commands |
| CSinricProDoorbell | Device to report doorbell events |
| CSinricProFan | Device to turn on / off a fan and change it's speed by using powerlevel |
| CSinricProFanUS | Device to control a fan with on / off commands and its speed by a range value |
| CSinricProGarageDoor | Device to control a garage door |
| CSinricProLight | Device to control a light |
| CSinricProLock | Device to control a smart lock |
| CSinricProMotionsensor | Device to report motion detection events |
| CSinricProPowerSensor | Device to report power usage |
| CSinricProSpeaker | Device to control a smart speaker |
| CSinricProSwitch | Device suporting basic on / off command |
| CSinricProTemperaturesensor | Device to report actual temperature and humidity |
| CSinricProThermostat | Device to control Thermostat |
| CSinricProTV | Device to control a TV |
| CSinricProWindowAC | Device to control Window Air Conditioner |
| CAirQualitySensor | AirQuality |
| CBrightnessController | BrightnessController |
| CChannelController | ChannelController |
| CColorController | ColorController |
| CColorTemperatureController | ColorTemperatureController |
| CContactSensor | ContactSensor |
| CDoorbell | Dorbell |
| CDoorController | DoorController - only used for GarageDoor device and cannot used as capability for a custom device! |
| CEqualizerController | EqualizerController |
| CInputController | InputController |
| CKeypadController | KeypadController |
| CLockController | LockController |
| CMediaController | MediaController |
| CModeController | ModeController |
| CMotionSensor | MotionSensor |
| CMuteController | MuteController |
| CPercentageController | PercentageController |
| CPowerLevelController | PowerLevelController |
| CPowerSensor | PowerSensor |
| CPowerStateController | PowerStateController |
| CPushNotification | PushNotification |
| CRangeController | RangeControllerFloatInt |
| CTemperatureSensor | TemperatureSensor |
| CThermostatController | ThermostatController |
| CToggleController | ToggleController |
| CVolumeController | VolumeController |
|
- SinricPro Library
-
- |
-
This is the complete list of members for AirQualitySensor< T >, including all inherited members.
-| sendAirQualityEvent(int pm1=0, int pm2_5=0, int pm10=0, String cause=FSTR_SINRICPRO_PERIODIC_POLL) | AirQualitySensor< T > |
|
- SinricPro Library
-
- |
-
AirQuality. - More...
-
-Public Member Functions | |
| bool | sendAirQualityEvent (int pm1=0, int pm2_5=0, int pm10=0, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
| Sending air quality to SinricPro server. More... | |
AirQuality.
-| bool sendAirQualityEvent | -( | -int | -pm1 = 0, |
-
| - | - | int | -pm2_5 = 0, |
-
| - | - | int | -pm10 = 0, |
-
| - | - | String | -cause = FSTR_SINRICPRO_PERIODIC_POLL |
-
| - | ) | -- |
Sending air quality to SinricPro server.
-| pm1 | int 1.0 μm particle pollutant in μg/m3 |
| pm2_5 | int 2.5 μm particle pollutant in μg/m3 |
| pm10 | int 10 μm particle pollutant in μg/m3 |
| cause | (optional) String reason why event is sent (default = "PERIODIC_POLL") |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for BrightnessController< T >, including all inherited members.
-| onAdjustBrightness(AdjustBrightnessCallback cb) | BrightnessController< T > | |
| onBrightness(BrightnessCallback cb) | BrightnessController< T > | |
| sendBrightnessEvent(int brightness, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | BrightnessController< T > |
|
- SinricPro Library
-
- |
-
BrightnessController. - More...
-
-Public Member Functions | |
| void | onBrightness (BrightnessCallback cb) |
Set callback function for setBrightness request. More... | |
| void | onAdjustBrightness (AdjustBrightnessCallback cb) |
Set callback function for adjustBrightness request. More... | |
| bool | sendBrightnessEvent (int brightness, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setBrightness event to SinricPro Server indicating actual brightness. More... | |
| void onAdjustBrightness | -( | -AdjustBrightnessCallback | -cb | ) | -- |
Set callback function for adjustBrightness request.
| cb | Function pointer to a AdjustBrightnessCallback function |
| void onBrightness | -( | -BrightnessCallback | -cb | ) | -- |
Set callback function for setBrightness request.
| cb | Function pointer to a BrightnessCallback function |
| bool sendBrightnessEvent | -( | -int | -brightness, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setBrightness event to SinricPro Server indicating actual brightness.
| brightness | Integer value with actual brightness 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ChannelController< T >, including all inherited members.
-| onChangeChannel(ChangeChannelCallback cb) | ChannelController< T > | |
| onChangeChannelNumber(ChangeChannelNumberCallback cb) | ChannelController< T > | |
| onSkipChannels(SkipChannelsCallback cb) | ChannelController< T > | |
| sendChangeChannelEvent(String channelName, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ChannelController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onChangeChannel (ChangeChannelCallback cb) |
Set callback function for changeChannel request. More... | |
| void | onChangeChannelNumber (ChangeChannelNumberCallback cb) |
Set callback function for changeChannel request. More... | |
| void | onSkipChannels (SkipChannelsCallback cb) |
Set callback function for skipChannels request. More... | |
| bool | sendChangeChannelEvent (String channelName, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send changeChannel event to SinricPro Server to report selected channel. More... | |
| void onChangeChannel | -( | -ChangeChannelCallback | -cb | ) | -- |
Set callback function for changeChannel request.
| cb | Function pointer to a ChangeChannelCallback function |
| void onChangeChannelNumber | -( | -ChangeChannelNumberCallback | -cb | ) | -- |
Set callback function for changeChannel request.
| cb | Function pointer to a ChangeChannelNumberCallback function |
| void onSkipChannels | -( | -SkipChannelsCallback | -cb | ) | -- |
Set callback function for skipChannels request.
| cb | Function pointer to a SkipChannelsCallback function |
| bool sendChangeChannelEvent | -( | -String | -channelName, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send changeChannel event to SinricPro Server to report selected channel.
| channelName | String with actual channel |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ColorController< T >, including all inherited members.
-| onColor(ColorCallback cb) | ColorController< T > | |
| sendColorEvent(byte r, byte g, byte b, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ColorController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onColor (ColorCallback cb) |
Set callback function for setColor request. More... | |
| bool | sendColorEvent (byte r, byte g, byte b, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setColor event to SinricPro Server indicating actual color. More... | |
| void onColor | -( | -ColorCallback | -cb | ) | -- |
Set callback function for setColor request.
| cb | Function pointer to a ColorCallback function |
| bool sendColorEvent | -( | -byte | -r, | -
| - | - | byte | -g, | -
| - | - | byte | -b, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setColor event to SinricPro Server indicating actual color.
| r | Byte value for red |
| g | Byte value for green |
| b | Byte value for blue |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ColorTemperatureController< T >, including all inherited members.
-| onColorTemperature(ColorTemperatureCallback cb) | ColorTemperatureController< T > | |
| onDecreaseColorTemperature(DecreaseColorTemperatureCallback cb) | ColorTemperatureController< T > | |
| onIncreaseColorTemperature(IncreaseColorTemperatureCallback cb) | ColorTemperatureController< T > | |
| sendColorTemperatureEvent(int colorTemperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ColorTemperatureController< T > |
|
- SinricPro Library
-
- |
-
ColorTemperatureController. - More...
-
-Public Member Functions | |
| void | onColorTemperature (ColorTemperatureCallback cb) |
Set callback function for setColorTemperature request. More... | |
| void | onIncreaseColorTemperature (IncreaseColorTemperatureCallback cb) |
Set callback function for increaseColorTemperature request. More... | |
| void | onDecreaseColorTemperature (DecreaseColorTemperatureCallback cb) |
Set callback function for decreaseColorTemperature request. More... | |
| bool | sendColorTemperatureEvent (int colorTemperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setColorTemperature event to SinricPro Server indicating actual color temperature. More... | |
| void onColorTemperature | -( | -ColorTemperatureCallback | -cb | ) | -- |
Set callback function for setColorTemperature request.
| cb | Function pointer to a ColorTemperatureCallback function |
| void onDecreaseColorTemperature | -( | -DecreaseColorTemperatureCallback | -cb | ) | -- |
Set callback function for decreaseColorTemperature request.
| cb | Function pointer to a DecreaseColorTemperatureCallback function |
| void onIncreaseColorTemperature | -( | -IncreaseColorTemperatureCallback | -cb | ) | -- |
Set callback function for increaseColorTemperature request.
| cb | Function pointer to a IncreaseColorTemperatureCallback function |
| bool sendColorTemperatureEvent | -( | -int | -colorTemperature, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setColorTemperature event to SinricPro Server indicating actual color temperature.
| colorTemperature | Integer with new color temperature the device is set to - 2200 = warm white - 2700 = soft white - 4000 = white - 5500 = daylight white - 7000 = cool white |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ContactSensor< T >, including all inherited members.
-| sendContactEvent(bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ContactSensor< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| bool | sendContactEvent (bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setContactState event to SinricPro Server indicating actual power state. More... | |
| bool sendContactEvent | -( | -bool | -detected, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setContactState event to SinricPro Server indicating actual power state.
| detected | [in] booltrue = contact is closed - [in] false = contact is open |
| cause | [in] 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 |
- SinricPro Library
-
- |
-
This is the complete list of members for DoorController< T >, including all inherited members.
-| onDoorState(DoorCallback cb) | DoorController< T > | |
| sendDoorStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | DoorController< T > |
|
- SinricPro Library
-
- |
-
DoorController - only used for GarageDoor device and cannot used as capability for a custom device! - More...
-
-Public Member Functions | |
| void | onDoorState (DoorCallback cb) |
Set callback function for onDoorState request. More... | |
| bool | sendDoorStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send DoorState event to update actual door state on SinricPro Server. More... | |
DoorController - only used for GarageDoor device and cannot used as capability for a custom device!
-| void onDoorState | -( | -DoorCallback | -cb | ) | -- |
Set callback function for onDoorState request.
| cb | Function pointer to a onDoorState function |
| bool sendDoorStateEvent | -( | -bool | -state, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send DoorState event to update actual door state on SinricPro Server.
| state | bool true = close - false = open |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for Doorbell< T >, including all inherited members.
-| sendDoorbellEvent(String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | Doorbell< T > |
|
- SinricPro Library
-
- |
-
Dorbell. - More...
-
-Public Member Functions | |
| bool | sendDoorbellEvent (String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
| Send Doorbell event to SinricPro Server indicating someone pressed the doorbell button. More... | |
Dorbell.
-| bool sendDoorbellEvent | -( | -String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION | ) | -- |
Send Doorbell event to SinricPro Server indicating someone pressed the doorbell button.
-| cause | String (optional) 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for EqualizerController< T >, including all inherited members.
-| onAdjustBands(AdjustBandsCallback cb) | EqualizerController< T > | |
| onResetBands(ResetBandsCallback cb) | EqualizerController< T > | |
| onSetBands(SetBandsCallback cb) | EqualizerController< T > | |
| sendBandsEvent(String bands, int level, String cause="PHYSICAL_INTERACTION") | EqualizerController< T > |
|
- SinricPro Library
-
- |
-
EqualizerController. - More...
-
-Public Member Functions | |
| void | onSetBands (SetBandsCallback cb) |
Set callback function for setBands request. More... | |
| void | onAdjustBands (AdjustBandsCallback cb) |
Set callback function for adjustBands request. More... | |
| void | onResetBands (ResetBandsCallback cb) |
Set callback function for resetBands request. More... | |
| bool | sendBandsEvent (String bands, int level, String cause="PHYSICAL_INTERACTION") |
Send setBands event to SinricPro Server indicating bands level has changed. More... | |
| void onAdjustBands | -( | -AdjustBandsCallback | -cb | ) | -- |
Set callback function for adjustBands request.
| cb | Function pointer to a AdjustBandsCallback function |
| void onResetBands | -( | -ResetBandsCallback | -cb | ) | -- |
Set callback function for resetBands request.
| cb | Function pointer to a ResetBandsCallback function |
| void onSetBands | -( | -SetBandsCallback | -cb | ) | -- |
Set callback function for setBands request.
| cb | Function pointer to a SetBandsCallback function |
| bool sendBandsEvent | -( | -String | -bands, | -
| - | - | int | -level, | -
| - | - | String | -cause = "PHYSICAL_INTERACTION" |
-
| - | ) | -- |
Send setBands event to SinricPro Server indicating bands level has changed.
| bands | String which bands has changed - BASS, MIDRANGE, TREBBLE |
| level | Integer with changed bands level |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for InputController< T >, including all inherited members.
-| onSelectInput(SelectInputCallback cb) | InputController< T > | |
| sendSelectInputEvent(String intput, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | InputController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onSelectInput (SelectInputCallback cb) |
Set callback function for selectInput request. More... | |
| bool | sendSelectInputEvent (String intput, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send selectInput event to SinricPro Server to report selected input. More... | |
| void onSelectInput | -( | -SelectInputCallback | -cb | ) | -- |
Set callback function for selectInput request.
| cb | Function pointer to a SelectInputCallback function |
| bool sendSelectInputEvent | -( | -String | -input, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send selectInput event to SinricPro Server to report selected input.
| input | String with actual media control - AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for KeypadController< T >, including all inherited members.
-| onKeystroke(KeystrokeCallback cb) | KeypadController< T > |
|
- SinricPro Library
-
- |
-
-Public Member Functions | |
| void | onKeystroke (KeystrokeCallback cb) |
Set callback function for sendKeystroke request. More... | |
| void onKeystroke | -( | -KeystrokeCallback | -cb | ) | -- |
Set callback function for sendKeystroke request.
| cb | Function pointer to a KeystrokeCallback function |
|
- SinricPro Library
-
- |
-
This is the complete list of members for LockController< T >, including all inherited members.
-| onLockState(LockStateCallback cb) | LockController< T > | |
| sendLockStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | LockController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onLockState (LockStateCallback cb) |
Set callback function for setLockState request. More... | |
| bool | sendLockStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send lockState event to SinricPro Server indicating actual lock state. More... | |
| void onLockState | -( | -LockStateCallback | -cb | ) | -- |
Set callback function for setLockState request.
| cb | Function pointer to a LockStateCallback function |
| bool sendLockStateEvent | -( | -bool | -state, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send lockState event to SinricPro Server indicating actual lock state.
| state | true = device is locked - false = device is unlocked |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for MediaController< T >, including all inherited members.
-| onMediaControl(MediaControlCallback cb) | MediaController< T > | |
| sendMediaControlEvent(String mediaControl, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | MediaController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onMediaControl (MediaControlCallback cb) |
Set callback function for mediaControl request. More... | |
| bool | sendMediaControlEvent (String mediaControl, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send mediaControl event to SinricPro Server indicating devices media control state. More... | |
| void onMediaControl | -( | -MediaControlCallback | -cb | ) | -- |
Set callback function for mediaControl request.
| cb | Function pointer to a MediaControlCallback function |
| bool sendMediaControlEvent | -( | -String | -mediaControl, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send mediaControl event to SinricPro Server indicating devices media control state.
| mediaControl | String with actual media control - FastForward, Next, Pause, Play, Previous, Rewind, StartOver, Stop |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ModeController< T >, including all inherited members.
-| onSetMode(ModeCallback cb) | ModeController< T > | |
| onSetMode(const String &instance, GenericModeCallback cb) | ModeController< T > | |
| sendModeEvent(String mode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ModeController< T > | |
| sendModeEvent(String instance, String mode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ModeController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onSetMode (ModeCallback cb) |
Set callback function for setMode request. More... | |
| void | onSetMode (const String &instance, GenericModeCallback cb) |
Set callback function for setMode request on a specific instance. More... | |
| bool | sendModeEvent (String mode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMode event to SinricPro Server indicating the mode has changed. More... | |
| bool | sendModeEvent (String instance, String mode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMode event to SinricPro Server indicating the mode on a specific instance has changed. More... | |
| void onSetMode | -( | -const String & | -instance, | -
| - | - | GenericModeCallback | -cb | -
| - | ) | -- |
Set callback function for setMode request on a specific instance.
| instance | String with instance name |
| cb | Function pointer to a ModeCallback function |
| void onSetMode | -( | -ModeCallback | -cb | ) | -- |
Set callback function for setMode request.
| cb | Function pointer to a ModeCallback function |
| bool sendModeEvent | -( | -String | -instance, | -
| - | - | String | -mode, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setMode event to SinricPro Server indicating the mode on a specific instance has changed.
| instance | String instance name |
| mode | String with actual mode device is set to - MOVIE, MUSIC, NIGHT, SPORT, TV |
| cause | (optional) String reason why event is sent (default = FSTR_SINRICPRO_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 sendModeEvent | -( | -String | -mode, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setMode event to SinricPro Server indicating the mode has changed.
| mode | String with actual mode device is set to - MOVIE, MUSIC, NIGHT, SPORT, TV |
| cause | (optional) String reason why event is sent (default = FSTR_SINRICPRO_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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for MotionSensor< T >, including all inherited members.
-| sendMotionEvent(bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | MotionSensor< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| bool | sendMotionEvent (bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
| Sending motion detection state to SinricPro server. More... | |
| bool sendMotionEvent | -( | -bool | -detected, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Sending motion detection state to SinricPro server.
-| detected | bool true if motion has been detected - 'false' if no motion has been detected |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for MuteController< T >, including all inherited members.
-| onMute(MuteCallback cb) | MuteController< T > | |
| sendMuteEvent(bool mute, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | MuteController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onMute (MuteCallback cb) |
Set callback function for setMute request. More... | |
| bool | sendMuteEvent (bool mute, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMute event to SinricPro Server indicating actual mute state. More... | |
| void onMute | -( | -MuteCallback | -cb | ) | -- |
Set callback function for setMute request.
| cb | Function pointer to a MuteCallback function |
| bool sendMuteEvent | -( | -bool | -mute, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setMute event to SinricPro Server indicating actual mute state.
| mute | true = device is muted on - false = device is unmuted |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for PercentageController< T >, including all inherited members.
-| onAdjustPercentage(AdjustPercentageCallback cb) | PercentageController< T > | |
| onSetPercentage(SetPercentageCallback cb) | PercentageController< T > | |
| sendSetPercentageEvent(int percentage, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PercentageController< T > |
|
- SinricPro Library
-
- |
-
PercentageController. - More...
--Public Member Functions | |
| void | onSetPercentage (SetPercentageCallback cb) |
Set callback function for setPercentage request. More... | |
| void | onAdjustPercentage (AdjustPercentageCallback cb) |
Set callback function for adjustPercentage request. More... | |
| bool | sendSetPercentageEvent (int percentage, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPercentage event to SinricPro Server indicating actual percentage has changed. More... | |
| void onAdjustPercentage | -( | -AdjustPercentageCallback | -cb | ) | -- |
Set callback function for adjustPercentage request.
| cb | Function pointer to a AdjustPercentageCallback function |
| void onSetPercentage | -( | -SetPercentageCallback | -cb | ) | -- |
Set callback function for setPercentage request.
| cb | Function pointer to a SetPercentageCallback function |
| bool sendSetPercentageEvent | -( | -int | -percentage, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setPercentage event to SinricPro Server indicating actual percentage has changed.
| percentage | Integer reporting the percentage that the device have been set to |
| cause | (optional) 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for PowerLevelController< T >, including all inherited members.
-| onAdjustPowerLevel(AdjustPowerLevelCallback cb) | PowerLevelController< T > | |
| onPowerLevel(SetPowerLevelCallback cb) | PowerLevelController< T > | |
| sendPowerLevelEvent(int powerLevel, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerLevelController< T > |
|
- SinricPro Library
-
- |
-
PowerLevelController. - More...
-
-Public Member Functions | |
| void | onPowerLevel (SetPowerLevelCallback cb) |
| Set callback function for setPowerLevel request. More... | |
| void | onAdjustPowerLevel (AdjustPowerLevelCallback cb) |
| Set callback function for adjustPowerLevel request. More... | |
| bool | sendPowerLevelEvent (int powerLevel, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerLevel event to SinricPro Server indicating actual power level. More... | |
| void onAdjustPowerLevel | -( | -AdjustPowerLevelCallback | -cb | ) | -- |
Set callback function for adjustPowerLevel request.
-| cb | Function pointer to a AdjustPowerLevelCallback function |
| void onPowerLevel | -( | -SetPowerLevelCallback | -cb | ) | -- |
Set callback function for setPowerLevel request.
-| cb | Function pointer to a SetPowerLevelCallback function |
| bool sendPowerLevelEvent | -( | -int | -powerLevel, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setPowerLevel event to SinricPro Server indicating actual power level.
| powerLevel | integer 0..100 report the powerlevel that the device have been set to |
| cause | (optional) 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for PowerSensor< T >, including all inherited members.
-| sendPowerSensorEvent(float voltage, float current, float power=-1.0f, float apparentPower=-1.0f, float reactivePower=-1.0f, float factor=-1.0f, String cause=FSTR_SINRICPRO_PERIODIC_POLL) | PowerSensor< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| bool | sendPowerSensorEvent (float voltage, float current, float power=-1.0f, float apparentPower=-1.0f, float reactivePower=-1.0f, float factor=-1.0f, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
| Send PowerSensor event to SinricPro Server. More... | |
| bool sendPowerSensorEvent | -( | -float | -voltage, | -
| - | - | float | -current, | -
| - | - | float | -power = -1.0f, |
-
| - | - | float | -apparentPower = -1.0f, |
-
| - | - | float | -reactivePower = -1.0f, |
-
| - | - | float | -factor = -1.0f, |
-
| - | - | String | -cause = FSTR_SINRICPRO_PERIODIC_POLL |
-
| - | ) | -- |
Send PowerSensor event to SinricPro Server.
-| voltage | float voltage |
| current | float current |
| power | float (optional) if not provided, it is calculated automaticly (power = voltage * current) |
| apparentPower | float (optional) if not provided it is set to -1 |
| reactivePower | float (optional) if not provided it is set to -1 |
| factor | float (optional) if not provided it is set to -1 - if apparentPower is provided, factor is calculated automaticly (factor = power / apparentPower) |
| cause | String (optional) Reason why event is sent (default = "PERIODIC_POLL") |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for PowerStateController< T >, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< T > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< T > |
|
- SinricPro Library
-
- |
-
PowerStateController. - More...
-
-Public Member Functions | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| void onPowerState | -( | -PowerStateCallback | -cb | ) | -- |
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
| bool sendPowerStateEvent | -( | -bool | -state, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for PushNotification< T >, including all inherited members.
-| sendPushNotification(String notification) | PushNotification< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| bool sendPushNotification | -( | -String | -notification | ) | -- |
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for RangeController< T >, including all inherited members.
-| onAdjustRangeValue(AdjustRangeValueCallback cb) | RangeController< T > | |
| onRangeValue(SetRangeValueCallback cb) | RangeController< T > | |
| onRangeValue(const String &instance, GenericSetRangeValueCallback_int cb) | RangeController< T > | |
| sendRangeValueEvent(int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | RangeController< T > | |
| sendRangeValueEvent(const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | RangeController< T > |
|
- SinricPro Library
-
- |
-
RangeControllerFloatInt. - More...
-
-Public Member Functions | |
| void | onRangeValue (SetRangeValueCallback cb) |
Set callback function for setRangeValue request. More... | |
| void | onRangeValue (const String &instance, GenericSetRangeValueCallback_int 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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server. More... | |
| bool | sendRangeValueEvent (const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server for a specific instance (custom device) More... | |
RangeControllerFloatInt.
-| void onAdjustRangeValue | -( | -AdjustRangeValueCallback | -cb | ) | -- |
Set callback function for adjustRangeValue request.
| cb | Function pointer to a AdjustRangeValueCallback function |
| void onRangeValue | -( | -const String & | -instance, | -
| - | - | GenericSetRangeValueCallback_int | -cb | -
| - | ) | -- |
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 |
| void onRangeValue | -( | -SetRangeValueCallback | -cb | ) | -- |
Set callback function for setRangeValue request.
| cb | Function pointer to a SetRangeValueCallback function |
| bool sendRangeValueEvent | -( | -const String & | -instance, | -
| - | - | int | -rangeValue, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
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 |
| bool sendRangeValueEvent | -( | -int | -rangeValue, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProAirQualitySensor, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProAirQualitySensor > | |
| sendAirQualityEvent(int pm1=0, int pm2_5=0, int pm10=0, String cause=FSTR_SINRICPRO_PERIODIC_POLL) | AirQualitySensor< SinricProAirQualitySensor > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProAirQualitySensor > | |
| sendPushNotification(String notification) | PushNotification< SinricProAirQualitySensor > |
|
- SinricPro Library
-
- |
-
Device to report air quality events. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| bool | sendAirQualityEvent (int pm1=0, int pm2_5=0, int pm10=0, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
| Sending air quality to SinricPro server. More... | |
Device to report air quality events.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Sending air quality to SinricPro server.
-| pm1 | int 1.0 μm particle pollutant in μg/m3 |
| pm2_5 | int 2.5 μm particle pollutant in μg/m3 |
| pm10 | int 10 μm particle pollutant in μg/m3 |
| cause | (optional) String reason why event is sent (default = "PERIODIC_POLL") |
| 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProBlinds, including all inherited members.
-| onAdjustRangeValue(AdjustRangeValueCallback cb) | RangeController< SinricProBlinds > | |
| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProBlinds > | |
| onRangeValue(SetRangeValueCallback cb) | RangeController< SinricProBlinds > | |
| onRangeValue(const String &instance, GenericSetRangeValueCallback_int cb) | RangeController< SinricProBlinds > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProBlinds > | |
| sendPushNotification(String notification) | PushNotification< SinricProBlinds > | |
| sendRangeValueEvent(int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | RangeController< SinricProBlinds > | |
| sendRangeValueEvent(const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | RangeController< SinricProBlinds > |
|
- SinricPro Library
-
- |
-
Device to control interior blinds. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_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_int 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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server. More... | |
| bool | sendRangeValueEvent (const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server for a specific instance (custom device) More... | |
Device to control interior blinds.
-Supporting
-
|
- -inherited | -
Set callback function for adjustRangeValue request.
| cb | Function pointer to a AdjustRangeValueCallback 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 | -
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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProCamera, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProCamera > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProCamera > | |
| sendPushNotification(String notification) | PushNotification< SinricProCamera > |
|
- SinricPro Library
-
- |
-
Camera suporting basic on / off command. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
Camera suporting basic on / off command.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProClass, including all inherited members.
-| begin(String appKey, String appSecret, String serverURL="ws.sinric.pro") | SinricProClass | |
| getTimestamp() override | SinricProClass | |
| handle() | SinricProClass | |
| onConnected(ConnectedCallbackHandler cb) | SinricProClass | |
| onDisconnected(DisconnectedCallbackHandler cb) | SinricProClass | |
| operator[](const String deviceId) | SinricProClass | |
| restoreDeviceStates(bool flag) | SinricProClass |
|
- SinricPro Library
-
- |
-
The main class of this library, handling communication between SinricPro Server and your devices. - More...
- -Inherits SinricProInterface.
--Public Member Functions | |
| void | begin (String appKey, String appSecret, String serverURL="ws.sinric.pro") |
| Initializing SinricProClass to be able to connect to SinricPro Server. More... | |
| void | handle () |
| Handles communication between device and SinricPro Server. More... | |
| void | onConnected (ConnectedCallbackHandler cb) |
| Set callback function for websocket connected event. More... | |
| void | onDisconnected (DisconnectedCallbackHandler cb) |
| Set callback function for websocket disconnected event. More... | |
| void | restoreDeviceStates (bool flag) |
| Enable / disable restore device states function. More... | |
| unsigned long | getTimestamp () override |
| Get the current timestamp. More... | |
| proxy | operator[] (const String deviceId) |
| operator[] is used tor create a new device instance or get an existing device instance More... | |
The main class of this library, handling communication between SinricPro Server and your devices.
-| void begin | -( | -String | -appKey, | -
| - | - | String | -appSecret, | -
| - | - | String | -serverURL = "ws.sinric.pro" |
-
| - | ) | -- |
Initializing SinricProClass to be able to connect to SinricPro Server.
-| appKey | String containing APP_KEY (see credentials from https://sinric.pro ) |
| appSecret | String containing APP_SECRET (see credentials from https:://sinric.pro) |
| serverURL | String containing SinricPro Server URL (default="ws.sinric.pro") |
-
|
- -override | -
Get the current timestamp.
-| void handle | -( | -) | -- |
Handles communication between device and SinricPro Server.
-This is the absolute main function which handles communication between your device and SinricPro Server.
-It is responsible for connect, disconnect to SinricPro Server, handling requests, responses and events.
-This function has to be called as often as possible. So it must be called in your main loop() function!
- For proper function, begin() must be called with valid values for 'APP_KEY' and 'APP_SECRET'
-
| void onConnected | -( | -ConnectedCallbackHandler | -cb | ) | -- |
Set callback function for websocket connected event.
-| cb | Function pointer to a ConnectedCallbackHandler function |
| void onDisconnected | -( | -DisconnectedCallbackHandler | -cb | ) | -- |
Set callback function for websocket disconnected event.
-| cb | Function pointer to a DisconnectedCallbackHandler function |
| SinricProClass::proxy operator[] | -( | -const String | -deviceId | ) | -- |
operator[] is used tor create a new device instance or get an existing device instance
-If the device is unknown to SinricProClass it will create a new device instance
| deviceId | a String containing deviceId for device that have to been created or retreived |
<DeviceType> &reference = SinricPro[<DEVICE_ID>];
| void restoreDeviceStates | -( | -bool | -flag | ) | -- |
Enable / disable restore device states function.
-If this flag is enabled (true), SinricProServer will send last known device states to your device directly after connection to SinricPro server has been established.
- For every state the corresponding callback (like onPowerState) will be called
-This is useful after a power failure / reboot of your device.
| flag | true = enabled - false= disabled |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProContactsensor, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProContactsensor > | |
| sendContactEvent(bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ContactSensor< SinricProContactsensor > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProContactsensor > | |
| sendPushNotification(String notification) | PushNotification< SinricProContactsensor > |
|
- SinricPro Library
-
- |
-
Device to report contact sensor events. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| bool | sendContactEvent (bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setContactState event to SinricPro Server indicating actual power state. More... | |
Device to report contact sensor events.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Send setContactState event to SinricPro Server indicating actual power state.
| detected | [in] booltrue = contact is closed - [in] false = contact is open |
| cause | [in] 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProDevice, including all inherited members.
-|
- SinricPro Library
-
- |
-
Base class for all device types. - More...
-
Base class for all device types.
-Supporting base functions which needed by all device types to work with SinricProClass
-Implements basic on/off functions like onPowerState and sendPowerStateEvent
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProDimSwitch, including all inherited members.
-| onAdjustPowerLevel(AdjustPowerLevelCallback cb) | PowerLevelController< SinricProDimSwitch > | |
| onPowerLevel(SetPowerLevelCallback cb) | PowerLevelController< SinricProDimSwitch > | |
| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProDimSwitch > | |
| sendPowerLevelEvent(int powerLevel, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerLevelController< SinricProDimSwitch > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProDimSwitch > | |
| sendPushNotification(String notification) | PushNotification< SinricProDimSwitch > |
|
- SinricPro Library
-
- |
-
Device which supports on / off and dimming commands. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| void | onPowerLevel (SetPowerLevelCallback cb) |
| Set callback function for setPowerLevel request. More... | |
| void | onAdjustPowerLevel (AdjustPowerLevelCallback cb) |
| Set callback function for adjustPowerLevel request. More... | |
| bool | sendPowerLevelEvent (int powerLevel, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerLevel event to SinricPro Server indicating actual power level. More... | |
Device which supports on / off and dimming commands.
-
-
|
- -inherited | -
Set callback function for adjustPowerLevel request.
-| cb | Function pointer to a AdjustPowerLevelCallback function |
-
|
- -inherited | -
Set callback function for setPowerLevel request.
-| cb | Function pointer to a SetPowerLevelCallback function |
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Send setPowerLevel event to SinricPro Server indicating actual power level.
| powerLevel | integer 0..100 report the powerlevel that the device have been set to |
| cause | (optional) 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProDoorbell, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProDoorbell > | |
| sendDoorbellEvent(String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | Doorbell< SinricProDoorbell > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProDoorbell > | |
| sendPushNotification(String notification) | PushNotification< SinricProDoorbell > |
|
- SinricPro Library
-
- |
-
Device to report doorbell events. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| bool | sendDoorbellEvent (String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
| Send Doorbell event to SinricPro Server indicating someone pressed the doorbell button. More... | |
Device to report doorbell events.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Send Doorbell event to SinricPro Server indicating someone pressed the doorbell button.
-| cause | String (optional) 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProFan, including all inherited members.
-| onAdjustPowerLevel(AdjustPowerLevelCallback cb) | PowerLevelController< SinricProFan > | |
| onPowerLevel(SetPowerLevelCallback cb) | PowerLevelController< SinricProFan > | |
| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProFan > | |
| sendPowerLevelEvent(int powerLevel, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerLevelController< SinricProFan > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProFan > | |
| sendPushNotification(String notification) | PushNotification< SinricProFan > |
|
- SinricPro Library
-
- |
-
Device to turn on / off a fan and change it's speed by using powerlevel. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| void | onPowerLevel (SetPowerLevelCallback cb) |
| Set callback function for setPowerLevel request. More... | |
| void | onAdjustPowerLevel (AdjustPowerLevelCallback cb) |
| Set callback function for adjustPowerLevel request. More... | |
| bool | sendPowerLevelEvent (int powerLevel, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerLevel event to SinricPro Server indicating actual power level. More... | |
Device to turn on / off a fan and change it's speed by using powerlevel.
-
-
|
- -inherited | -
Set callback function for adjustPowerLevel request.
-| cb | Function pointer to a AdjustPowerLevelCallback function |
-
|
- -inherited | -
Set callback function for setPowerLevel request.
-| cb | Function pointer to a SetPowerLevelCallback function |
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Send setPowerLevel event to SinricPro Server indicating actual power level.
| powerLevel | integer 0..100 report the powerlevel that the device have been set to |
| cause | (optional) 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProFanUS, including all inherited members.
-| onAdjustRangeValue(AdjustRangeValueCallback cb) | RangeController< SinricProFanUS > | |
| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProFanUS > | |
| onRangeValue(SetRangeValueCallback cb) | RangeController< SinricProFanUS > | |
| onRangeValue(const String &instance, GenericSetRangeValueCallback_int cb) | RangeController< SinricProFanUS > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProFanUS > | |
| sendPushNotification(String notification) | PushNotification< SinricProFanUS > | |
| sendRangeValueEvent(int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | RangeController< SinricProFanUS > | |
| sendRangeValueEvent(const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | RangeController< SinricProFanUS > |
|
- SinricPro Library
-
- |
-
Device to control a fan with on / off commands and its speed by a range value. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_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_int 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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server. More... | |
| bool | sendRangeValueEvent (const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server for a specific instance (custom device) More... | |
Device to control a fan with on / off commands and its speed by a range value.
-
-
|
- -inherited | -
Set callback function for adjustRangeValue request.
| cb | Function pointer to a AdjustRangeValueCallback 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 | -
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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProGarageDoor, including all inherited members.
-| onDoorState(DoorCallback cb) | DoorController< SinricProGarageDoor > | |
| sendDoorStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | DoorController< SinricProGarageDoor > | |
| sendPushNotification(String notification) | PushNotification< SinricProGarageDoor > |
|
- SinricPro Library
-
- |
-
Device to control a garage door. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onDoorState (DoorCallback cb) |
Set callback function for onDoorState request. More... | |
| bool | sendDoorStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send DoorState event to update actual door state on SinricPro Server. More... | |
Device to control a garage door.
-Supporting
-
|
- -inherited | -
Set callback function for onDoorState request.
| cb | Function pointer to a onDoorState function |
-
|
- -inherited | -
Send DoorState event to update actual door state on SinricPro Server.
| state | bool true = close - false = open |
| 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProLight, including all inherited members.
-|
- SinricPro Library
-
- |
-
Device to control a light. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| void | onBrightness (BrightnessCallback cb) |
Set callback function for setBrightness request. More... | |
| void | onAdjustBrightness (AdjustBrightnessCallback cb) |
Set callback function for adjustBrightness request. More... | |
| bool | sendBrightnessEvent (int brightness, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setBrightness event to SinricPro Server indicating actual brightness. More... | |
| void | onColor (ColorCallback cb) |
Set callback function for setColor request. More... | |
| bool | sendColorEvent (byte r, byte g, byte b, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setColor event to SinricPro Server indicating actual color. More... | |
| void | onColorTemperature (ColorTemperatureCallback cb) |
Set callback function for setColorTemperature request. More... | |
| void | onIncreaseColorTemperature (IncreaseColorTemperatureCallback cb) |
Set callback function for increaseColorTemperature request. More... | |
| void | onDecreaseColorTemperature (DecreaseColorTemperatureCallback cb) |
Set callback function for decreaseColorTemperature request. More... | |
| bool | sendColorTemperatureEvent (int colorTemperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setColorTemperature event to SinricPro Server indicating actual color temperature. More... | |
Device to control a light.
-Supporting
-
|
- -inherited | -
Set callback function for adjustBrightness request.
| cb | Function pointer to a AdjustBrightnessCallback function |
-
|
- -inherited | -
Set callback function for setBrightness request.
| cb | Function pointer to a BrightnessCallback function |
-
|
- -inherited | -
Set callback function for setColor request.
| cb | Function pointer to a ColorCallback function |
-
|
- -inherited | -
Set callback function for setColorTemperature request.
| cb | Function pointer to a ColorTemperatureCallback function |
-
|
- -inherited | -
Set callback function for decreaseColorTemperature request.
| cb | Function pointer to a DecreaseColorTemperatureCallback function |
-
|
- -inherited | -
Set callback function for increaseColorTemperature request.
| cb | Function pointer to a IncreaseColorTemperatureCallback function |
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Send setBrightness event to SinricPro Server indicating actual brightness.
| brightness | Integer value with actual brightness 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 setColor event to SinricPro Server indicating actual color.
| r | Byte value for red |
| g | Byte value for green |
| b | Byte value for blue |
| 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 setColorTemperature event to SinricPro Server indicating actual color temperature.
| colorTemperature | Integer with new color temperature the device is set to - 2200 = warm white - 2700 = soft white - 4000 = white - 5500 = daylight white - 7000 = cool white |
| 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProLock, including all inherited members.
-| onLockState(LockStateCallback cb) | LockController< SinricProLock > | |
| sendLockStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | LockController< SinricProLock > | |
| sendPushNotification(String notification) | PushNotification< SinricProLock > |
|
- SinricPro Library
-
- |
-
Device to control a smart lock. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onLockState (LockStateCallback cb) |
Set callback function for setLockState request. More... | |
| bool | sendLockStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send lockState event to SinricPro Server indicating actual lock state. More... | |
Device to control a smart lock.
-Supporting
-
|
- -inherited | -
Set callback function for setLockState request.
| cb | Function pointer to a LockStateCallback function |
-
|
- -inherited | -
Send lockState event to SinricPro Server indicating actual lock state.
| state | true = device is locked - false = device is unlocked |
| 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProMotionsensor, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProMotionsensor > | |
| sendMotionEvent(bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | MotionSensor< SinricProMotionsensor > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProMotionsensor > | |
| sendPushNotification(String notification) | PushNotification< SinricProMotionsensor > |
|
- SinricPro Library
-
- |
-
Device to report motion detection events. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| bool | sendMotionEvent (bool detected, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
| Sending motion detection state to SinricPro server. More... | |
Device to report motion detection events.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Sending motion detection state to SinricPro server.
-| detected | bool true if motion has been detected - 'false' if no motion has been detected |
| 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProPowerSensor, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProPowerSensor > | |
| sendPowerSensorEvent(float voltage, float current, float power=-1.0f, float apparentPower=-1.0f, float reactivePower=-1.0f, float factor=-1.0f, String cause=FSTR_SINRICPRO_PERIODIC_POLL) | PowerSensor< SinricProPowerSensor > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProPowerSensor > | |
| sendPushNotification(String notification) | PushNotification< SinricProPowerSensor > |
|
- SinricPro Library
-
- |
-
Device to report power usage. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| bool | sendPowerSensorEvent (float voltage, float current, float power=-1.0f, float apparentPower=-1.0f, float reactivePower=-1.0f, float factor=-1.0f, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
| Send PowerSensor event to SinricPro Server. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
Device to report power usage.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Send PowerSensor event to SinricPro Server.
-| voltage | float voltage |
| current | float current |
| power | float (optional) if not provided, it is calculated automaticly (power = voltage * current) |
| apparentPower | float (optional) if not provided it is set to -1 |
| reactivePower | float (optional) if not provided it is set to -1 |
| factor | float (optional) if not provided it is set to -1 - if apparentPower is provided, factor is calculated automaticly (factor = power / apparentPower) |
| cause | String (optional) Reason why event is sent (default = "PERIODIC_POLL") |
| 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProSpeaker, including all inherited members.
-|
- SinricPro Library
-
- |
-
Device to control a smart speaker. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| void | onMute (MuteCallback cb) |
Set callback function for setMute request. More... | |
| bool | sendMuteEvent (bool mute, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMute event to SinricPro Server indicating actual mute state. More... | |
| void | onSetVolume (SetVolumeCallback cb) |
Set callback function for setVolume request. More... | |
| void | onAdjustVolume (AdjustVolumeCallback cb) |
Set callback function for adjustVolume request. More... | |
| bool | sendVolumeEvent (int volume, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setVolume event to SinricPro Server indicating actual volume has changed. More... | |
| void | onMediaControl (MediaControlCallback cb) |
Set callback function for mediaControl request. More... | |
| bool | sendMediaControlEvent (String mediaControl, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send mediaControl event to SinricPro Server indicating devices media control state. More... | |
| void | onSelectInput (SelectInputCallback cb) |
Set callback function for selectInput request. More... | |
| bool | sendSelectInputEvent (String intput, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send selectInput event to SinricPro Server to report selected input. More... | |
| void | onSetBands (SetBandsCallback cb) |
Set callback function for setBands request. More... | |
| void | onAdjustBands (AdjustBandsCallback cb) |
Set callback function for adjustBands request. More... | |
| void | onResetBands (ResetBandsCallback cb) |
Set callback function for resetBands request. More... | |
| bool | sendBandsEvent (String bands, int level, String cause="PHYSICAL_INTERACTION") |
Send setBands event to SinricPro Server indicating bands level has changed. More... | |
| void | onSetMode (ModeCallback cb) |
Set callback function for setMode request. More... | |
| void | onSetMode (const String &instance, GenericModeCallback cb) |
Set callback function for setMode request on a specific instance. More... | |
| bool | sendModeEvent (String mode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMode event to SinricPro Server indicating the mode has changed. More... | |
| bool | sendModeEvent (String instance, String mode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMode event to SinricPro Server indicating the mode on a specific instance has changed. More... | |
Device to control a smart speaker.
-Supporting:
-
|
- -inherited | -
Set callback function for adjustBands request.
| cb | Function pointer to a AdjustBandsCallback function |
-
|
- -inherited | -
Set callback function for adjustVolume request.
| cb | Function pointer to a AdjustVolumeCallback function |
-
|
- -inherited | -
Set callback function for mediaControl request.
| cb | Function pointer to a MediaControlCallback function |
-
|
- -inherited | -
Set callback function for setMute request.
| cb | Function pointer to a MuteCallback function |
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Set callback function for resetBands request.
| cb | Function pointer to a ResetBandsCallback function |
-
|
- -inherited | -
Set callback function for selectInput request.
| cb | Function pointer to a SelectInputCallback function |
-
|
- -inherited | -
Set callback function for setBands request.
| cb | Function pointer to a SetBandsCallback function |
-
|
- -inherited | -
Set callback function for setMode request on a specific instance.
| instance | String with instance name |
| cb | Function pointer to a ModeCallback function |
-
|
- -inherited | -
Set callback function for setMode request.
| cb | Function pointer to a ModeCallback function |
-
|
- -inherited | -
Set callback function for setVolume request.
| cb | Function pointer to a SetVolumeCallback function |
-
|
- -inherited | -
Send setBands event to SinricPro Server indicating bands level has changed.
| bands | String which bands has changed - BASS, MIDRANGE, TREBBLE |
| level | Integer with changed bands level |
| 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 mediaControl event to SinricPro Server indicating devices media control state.
| mediaControl | String with actual media control - FastForward, Next, Pause, Play, Previous, Rewind, StartOver, Stop |
| 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 setMode event to SinricPro Server indicating the mode on a specific instance has changed.
| instance | String instance name |
| mode | String with actual mode device is set to - MOVIE, MUSIC, NIGHT, SPORT, TV |
| cause | (optional) String reason why event is sent (default = FSTR_SINRICPRO_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 setMode event to SinricPro Server indicating the mode has changed.
| mode | String with actual mode device is set to - MOVIE, MUSIC, NIGHT, SPORT, TV |
| cause | (optional) String reason why event is sent (default = FSTR_SINRICPRO_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 setMute event to SinricPro Server indicating actual mute state.
| mute | true = device is muted on - false = device is unmuted |
| 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 selectInput event to SinricPro Server to report selected input.
| input | String with actual media control - AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX |
| 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 setVolume event to SinricPro Server indicating actual volume has changed.
| volume | Integer reporting the volume that the device have been set to |
| cause | (optional) 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProSwitch, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProSwitch > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProSwitch > | |
| sendPushNotification(String notification) | PushNotification< SinricProSwitch > |
|
- SinricPro Library
-
- |
-
Device suporting basic on / off command. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
Device suporting basic on / off command.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProTV, including all inherited members.
-|
- SinricPro Library
-
- |
-
Device to control a TV. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| void | onSetVolume (SetVolumeCallback cb) |
Set callback function for setVolume request. More... | |
| void | onAdjustVolume (AdjustVolumeCallback cb) |
Set callback function for adjustVolume request. More... | |
| bool | sendVolumeEvent (int volume, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setVolume event to SinricPro Server indicating actual volume has changed. More... | |
| void | onMute (MuteCallback cb) |
Set callback function for setMute request. More... | |
| bool | sendMuteEvent (bool mute, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setMute event to SinricPro Server indicating actual mute state. More... | |
| void | onMediaControl (MediaControlCallback cb) |
Set callback function for mediaControl request. More... | |
| bool | sendMediaControlEvent (String mediaControl, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send mediaControl event to SinricPro Server indicating devices media control state. More... | |
| void | onSelectInput (SelectInputCallback cb) |
Set callback function for selectInput request. More... | |
| bool | sendSelectInputEvent (String intput, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send selectInput event to SinricPro Server to report selected input. More... | |
| void | onChangeChannel (ChangeChannelCallback cb) |
Set callback function for changeChannel request. More... | |
| void | onChangeChannelNumber (ChangeChannelNumberCallback cb) |
Set callback function for changeChannel request. More... | |
| void | onSkipChannels (SkipChannelsCallback cb) |
Set callback function for skipChannels request. More... | |
| bool | sendChangeChannelEvent (String channelName, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send changeChannel event to SinricPro Server to report selected channel. More... | |
Device to control a TV.
-Supporting:
FastForward, Next, Pause, Play, Previous, Rewind, StartOver, StopAUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX
-
|
- -inherited | -
Set callback function for adjustVolume request.
| cb | Function pointer to a AdjustVolumeCallback function |
-
|
- -inherited | -
Set callback function for changeChannel request.
| cb | Function pointer to a ChangeChannelCallback function |
-
|
- -inherited | -
Set callback function for changeChannel request.
| cb | Function pointer to a ChangeChannelNumberCallback function |
-
|
- -inherited | -
Set callback function for mediaControl request.
| cb | Function pointer to a MediaControlCallback function |
-
|
- -inherited | -
Set callback function for setMute request.
| cb | Function pointer to a MuteCallback function |
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback function |
-
|
- -inherited | -
Set callback function for selectInput request.
| cb | Function pointer to a SelectInputCallback function |
-
|
- -inherited | -
Set callback function for setVolume request.
| cb | Function pointer to a SetVolumeCallback function |
-
|
- -inherited | -
Set callback function for skipChannels request.
| cb | Function pointer to a SkipChannelsCallback function |
-
|
- -inherited | -
Send changeChannel event to SinricPro Server to report selected channel.
| channelName | String with actual channel |
| 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 mediaControl event to SinricPro Server indicating devices media control state.
| mediaControl | String with actual media control - FastForward, Next, Pause, Play, Previous, Rewind, StartOver, Stop |
| 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 setMute event to SinricPro Server indicating actual mute state.
| mute | true = device is muted on - false = device is unmuted |
| 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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 selectInput event to SinricPro Server to report selected input.
| input | String with actual media control - AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX |
| 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 setVolume event to SinricPro Server indicating actual volume has changed.
| volume | Integer reporting the volume that the device have been set to |
| cause | (optional) 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProTemperaturesensor, including all inherited members.
-| onPowerState(PowerStateCallback cb) | PowerStateController< SinricProTemperaturesensor > | |
| sendPowerStateEvent(bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | PowerStateController< SinricProTemperaturesensor > | |
| sendPushNotification(String notification) | PushNotification< SinricProTemperaturesensor > | |
| sendTemperatureEvent(float temperature, float humidity=-1, String cause=FSTR_SINRICPRO_PERIODIC_POLL) | TemperatureSensor< SinricProTemperaturesensor > |
|
- SinricPro Library
-
- |
-
Device to report actual temperature and humidity. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. More... | |
| bool | sendTemperatureEvent (float temperature, float humidity=-1, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
Send currentTemperature event to report actual temperature (measured by a sensor) More... | |
Device to report actual temperature and humidity.
-
-
|
- -inherited | -
Set callback function for powerState request.
| cb | Function pointer to a PowerStateCallback 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 currentTemperature event to report actual temperature (measured by a sensor)
| temperature | float actual temperature measured by a sensor |
| humidity | float (optional) actual humidity measured by a sensor (default=-1.0f means not supported) |
| cause | (optional) String reason why event is sent (default = "PERIODIC_POLL") |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProThermostat, including all inherited members.
-|
- SinricPro Library
-
- |
-
Device to control Thermostat. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setPowerState event to SinricPro Server indicating actual power state. 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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send thermostatMode event to report a the new mode the device has been set to. More... | |
| bool | sendTargetTemperatureEvent (float temperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send targetTemperature event to report target temperature change. More... | |
| bool | sendTemperatureEvent (float temperature, float humidity=-1, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
Send currentTemperature event to report actual temperature (measured by a sensor) More... | |
Device to control Thermostat.
-Support
AUTO, COOL, HEAT
-
|
- -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 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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 currentTemperature event to report actual temperature (measured by a sensor)
| temperature | float actual temperature measured by a sensor |
| humidity | float (optional) actual humidity measured by a sensor (default=-1.0f means not supported) |
| cause | (optional) String reason why event is sent (default = "PERIODIC_POLL") |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for SinricProWindowAC, including all inherited members.
-|
- SinricPro Library
-
- |
-
Device to control Window Air Conditioner. - More...
-
-Public Member Functions | |
| bool | sendPushNotification (String notification) |
| Sending push notifications to SinricPro App. More... | |
| void | onPowerState (PowerStateCallback cb) |
Set callback function for powerState request. More... | |
| bool | sendPowerStateEvent (bool state, String cause=FSTR_SINRICPRO_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_int 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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send rangeValue event to report curent rangeValue to SinricPro server. More... | |
| bool | sendRangeValueEvent (const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send thermostatMode event to report a the new mode the device has been set to. More... | |
| bool | sendTargetTemperatureEvent (float temperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send targetTemperature event to report target temperature change. More... | |
Device to control Window Air Conditioner.
-Support
AUTO, COOL, HEAT
-
|
- -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 | -
Sending push notifications to SinricPro App.
-| notification | String with the notification |
| 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for TemperatureSensor< T >, including all inherited members.
-| sendTemperatureEvent(float temperature, float humidity=-1, String cause=FSTR_SINRICPRO_PERIODIC_POLL) | TemperatureSensor< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| bool | sendTemperatureEvent (float temperature, float humidity=-1, String cause=FSTR_SINRICPRO_PERIODIC_POLL) |
Send currentTemperature event to report actual temperature (measured by a sensor) More... | |
| bool sendTemperatureEvent | -( | -float | -temperature, | -
| - | - | float | -humidity = -1, |
-
| - | - | String | -cause = FSTR_SINRICPRO_PERIODIC_POLL |
-
| - | ) | -- |
Send currentTemperature event to report actual temperature (measured by a sensor)
| temperature | float actual temperature measured by a sensor |
| humidity | float (optional) actual humidity measured by a sensor (default=-1.0f means not supported) |
| cause | (optional) String reason why event is sent (default = "PERIODIC_POLL") |
| true | event has been sent successfully |
| false | event has not been sent, maybe you sent to much events in a short distance of time |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ThermostatController< T >, including all inherited members.
-| onAdjustTargetTemperature(AdjustTargetTemperatureCallback cb) | ThermostatController< T > | |
| onTargetTemperature(SetTargetTemperatureCallback cb) | ThermostatController< T > | |
| onThermostatMode(ThermostatModeCallback cb) | ThermostatController< T > | |
| sendTargetTemperatureEvent(float temperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ThermostatController< T > | |
| sendThermostatModeEvent(String thermostatMode, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ThermostatController< T > |
|
- SinricPro Library
-
- |
-
ThermostatController. - More...
-
-Public Member Functions | |
| 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=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send thermostatMode event to report a the new mode the device has been set to. More... | |
| bool | sendTargetTemperatureEvent (float temperature, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send targetTemperature event to report target temperature change. More... | |
| void onAdjustTargetTemperature | -( | -AdjustTargetTemperatureCallback | -cb | ) | -- |
Set callback function for adjustTargetTemperature request.
| cb | Function pointer to a AdjustTargetTemperatureCallback function |
| void onTargetTemperature | -( | -SetTargetTemperatureCallback | -cb | ) | -- |
Set callback function for targetTemperature request.
| cb | Function pointer to a SetTargetTemperatureCallback function |
| void onThermostatMode | -( | -ThermostatModeCallback | -cb | ) | -- |
Set callback function for setThermostatMode request.
| cb | Function pointer to a ThermostatModeCallback function |
| bool sendTargetTemperatureEvent | -( | -float | -temperature, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
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 |
| bool sendThermostatModeEvent | -( | -String | -thermostatMode, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for ToggleController< T >, including all inherited members.
-| onToggleState(const String &instance, GenericToggleStateCallback cb) | ToggleController< T > | |
| sendToggleStateEvent(const String &instance, bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | ToggleController< T > |
|
- SinricPro Library
-
- |
-
-Public Member Functions | |
| void | onToggleState (const String &instance, GenericToggleStateCallback cb) |
Set callback function for toggleState request. More... | |
| bool | sendToggleStateEvent (const String &instance, bool state, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setToggleState event to SinricPro Server indicating actual toggle state. More... | |
| void onToggleState | -( | -const String & | -instance, | -
| - | - | GenericToggleStateCallback | -cb | -
| - | ) | -- |
Set callback function for toggleState request.
| instance | String instance name (custom device) |
| cb | Function pointer to a ToggleStateCallback function |
| bool sendToggleStateEvent | -( | -const String & | -instance, | -
| - | - | bool | -state, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setToggleState event to SinricPro Server indicating actual toggle state.
| instance | String instance name (custom device) |
| state | true = state turned on - false = tate 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 |
|
- SinricPro Library
-
- |
-
This is the complete list of members for VolumeController< T >, including all inherited members.
-| onAdjustVolume(AdjustVolumeCallback cb) | VolumeController< T > | |
| onSetVolume(SetVolumeCallback cb) | VolumeController< T > | |
| sendVolumeEvent(int volume, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) | VolumeController< T > |
|
- SinricPro Library
-
- |
-

-Public Member Functions | |
| void | onSetVolume (SetVolumeCallback cb) |
Set callback function for setVolume request. More... | |
| void | onAdjustVolume (AdjustVolumeCallback cb) |
Set callback function for adjustVolume request. More... | |
| bool | sendVolumeEvent (int volume, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION) |
Send setVolume event to SinricPro Server indicating actual volume has changed. More... | |
| void onAdjustVolume | -( | -AdjustVolumeCallback | -cb | ) | -- |
Set callback function for adjustVolume request.
| cb | Function pointer to a AdjustVolumeCallback function |
| void onSetVolume | -( | -SetVolumeCallback | -cb | ) | -- |
Set callback function for setVolume request.
| cb | Function pointer to a SetVolumeCallback function |
| bool sendVolumeEvent | -( | -int | -volume, | -
| - | - | String | -cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION |
-
| - | ) | -- |
Send setVolume event to SinricPro Server indicating actual volume has changed.
| volume | Integer reporting the volume that the device have been set to |
| cause | (optional) 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 |
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-
This page explains how to interpret the graphs that are generated by doxygen.
-Consider the following example:
This will result in the following graph:
-
The boxes in the above graph have the following meaning:
-The arrows have the following meaning:
-|
- SinricPro Library
-
- |
-
|
- SinricPro Library
-
- |
-


ArduinoJson by Benoit Blanchon (minimum Version 6.12.0)
- WebSockets by Markus Sattler (minimum Version 2.3.5)
Please see here for full user documentation
-See examples on GitHub
-Syntax is
-
Example
-
Example 2 (alternatively)
Syntax is
-
Example 1
Example 2 (alternatively)
|
- SinricPro Library
-
- |
-
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
-
- |
|
- SinricPro Library
-
- |
-
SinricPro namespace. -More...
--Classes | |
| class | SinricProClass |
| The main class of this library, handling communication between SinricPro Server and your devices. More... | |
| class | SinricProAirQualitySensor |
| Device to report air quality events. More... | |
| class | SinricProBlinds |
| Device to control interior blinds. More... | |
| class | SinricProCamera |
| Camera suporting basic on / off command. More... | |
| class | SinricProContactsensor |
| Device to report contact sensor events. More... | |
| class | SinricProDevice |
| Base class for all device types. More... | |
| class | SinricProDimSwitch |
| Device which supports on / off and dimming commands. More... | |
| class | SinricProDoorbell |
| Device to report doorbell events. More... | |
| class | SinricProFan |
| Device to turn on / off a fan and change it's speed by using powerlevel. More... | |
| class | SinricProFanUS |
| Device to control a fan with on / off commands and its speed by a range value. More... | |
| class | SinricProGarageDoor |
| Device to control a garage door. More... | |
| class | SinricProLight |
| Device to control a light. More... | |
| class | SinricProLock |
| Device to control a smart lock. More... | |
| class | SinricProMotionsensor |
| Device to report motion detection events. More... | |
| class | SinricProPowerSensor |
| Device to report power usage. More... | |
| class | SinricProSpeaker |
| Device to control a smart speaker. More... | |
| class | SinricProSwitch |
| Device suporting basic on / off command. More... | |
| class | SinricProTemperaturesensor |
| Device to report actual temperature and humidity. More... | |
| class | SinricProThermostat |
| Device to control Thermostat. More... | |
| class | SinricProTV |
| Device to control a TV. More... | |
| class | SinricProWindowAC |
| Device to control Window Air Conditioner. More... | |
| class | AirQualitySensor |
| AirQuality. More... | |
| class | BrightnessController |
| BrightnessController. More... | |
| class | ChannelController |
| ChannelController. More... | |
| class | ColorController |
| ColorController. More... | |
| class | ColorTemperatureController |
| ColorTemperatureController. More... | |
| class | ContactSensor |
| ContactSensor. More... | |
| class | Doorbell |
| Dorbell. More... | |
| class | DoorController |
| DoorController - only used for GarageDoor device and cannot used as capability for a custom device! More... | |
| class | EqualizerController |
| EqualizerController. More... | |
| class | InputController |
| InputController. More... | |
| class | KeypadController |
| KeypadController. More... | |
| class | LockController |
| LockController. More... | |
| class | MediaController |
| MediaController. More... | |
| class | ModeController |
| ModeController. More... | |
| class | MotionSensor |
| MotionSensor. More... | |
| class | MuteController |
| MuteController. More... | |
| class | PercentageController |
| PercentageController. More... | |
| class | PowerLevelController |
| PowerLevelController. More... | |
| class | PowerSensor |
| PowerSensor. More... | |
| class | PowerStateController |
| PowerStateController. More... | |
| class | PushNotification |
| PushNotification. More... | |
| class | RangeController |
| RangeControllerFloatInt. More... | |
| class | TemperatureSensor |
| TemperatureSensor. More... | |
| class | ThermostatController |
| ThermostatController. More... | |
| class | ToggleController |
| ToggleController. More... | |
| class | VolumeController |
| VolumeController. More... | |
-Typedefs | |
| using | ConnectedCallbackHandler = std::function< void(void)> |
| Callback definition for onConnected function. More... | |
| using | DisconnectedCallbackHandler = std::function< void(void)> |
| Callback definition for onDisconnected function. More... | |
| using | BrightnessCallback = std::function< bool(const String &, int &)> |
| Callback definition for onBrightness function. More... | |
| using | AdjustBrightnessCallback = std::function< bool(const String &, int &)> |
| Callback definition for onAdjustBrightness function. More... | |
| using | ChangeChannelCallback = std::function< bool(const String &, String &)> |
| Callback definition for onChangeChannel function. More... | |
| using | ChangeChannelNumberCallback = std::function< bool(const String &, int, String &)> |
| Callback definition for onChangeChannelNumber function. More... | |
| using | SkipChannelsCallback = std::function< bool(const String &, int, String &)> |
| Callback definition for onSkipChannels function. More... | |
| using | ColorCallback = std::function< bool(const String &, byte &, byte &, byte &)> |
| Callback definition for onColor function. More... | |
| using | ColorTemperatureCallback = std::function< bool(const String &, int &)> |
| Callback definition for onColorTemperature function. More... | |
| using | IncreaseColorTemperatureCallback = std::function< bool(const String &, int &)> |
| Callback definition for onIncreaseColorTemperature function. More... | |
| using | DecreaseColorTemperatureCallback = std::function< bool(const String &, int &)> |
| Callback definition for onDecreaseColorTemperature function. More... | |
| using | DoorCallback = std::function< bool(const String &, bool &)> |
| Callback definition for onDoorState function. More... | |
| using | SetBandsCallback = std::function< bool(const String &, const String &, int &)> |
| Callback definition for onSetBands function. More... | |
| using | AdjustBandsCallback = std::function< bool(const String &, const String &, int &)> |
| Callback definition for onAdjustBands function. More... | |
| using | ResetBandsCallback = std::function< bool(const String &, const String &, int &)> |
| Callback definition for onResetBands function. More... | |
| using | SelectInputCallback = std::function< bool(const String &, String &)> |
| Callback definition for onSelectInput function. More... | |
| using | KeystrokeCallback = std::function< bool(const String &, String &)> |
| Callback definition for onKeystroke function. More... | |
| using | LockStateCallback = std::function< bool(const String &, bool &)> |
| Callback definition for onLockState function. More... | |
| using | MediaControlCallback = std::function< bool(const String &, String &)> |
| Callback definition for onMediaControl function. More... | |
| using | ModeCallback = std::function< bool(const String &, String &)> |
| Callback definition for onSetMode function. More... | |
| using | GenericModeCallback = std::function< bool(const String &, const String &, String &)> |
| Callback definition for onSetMode function for a specific instance. More... | |
| using | MuteCallback = std::function< bool(const String &, bool &)> |
| Callback definition for onMute function. More... | |
| using | SetPercentageCallback = std::function< bool(const String &, int &)> |
| Callback definition for onSetPercentage function. More... | |
| using | AdjustPercentageCallback = std::function< bool(const String &, int &)> |
| Callback definition for onAdjustPercentage function. More... | |
| using | SetPowerLevelCallback = std::function< bool(const String &, int &)> |
| Definition for setPowerLevel callback. More... | |
| using | AdjustPowerLevelCallback = std::function< bool(const String &, int &)> |
| Definition for onAdjustPowerLevel callback. More... | |
| using | PowerStateCallback = std::function< bool(const String &, bool &)> |
| Callback definition for onPowerState function. More... | |
| using | GenericRangeValueCallback_int = bool(*)(const String &, const String &, int &) |
| Callback definition for onRangeValue function. More... | |
| using | GenericSetRangeValueCallback_int = GenericRangeValueCallback_int |
| Callback definition for onRangeValue function on a specific instance. More... | |
| using | AdjustRangeValueCallback = bool(*)(const String &, int &) |
| Callback definition for onAdjustRangeValue function. More... | |
| using | GenericAdjustRangeValueCallback_int = GenericRangeValueCallback_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... | |
| using | GenericToggleStateCallback = std::function< bool(const String &, const String &, bool &)> |
| Callback definition for onToggleState function. More... | |
| using | SetVolumeCallback = std::function< bool(const String &, int &)> |
| Callback definition for onSetVolume function. More... | |
| using | AdjustVolumeCallback = std::function< bool(const String &, int &, bool)> |
| Callback definition for onAdjustVolume function. More... | |
SinricPro namespace.
-| using AdjustBandsCallback = std::function<bool(const String &, const String &, int &)> | -
Callback definition for onAdjustBands function.
-Gets called when device receive a adjustBands request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | bands | String with requested bands to change - BASS, MIDRANGE, TREBBLE |
| [in] | levelDelta | Integer with relative level value device should change bands about |
| [out] | bands | String with changed bands - BASS, MIDRANGE, TREBBLE |
| [out] | levelDelta | Integer value with level bands changed to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using AdjustBrightnessCallback = std::function<bool(const String &, int &)> | -
Callback definition for onAdjustBrightness function.
-Gets called when device receive a adjustBrightness request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | brightness | Relative integer value the device should change the brightness about |
| [out] | brightness | Absolute integer value with new brightness the device is set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using AdjustPercentageCallback = std::function<bool(const String &, int &)> | -
Callback definition for onAdjustPercentage function.
-Gets called when device receive a adjustPercentage request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | percentageDelta | Integer with relative percentage the device should change about (-100..100) |
| [out] | percentageDelta | Integer with absolute percentage device has been set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using AdjustPowerLevelCallback = std::function<bool(const String &, int &)> | -
Definition for onAdjustPowerLevel callback.
-Gets called when device receive a adjustPowerLevel reuqest
-
| [in] | deviceId | String which contains the ID of device |
| [in] | powerLevel | integer -100..100 delta value which power level have to be changed |
| [out] | powerLevel | integer 0..100 report the absolute powerlevel that the device have been set to |
| true | request handled properly |
| false | request can`t be handled properly because of some error |
| using AdjustRangeValueCallback = bool (*)(const String &, int &) | -
Callback definition for onAdjustRangeValue function.
-Gets called when device receive a adjustRangeValue reuqest
-
| [in] | deviceId | String which contains the ID of device |
| [in] | rangeValue | delta value for range value have to change |
| [out] | rangeValue | returning the absolute range value |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using AdjustTargetTemperatureCallback = std::function<bool(const String &, float &)> | -
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 |
| using AdjustVolumeCallback = std::function<bool(const String &, int &, bool)> | -
Callback definition for onAdjustVolume function.
-Gets called when device receive a adjustVolume request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | volumeDelta | Integer with relative volume the device should change about (-100..100) |
| [out] | volumeDelta | Integer with absolute volume device has been set to |
| [in] | volumeDefault | Bool false if the user specified the amount by which to change the volume; otherwise true |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using BrightnessCallback = std::function<bool(const String &, int &)> | -
Callback definition for onBrightness function.
-Gets called when device receive a setBrightness request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | brightness | Absolute integer value the device should set its brightness to |
| [out] | brightness | Absolute integer value with new brightness the device is set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ChangeChannelCallback = std::function<bool(const String &, String &)> | -
Callback definition for onChangeChannel function.
-Gets called when device receive a changeChannel request by using channel name
| [in] | deviceId | String which contains the ID of device |
| [in] | channel | String with channel name device is requested to switch to |
| [out] | channel | String with channel name device has switchted to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ChangeChannelNumberCallback = std::function<bool(const String &, int, String &)> | -
Callback definition for onChangeChannelNumber function.
-Gets called when device receive a changeChannel request by using channel number
| [in] | deviceId | String which contains the ID of device |
| [in] | channelNumber | Integer with channel number device is requested to switch to |
| [out] | channelName | String with channel name device has switchted to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ColorCallback = std::function<bool(const String &, byte &, byte &, byte &)> | -
Callback definition for onColor function.
-Gets called when device receive a setColor request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | r | Byte value for red |
| [in] | g | Byte value for green |
| [in] | b | Byte value for blue |
| [out] | r | Byte value for red |
| [out] | g | Byte value for green |
| [out] | b | Byte value for blue |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ColorTemperatureCallback = std::function<bool(const String &, int &)> | -
Callback definition for onColorTemperature function.
-Gets called when device receive a setColorTemperature request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | colorTemperature | Integer value with color temperature the device should set to - 2200 = warm white - 2700 = soft white - 4000 = white - 5500 = daylight white - 7000 = cool white |
| [out] | colorTemperature | Integer value with color temperature the device is set to - 2200 = warm white - 2700 = soft white - 4000 = white - 5500 = daylight white - 7000 = cool white |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ConnectedCallbackHandler = std::function<void(void)> | -
Callback definition for onConnected function.
-Gets called when device is connected to SinricPro server
| void |
| using DecreaseColorTemperatureCallback = std::function<bool(const String &, int &)> | -
Callback definition for onDecreaseColorTemperature function.
-Gets called when device receive a decreaseColorTemperature request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | colorTemperature | Integer value -1 = Device should decrease color temperature |
| [out] | colorTemperature | Integer value return the new color temperarature - 2200 = warm white - 2700 = soft white - 4000 = white - 5500 = daylight white - 7000 = cool white |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using DisconnectedCallbackHandler = std::function<void(void)> | -
Callback definition for onDisconnected function.
-Gets called when device is disconnected from SinricPro server
| void |
| using DoorCallback = std::function<bool(const String &, bool &)> | -
Callback definition for onDoorState function.
-Gets called when device receive a open or close request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | doorState | false = open, device is requested to open the garage door - true = close, device is requested to close the garage door |
| [out] | doorState | bool with actual state false = open, true = closed |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using GenericAdjustRangeValueCallback_int = GenericRangeValueCallback_int | -
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 | delta value for range value have to change |
| [out] | rangeValue | returning the absolute range value |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using GenericModeCallback = std::function<bool(const String &, const String &, String &)> | -
Callback definition for onSetMode function for a specific instance.
-Gets called when device receive a setBands request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | instance | String name of the instance |
| [in] | mode | String device mode should set to |
| [out] | mode | String devices mode is set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using GenericRangeValueCallback_int = bool (*)(const String &, const String &, int &) | -
Callback definition for onRangeValue function.
-Gets called when device receive a setRangeValue reuqest
-
| [in] | deviceId | String which contains the ID of device |
| [in] | rangeValue | for range value device has to be set |
| [out] | rangeValue | returning the current range value |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using GenericSetRangeValueCallback_int = GenericRangeValueCallback_int | -
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 | for range value device has to be set |
| [out] | rangeValue | returning the current range value |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using GenericToggleStateCallback = std::function<bool(const String &, const String&, bool &)> | -
Callback definition for onToggleState function.
-Gets called when device receive a setPowerState reuqest
-
| [in] | deviceId | String which contains the ID of device |
| [in] | instance | String which instance is requested |
| [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 |
| using IncreaseColorTemperatureCallback = std::function<bool(const String &, int &)> | -
Callback definition for onIncreaseColorTemperature function.
-Gets called when device receive a increaseColorTemperature request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | colorTemperature | Integer value 1 = Device should increase color temperature |
| [out] | colorTemperature | Integer value return the new color temperarature - 2200 = warm white - 2700 = soft white - 4000 = white - 5500 = daylight white - 7000 = cool white |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using KeystrokeCallback = std::function<bool(const String &, String &)> | -
Callback definition for onKeystroke function.
-Gets called when device receive a setBands request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | keystroke | String keystroke - INFO, MORE, SELECT, UP, DOWN, LEFT, RIGHT, PAGE_UP, PAGE_DOWN, PAGE_LEFT, PAGE_RIGHT |
| [out] | keystroke | String keystroke - INFO, MORE, SELECT, UP, DOWN, LEFT, RIGHT, PAGE_UP, PAGE_DOWN, PAGE_LEFT, PAGE_RIGHT |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using LockStateCallback = std::function<bool(const String &, bool &)> | -
Callback definition for onLockState function.
-Gets called when device receive a setLockState request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | state | true = device is requested to lock - false = device is requested to unlock |
| [out] | state | true = device has been locked - false = device has been unlocked |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using MediaControlCallback = std::function<bool(const String &, String &)> | -
Callback definition for onMediaControl function.
-Gets called when device receive a mediaControl request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | control | String with requested control - FastForward, Next, Pause, Play, Previous, Rewind, StartOver, Stop |
| [out] | control | String with control - FastForward, Next, Pause, Play, Previous, Rewind, StartOver, Stop |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ModeCallback = std::function<bool(const String &, String &)> | -
Callback definition for onSetMode function.
-Gets called when device receive a setBands request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | mode | String device mode should set to - MOVIE, MUSIC, NIGHT, SPORT, TV |
| [out] | mode | String devices mode is set to - MOVIE, MUSIC, NIGHT, SPORT, TV |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using MuteCallback = std::function<bool(const String &, bool &)> | -
Callback definition for onMute function.
-Gets called when device receive a setMute request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | mute | true mute device - false unmute device |
| [out] | mute | true device is muted - false device is unmuted |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using PowerStateCallback = std::function<bool(const String &, bool &)> | -
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 |
| using ResetBandsCallback = std::function<bool(const String &, const String &, int &)> | -
Callback definition for onResetBands function.
-Gets called when device receive a onResetBands request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | bands | String with requested bands to reset - BASS, MIDRANGE, TREBBLE |
| [out] | bands | String with changed bands - BASS, MIDRANGE, TREBBLE |
| [out] | level | Integer value with level bands changed to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using SelectInputCallback = std::function<bool(const String &, String &)> | -
Callback definition for onSelectInput function.
-Gets called when device receive a selectInput request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | input | String with input name device is requested to switch to - AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX |
| [out] | input | String with input name device has switchted to - AUX 1..AUX 7, BLURAY, CABLE, CD, COAX 1,COAX 2, COMPOSITE 1, DVD, GAME, HD RADIO, HDMI 1.. HDMI 10, HDMI ARC, INPUT 1..INPUT 10, IPOD, LINE 1..LINE 7, MEDIA PLAYER, OPTICAL 1, OPTICAL 2, PHONO, PLAYSTATION, PLAYSTATION 3, PLAYSTATION 4, SATELLITE, SMARTCAST, TUNER, TV, USB DAC, VIDEO 1..VIDEO 3, XBOX |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using SetBandsCallback = std::function<bool(const String &, const String &, int &)> | -
Callback definition for onSetBands function.
-Gets called when device receive a setBands request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | bands | String with requested bands to change - BASS, MIDRANGE, TREBBLE |
| [in] | level | Integer value with level bands should set to |
| [out] | bands | String with changed bands - BASS, MIDRANGE, TREBBLE |
| [out] | level | Integer value with level bands changed to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using SetPercentageCallback = std::function<bool(const String &, int &)> | -
Callback definition for onSetPercentage function.
-Gets called when device receive a setPercentage request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | percentage | Integer with percentage device should set to |
| [out] | percentage | Integer with percentage device has been set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using SetPowerLevelCallback = std::function<bool(const String &, int &)> | -
Definition for setPowerLevel callback.
-Gets called when device receive a setPowerLevel reuqest
-
| [in] | deviceId | String which contains the ID of device |
| [in] | powerLevel | integer 0..100 new powerlevel the device should be set to |
| [out] | powerLevel | integer 0..100 report the powerlevel that the device have been set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using SetTargetTemperatureCallback = std::function<bool(const String &, float &)> | -
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 |
| using SetVolumeCallback = std::function<bool(const String &, int &)> | -
Callback definition for onSetVolume function.
-Gets called when device receive a setVolume request
-
| [in] | deviceId | String which contains the ID of device |
| [in] | volume | Integer with volume device should set to |
| [out] | volume | Integer with volume device has been set to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using SkipChannelsCallback = std::function<bool(const String &, int, String &)> | -
Callback definition for onSkipChannels function.
-Gets called when device receive a changeChannel request by using channel number
| [in] | deviceId | String which contains the ID of device |
| [in] | channelCount | Integer with channels device is requested to skip -n..+n |
| [out] | channelName | String with channel name device has switchted to |
| true | request handled properly |
| false | request was not handled properly because of some error |
| using ThermostatModeCallback = std::function<bool(const String &, String &)> | -
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 |