SinricPro namespace. More...

Classes
class	AirQualitySensor
	AirQuality. More...

class	BrightnessController
	BrightnessController. More...

class	CameraController
	CameraController class for managing camera operations in SinricPro. 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	OpenCloseController
	Controller class for devices with open/close functionalityThis controller handles open/close operations for devices that can be opened or closed by percentage and may supports multiple directions. 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	SinricProAirQualitySensor
	Device to report air quality events. More...

class	SinricProBlinds
	Device to control interior blinds. More...

class	SinricProCamera
	Camera suporting snapshots, motions and on / off commands. More...

class	SinricProClass
	The main class of this library, handling communication between SinricPro Server and your devices. 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	SmartButtonStateController
	Controller class for managing smart button state and interactions. More...

class	StartStopController
	StartStopController class to handle start/stop and pause/unpause functionality. 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.

using	DisconnectedCallbackHandler = std::function< void(void)>
	Callback definition for onDisconnected function.

using	OTAUpdateCallbackHandler = std::function< bool(const String &url, int major, int minor, int patch, bool enforce)>
	Function signature for OTA update callback.

using	SetSettingCallbackHandler = std::function< bool(const String &id, const String &value)>
	Function signature for setting a module setting.

using	ReportHealthCallbackHandler = std::function< bool(String &healthReport)>
	Defines a function type for reporting device health status.

using	BrightnessCallback = std::function< bool(const String &, int &)>
	Callback definition for onBrightness function.

using	AdjustBrightnessCallback = std::function< bool(const String &, int &)>
	Callback definition for onAdjustBrightness function.

using	ChangeChannelCallback = std::function< bool(const String &, String &)>
	Callback definition for onChangeChannel function.

using	ChangeChannelNumberCallback = std::function< bool(const String &, int, String &)>
	Callback definition for onChangeChannelNumber function.

using	SkipChannelsCallback = std::function< bool(const String &, int, String &)>
	Callback definition for onSkipChannels function.

using	ColorCallback = std::function< bool(const String &, byte &, byte &, byte &)>
	Callback definition for onColor function.

using	ColorTemperatureCallback = std::function< bool(const String &, int &)>
	Callback definition for onColorTemperature function.

using	IncreaseColorTemperatureCallback = std::function< bool(const String &, int &)>
	Callback definition for onIncreaseColorTemperature function.

using	DecreaseColorTemperatureCallback = std::function< bool(const String &, int &)>
	Callback definition for onDecreaseColorTemperature function.

using	DoorCallback = std::function< bool(const String &, bool &)>
	Callback definition for onDoorState function.

using	SetBandsCallback = std::function< bool(const String &, const String &, int &)>
	Callback definition for onSetBands function.

using	AdjustBandsCallback = std::function< bool(const String &, const String &, int &)>
	Callback definition for onAdjustBands function.

using	ResetBandsCallback = std::function< bool(const String &, const String &, int &)>
	Callback definition for onResetBands function.

using	SelectInputCallback = std::function< bool(const String &, String &)>
	Callback definition for onSelectInput function.

using	KeystrokeCallback = std::function< bool(const String &, String &)>
	Callback definition for onKeystroke function.

using	LockStateCallback = std::function< bool(const String &, bool &)>
	Callback definition for onLockState function.

using	MediaControlCallback = std::function< bool(const String &, String &)>
	Callback definition for onMediaControl function.

using	ModeCallback = std::function< bool(const String &, String &)>
	Callback definition for onSetMode function.

using	GenericModeCallback = std::function< bool(const String &, const String &, String &)>
	Callback definition for onSetMode function for a specific instance.

using	MuteCallback = std::function< bool(const String &, bool &)>
	Callback definition for onMute function.

using	OpenCloseCallback = std::function< bool(const String &, int &)>
	Callback definition for onOpenClose callback.

using	AdjustOpenCloseCallback = std::function< bool(const String &, int &)>
	Callback definition for onAdjustOpenClose callback.

using	DirectionOpenCloseCallback = std::function< bool(const String &, const String &, int &)>
	Callback definition for onDirectionOpenClose callback.

using	AdjustDirectionOpenCloseCallback = std::function< bool(const String &, const String &, int &)>
	Callback definition for onAdjustDirectionOpenClose callback.

using	SetPercentageCallback = std::function< bool(const String &, int &)>
	Callback definition for onSetPercentage function.

using	AdjustPercentageCallback = std::function< bool(const String &, int &)>
	Callback definition for onAdjustPercentage function.

using	SetPowerLevelCallback = std::function< bool(const String &, int &)>
	Definition for setPowerLevel callback.

using	AdjustPowerLevelCallback = std::function< bool(const String &, int &)>
	Definition for onAdjustPowerLevel callback.

using	PowerStateCallback = std::function< bool(const String &, bool &)>
	Callback definition for onPowerState function.

using	GenericRangeValueCallback_int = bool(*)(const String &, const String &, int &)
	Callback definition for onRangeValue function.

using	GenericSetRangeValueCallback_int = GenericRangeValueCallback_int
	Callback definition for onRangeValue function on a specific instance.

using	AdjustRangeValueCallback = bool(*)(const String &, int &)
	Callback definition for onAdjustRangeValue function.

using	GenericAdjustRangeValueCallback_int = GenericRangeValueCallback_int
	Callback definition for onAdjustRangeValue function on a specific instance for custom devices.

using	StartStopCallback = std::function< bool(const String &, bool &)>
	Definition for onStartStop callback.

using	PauseUnpauseCallback = std::function< bool(const String &, bool &)>
	Definition for onPauseUnpause callback.

using	ThermostatModeCallback = std::function< bool(const String &, String &)>
	Callback definition for onThermostatMode function.

using	SetTargetTemperatureCallback = std::function< bool(const String &, float &)>
	Callback definition for onTargetTemperature function.

using	AdjustTargetTemperatureCallback = std::function< bool(const String &, float &)>
	Callback definition for onAdjustTargetTemperature function.

using	GenericToggleStateCallback = std::function< bool(const String &, const String &, bool &)>
	Callback definition for onToggleState function.

using	SetVolumeCallback = std::function< bool(const String &, int &)>
	Callback definition for onSetVolume function.

using	AdjustVolumeCallback = std::function< bool(const String &, int &, bool)>
	Callback definition for onAdjustVolume function.

Detailed Description

SinricPro namespace.

Typedef Documentation

◆ AdjustBandsCallback

using AdjustBandsCallback = std::function<bool(const String &, const String &, int &)>

Callback definition for onAdjustBands function.

Gets called when device receive a adjustBands request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

std::map<String, int> equalizerBands;
 
bool onAdjustBands(const String &deviceId, String &bands, int &levelDelta) {
  equalizerBands[bands] += levelDelta; // calculate absolute bands level
  Serial.printf("Device %s bands %s changed about %d to %d\r\n", deviceId.c_str(), bands.c_str(), levelDelta, equalizerBands[bands]);
  levelDelta = equalizerBands[bands]; // return absolute bands level
  return true; // request handled properly
}

◆ AdjustBrightnessCallback

using AdjustBrightnessCallback = std::function<bool(const String &, int &)>

Callback definition for onAdjustBrightness function.

Gets called when device receive a adjustBrightness request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int absoluteBrightness;
 
bool onAdjustBrightness(const String &deviceId, int &brightnessDelta) {
  absoluteBrightness += brightnessDelta; // calculate absolute brigthness
  Serial.printf("Device %s brightness changed about %i to %d\r\n", deviceId.c_str(), brightnessDelta, absoluteBrightness);
  brightnessDelta = absoluteBrightness; // return absolute brightness
  return true; // request handled properly
}

◆ AdjustDirectionOpenCloseCallback

using AdjustDirectionOpenCloseCallback = std::function<bool(const String &, const String &, int &)>

Callback definition for onAdjustDirectionOpenClose callback.

Gets called when device receives an adjustOpenClose request with direction information

Parameters

[in]	deviceId	String containing the ID of device
[in]	openDirection	String direction in which to open: `UP`, `DOWN`, `LEFT`, `RIGHT`, `IN`, `OUT`
[in,out]	openRelativePercent	Integer representing relative percentage change to apply On output, should contain the absolute percentage value the device has been set to

Returns: Success status of the request

Return values

true	Request handled successfully
false	Request handling failed

Example-Code

◆ AdjustOpenCloseCallback

using AdjustOpenCloseCallback = std::function<bool(const String &, int &)>

Callback definition for onAdjustOpenClose callback.

Gets called when device receives an adjustOpenClose request

Parameters

[in]	deviceId	String containing the ID of device
[in,out]	openRelativePercent	Integer value representing the relative percentage change to apply On output, should contain the absolute percentage value the device has been set to

Returns: Success status of the request

Return values

true	Request handled successfully
false	Request handling failed

Example-Code

◆ AdjustPercentageCallback

using AdjustPercentageCallback = std::function<bool(const String &, int &)>

Callback definition for onAdjustPercentage function.

Gets called when device receive a adjustPercentage request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int absolutePercentage;
 
bool onAdjustPercentage(const String &deviceId, int &percentageDelta) {
  absolutePercentage += percentageDelta; // calculate absolute percentage
  Serial.printf("Device %s percentage changed about %i to %d\r\n", deviceId.c_str(), percentageDelta, absolutePercentage);
  percentageDelta = absolutePercentage; // return absolute percentage
  return true;                     // request handled properly
}

◆ AdjustPowerLevelCallback

using AdjustPowerLevelCallback = std::function<bool(const String &, int &)>

Definition for onAdjustPowerLevel callback.

Gets called when device receive a adjustPowerLevel reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request can`t be handled properly because of some error

Example-Code

int absolutePowerLevel;
 
bool onAdjustPowerLevel(const String &deviceId, int &powerDelta) {
  absolutePowerLevel += powerDelta;  // calculate absolute power level
  Serial.printf("Device %s brightness changed about %i to %d\r\n", deviceId.c_str(), powerDelta, absolutePowerLevel);
  powerDelta = absolutePowerLevel; // return absolute power level
  return true; // request handled properly
}

◆ AdjustRangeValueCallback

using AdjustRangeValueCallback = bool (*)(const String &, int &)

Callback definition for onAdjustRangeValue function.

Gets called when device receive a adjustRangeValue reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int globalRangeValue;
 
bool onAdjustRangeValue(const String &deviceId, int &rangeValueDelta) {
  globalRangeValue += rangeValue; // calculate absolute rangeValue
  Serial.printf("Device %s range value has been changed about %i to %d\r\n", deviceId.c_str(), rangeValueDelta, globalRangeValue);
  rangeValueDelta = globalRangeValue; // return absolute rangeValue
  return true; // request handled properly
}

◆ AdjustTargetTemperatureCallback

using AdjustTargetTemperatureCallback = std::function<bool(const String &, float &)>

Callback definition for onAdjustTargetTemperature function.

Gets called when device receive a adjustTargetTemperature reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

float globalTargetTemp; 
 
bool onAdjustTargetTemperature(const String &deviceId, float &tempDelta) {
  globalTargetTemp += tempDelta; // change global target temperature about tempDelta
  Serial.printf("Device %s target temperature changed about %f to %f\r\n", deviceId.c_str(), tempDelta, globalTargetTemp);
  tempDelta = globalTargetTemp; // return absolute target temperature
  return true; // request handled properly
}

◆ AdjustVolumeCallback

using AdjustVolumeCallback = std::function<bool(const String &, int &, bool)>

Callback definition for onAdjustVolume function.

Gets called when device receive a adjustVolume request

Parameters

[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`

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int absoluteVolume;
 
bool onAdjustVolume(const String &deviceId, int &volumeDelta, bool volumeDefault) {
  absoluteVolume += volumeDelta;  // calculate absolute volume
  Serial.printf("Device %s volume changed about %i to %d (default: %s)\r\n", deviceId.c_str(), volumeDelta, absoluteVolume, volumeDefault);
  volumeDelta = absoluteVolume; // return absolute volume
  return true; // request handled properly
}

◆ BrightnessCallback

using BrightnessCallback = std::function<bool(const String &, int &)>

Callback definition for onBrightness function.

Gets called when device receive a setBrightness request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onBrightness(const String &deviceId, int &brightness) {
  Serial.printf("Device %s brightness %d\r\n", deviceId.c_str(), brightness);
  return true; // request handled properly
}

◆ ChangeChannelCallback

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

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

// channelNames used to convert channelNumber into channelName
// please put in your TV channel names
// channel numbers starts counting from 0!
// so "ZDF" is channel 2
const char* channelNames[] = {
  "A/V",
  "ard", 
  "ZDF", 
  "n. d. r.", 
  "kabel eins", 
  "VOX", 
  "Sat.1", 
  "ProSieben", 
  "rtl", 
  "RTL II", 
  "SUPER RTL", 
  "KiKA"
};
 
int tvChannel; // current channel selected
 
#define MAX_CHANNELS sizeof(channelNames) / sizeof(channelNames[0])  // just to determine how many channels are in channelNames array
 
// map channelNumbers used to convert channelName into channelNumber
// This map is initialized in "setupChannelNumbers()" function by using the "channelNames" array
std::map<String, unsigned int> channelNumbers;
 
void setupChannelNumbers() {
  for (unsigned int i=0; i < MAX_CHANNELS; i++) {
    channelNumbers[channelNames[i]] = i;
  }
}
 
bool onChangeChannel(const String &deviceId, String &channel) {
  tvChannel = channelNumbers[channel]; // save new channelNumber in tvChannel variable
  Serial.printf("Change channel to \"%s\" (channel number %d)\r\n", channel.c_str(), tvChannel);
  return true;
}

◆ ChangeChannelNumberCallback

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

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

// channelNames used to convert channelNumber into channelName
// please put in your TV channel names
// channel numbers starts counting from 0!
// so "ZDF" is channel 2
const char* channelNames[] = {
  "A/V",
  "ard", 
  "ZDF", 
  "n. d. r.", 
  "kabel eins", 
  "VOX", 
  "Sat.1", 
  "ProSieben", 
  "rtl", 
  "RTL II", 
  "SUPER RTL", 
  "KiKA"
};
 
int tvChannel; // current channel selected
 
#define MAX_CHANNELS sizeof(channelNames) / sizeof(channelNames[0])  // just to determine how many channels are in channelNames array
 
// map channelNumbers used to convert channelName into channelNumber
// This map is initialized in "setupChannelNumbers()" function by using the "channelNames" array
std::map<String, unsigned int> channelNumbers;
 
void setupChannelNumbers() {
  for (unsigned int i=0; i < MAX_CHANNELS; i++) {
    channelNumbers[channelNames[i]] = i;
  }
}
 
bool onChangeChannelNumber(const String& deviceId, int channelNumber, String& channelName) {
  tvChannel = channelNumber; // update tvChannel to new channel number
  if (tvChannel < 0) tvChannel = 0;
  if (tvChannel > MAX_CHANNELS-1) tvChannel = MAX_CHANNELS-1;
 
  channelName = channelNames[tvChannel]; // return the channelName
 
  Serial.printf("Change to channel to %d (channel name \"%s\")\r\n", tvChannel, channelName.c_str());
  return true;
}

◆ ColorCallback

using ColorCallback = std::function<bool(const String &, byte &, byte &, byte &)>

Callback definition for onColor function.

Gets called when device receive a setColor request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onColor(const String &deviceId, byte &r, byte &g, byte &b) {
  Serial.printf("Device %s color is set to red=%d, green=%d, blue=%d\r\n", deviceId.c_str(), r, g, b);
  return true; // request handled properly
}

◆ ColorTemperatureCallback

using ColorTemperatureCallback = std::function<bool(const String &, int &)>

Callback definition for onColorTemperature function.

Gets called when device receive a setColorTemperature request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onColorTemperature(const String &deviceId, int &colorTemperature) {
  Serial.printf("Device %s colorTemperature is set to %i\r\n", deviceId.c_str(), colorTemperature);
  return true; // request handled properly
}

◆ ConnectedCallbackHandler

using ConnectedCallbackHandler = std::function<void(void)>

Callback definition for onConnected function.

Gets called when device is connected to SinricPro server

Parameters

void

Returns: void

◆ DecreaseColorTemperatureCallback

using DecreaseColorTemperatureCallback = std::function<bool(const String &, int &)>

Callback definition for onDecreaseColorTemperature function.

Gets called when device receive a decreaseColorTemperature request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int globalColorTemperature; 
 
bool onDecreaseColorTemperature(const String &deviceId, int &colorTemperature) {
  globalColorTemperature -= 1000; // decrease globalColorTemperature about 1000;
  Serial.printf("Device %s colorTemperature changed %i\r\n", deviceId.c_str(), colorTemperature);
  colorTemperature = globalColorTemperature; // return new colorTemperature
  return true; // request handled properly
}

◆ DirectionOpenCloseCallback

using DirectionOpenCloseCallback = std::function<bool(const String &, const String &, int &)>

Callback definition for onDirectionOpenClose callback.

Gets called when device receives a setOpenClose request with direction information

Parameters

[in]	deviceId	String containing the ID of device
[in]	openDirection	String direction in which to open: `UP`, `DOWN`, `LEFT`, `RIGHT`, `IN`, `OUT`
[in,out]	openPercent	Integer percentage (0-100) of how open the device should be set

Returns: Success status of the request

Return values

true	Request handled successfully
false	Request handling failed

Example-Code

◆ DisconnectedCallbackHandler

using DisconnectedCallbackHandler = std::function<void(void)>

Callback definition for onDisconnected function.

Gets called when device is disconnected from SinricPro server

Parameters

void

Returns: void

◆ DoorCallback

using DoorCallback = std::function<bool(const String &, bool &)>

Callback definition for onDoorState function.

Gets called when device receive a open or close request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onDoorState(const String &deviceId, bool &doorState) {
  Serial.printf("Device %s garage door is now %s\r\n", deviceId.c_str(), doorState?"closed":"open");
  return true;
}

◆ GenericAdjustRangeValueCallback_int

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

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int globalRangeValue;
 
bool onAdjustRangeValue(const String &deviceId, const String& instance, int &rangeValueDelta) {
  globalRangeValue += rangeValueDelta; // calculate absolute rangeValue
  Serial.printf("Device %s range value for %s has been changed about %i to %d\r\n", deviceId.c_str(), instance.c_str(), rangeValueDelta, globalRangeValue);
  rangeValueDelta = globalRangeValue; // return absolute rangeValue
  return true;                        // request handled properly
}

◆ GenericModeCallback

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

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onSetMode(const String &deviceId, const String &instance, String &mode) {
  Serial.printf("Device %s mode %s set to %s\r\n", deviceId.c_str(), instance.c_str(), mode);
  return true; // request handled properly
}

◆ GenericRangeValueCallback_int

using GenericRangeValueCallback_int = bool (*)(const String &, const String &, int &)

Callback definition for onRangeValue function.

Gets called when device receive a setRangeValue reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onRangeValue(const String &deviceId, int &rangeValue) {
  Serial.printf("Device %s range value has been set to %d\r\n", deviceId.c_str(), rangeValue);
  return true; // request handled properly
}

◆ GenericSetRangeValueCallback_int

using GenericSetRangeValueCallback_int = GenericRangeValueCallback_int

Callback definition for onRangeValue function on a specific instance.

Gets called when device receive a setRangeValue reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onRangeValue(const String &deviceId, const String &instance, int &rangeValue) {
  Serial.printf("Device %s range value for %s has been set to %d\r\n", deviceId.c_str(), instance.c_str(), rangeValue);
  return true; // request handled properly
}

◆ GenericToggleStateCallback

using GenericToggleStateCallback = std::function<bool(const String &, const String&, bool &)>

Callback definition for onToggleState function.

Gets called when device receive a setPowerState reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onToggleState(const String &deviceId, const String &instance, bool &state) {
  Serial.printf("Device %s state \"%s\" turned %s\r\n", deviceId.c_str(), instance.c_str(), state ? "on" : "off");
  return true; // request handled properly
}

◆ IncreaseColorTemperatureCallback

using IncreaseColorTemperatureCallback = std::function<bool(const String &, int &)>

Callback definition for onIncreaseColorTemperature function.

Gets called when device receive a increaseColorTemperature request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

int globalColorTemperature; 
 
bool onIncreaseColorTemperature(const String &deviceId, int &colorTemperature) {
  globalColorTemperature += 1000; // increase globalColorTemperature about 1000;
  Serial.printf("Device %s colorTemperature changed to %i\r\n", deviceId.c_str(), colorTemperature);
  colorTemperature = globalColorTemperature; // return new colorTemperature
  return true; // request handled properly
}

◆ KeystrokeCallback

using KeystrokeCallback = std::function<bool(const String &, String &)>

Callback definition for onKeystroke function.

Gets called when device receive a setBands request

Parameters

[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`

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onKeystroke(const String& deviceId, String &keystroke) {
  Serial.printf("Device %s, key %s pressed\r\n", deviceId.c_str(), keystroke.c_str());
  return true;
}

◆ LockStateCallback

using LockStateCallback = std::function<bool(const String &, bool &)>

Callback definition for onLockState function.

Gets called when device receive a setLockState request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onLockState(const String &deviceId, bool &lockState) {
  Serial.printf("Device is %s\r\n", lockState?"locked":"unlocked");
  return true;
}

◆ MediaControlCallback

using MediaControlCallback = std::function<bool(const String &, String &)>

Callback definition for onMediaControl function.

Gets called when device receive a mediaControl request

Parameters

[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`

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onMediaControl(const String &deviceId, String &control) {
  Serial.printf("Device %s: %s\r\n", deviceId.c_str(), control.c_str());
  return true; // request handled properly
}

◆ ModeCallback

using ModeCallback = std::function<bool(const String &, String &)>

Callback definition for onSetMode function.

Gets called when device receive a setBands request

Parameters

[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`

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onSetMode(const String &deviceId, String &mode) {
  Serial.printf("Device %s is set to mode %s\r\n", deviceId.c_str(), mode);
  return true; // request handled properly
}

◆ MuteCallback

using MuteCallback = std::function<bool(const String &, bool &)>

Callback definition for onMute function.

Gets called when device receive a setMute request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onMute(const String &deviceId, bool &mute) {
  Serial.printf("Device %s is %s\r\n", deviceId.c_str(), mute?"muted":"unmuted");
  return true; // request handled properly
}

◆ OpenCloseCallback

using OpenCloseCallback = std::function<bool(const String &, int &)>

Callback definition for onOpenClose callback.

Gets called when device receives a setOpenClose request

Parameters

[in]	deviceId	String containing the ID of device
[in,out]	openPercent	Integer percentage (0-100) of how open the device should be set (0 = closed, 100 = fully open)

Returns: Success status of the request

Return values

true	Request handled successfully
false	Request handling failed

Example-Code

◆ OTAUpdateCallbackHandler

typedef std::function< bool(const String &url, int major, int minor, int patch, bool forceUpdate)> OTAUpdateCallbackHandler

Function signature for OTA update callback.

This typedef defines a function pointer type for OTA (Over-The-Air) update callbacks. The callback function should accept a URL string and a Version struct as parameters.

Parameters

url	The URL from which the OTA update can be downloaded.
major	The major version number
minor	The minor version number
patch	The patch version number
forceUpdate	Skip the version check and apply the update.

Returns: bool True if the update process started successful, false otherwise.

◆ PauseUnpauseCallback

using PauseUnpauseCallback = std::function<bool(const String &, bool &)>

Definition for onPauseUnpause callback.

Gets called when device receive a setPauseUnpause reuqest

Parameters

[in]	deviceId	String which contains the ID of device
[in]	pause	true for pause, false for unpause

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

◆ PowerStateCallback

using PowerStateCallback = std::function<bool(const String &, bool &)>

Callback definition for onPowerState function.

Gets called when device receive a setPowerState reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onPowerState(const String &deviceId, bool &state) {
  Serial.printf("Device %s turned %s\r\n", deviceId.c_str(), state?"on":"off");
  return true; // request handled properly
}

◆ ReportHealthCallbackHandler

typedef std::function< bool(String &healthReport)> ReportHealthCallbackHandler

Defines a function type for reporting device health status.

This typedef creates an alias for a std::function that takes a reference to a String and returns a boolean value. It's designed to be used as a callback for health reporting

Parameters

healthReport A reference to a String that will contain the health status information. The callback function should populate this string with relevant health data.

Returns: bool Returns true if the health report was successfully handled false otherwise.

◆ ResetBandsCallback

using ResetBandsCallback = std::function<bool(const String &, const String &, int &)>

Callback definition for onResetBands function.

Gets called when device receive a onResetBands request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

std::map<String, int> equalizerBands;
 
bool onResetBands(const String &deviceId, String &bands, int &level) {
  equalizerBands[bands] = 0; // reset bands level to 0
  Serial.printf("Device %s bands %s reset to %d\r\n", deviceId.c_str(), bands.c_str(), equalizerBands[bands]);
  return true; // request handled properly
}

◆ SelectInputCallback

using SelectInputCallback = std::function<bool(const String &, String &)>

Callback definition for onSelectInput function.

Gets called when device receive a selectInput request

Parameters

[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`

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onSelectInput(const String &deviceId, String &input) {
  Serial.printf("Device %s input changed to %s\r\n", deviceId.c_str(), input.c_str());
  return true;
}

◆ SetBandsCallback

using SetBandsCallback = std::function<bool(const String &, const String &, int &)>

Callback definition for onSetBands function.

Gets called when device receive a setBands request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

std::map<String, int> equalizerBands;
 
bool onSetBands(const String &deviceId, String &bands, int &level) {
  Serial.printf("Device %s bands %s set to %d\r\n", deviceId.c_str(), bands.c_str(), level);
  equalizerBands[bands] = level; 
  return true; // request handled properly
}

◆ SetPercentageCallback

using SetPercentageCallback = std::function<bool(const String &, int &)>

Callback definition for onSetPercentage function.

Gets called when device receive a setPercentage request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onSetPercentage(const String &deviceId, int &percentage) {
  Serial.printf("Device %s percentage %d\r\n", deviceId.c_str(), percentage);
  return true; // request handled properly
}

◆ SetPowerLevelCallback

using SetPowerLevelCallback = std::function<bool(const String &, int &)>

Definition for setPowerLevel callback.

Gets called when device receive a setPowerLevel reuqest

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onPowerLevel(const String &deviceId, int &powerLevel) {
  Serial.printf("Device %s powerlevel %d\r\n", deviceId.c_str(), powerLevel);
  return true; // request handled properly
}

◆ SetSettingCallbackHandler

typedef std::function< bool(const String &id, const String &value)> SetSettingCallbackHandler

Function signature for setting a module setting.

This callback is used to set a value for a specific setting identified by its ID.

Parameters

id	The unique identifier of the setting to be set.
value	The new value to be assigned to the setting.

Returns: bool Returns true if the setting was successfully updated, false otherwise.

◆ SetTargetTemperatureCallback

using SetTargetTemperatureCallback = std::function<bool(const String &, float &)>

Callback definition for onTargetTemperature function.

Gets called when device receive a targetTemperature request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onTargetTemperature(const String &deviceId, float &targetTemp) { 
  Serial.printf("Device %s target temperature set to %f\r\n", deviceId.c_str(), targetTemp);
  return true; // request handled properly
}

◆ SetVolumeCallback

using SetVolumeCallback = std::function<bool(const String &, int &)>

Callback definition for onSetVolume function.

Gets called when device receive a setVolume request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onSetVolume(const String &deviceId, int &volume) {
  Serial.printf("Device %s volume set to %d\r\n", deviceId.c_str(), volume);
  return true; // request handled properly
}

◆ SkipChannelsCallback

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

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

// channelNames used to convert channelNumber into channelName
// please put in your TV channel names
// channel numbers starts counting from 0!
// so "ZDF" is channel 2
const char* channelNames[] = {
  "A/V",
  "ard", 
  "ZDF", 
  "n. d. r.", 
  "kabel eins", 
  "VOX", 
  "Sat.1", 
  "ProSieben", 
  "rtl", 
  "RTL II", 
  "SUPER RTL", 
  "KiKA"
};
 
int tvChannel; // current channel selected
 
#define MAX_CHANNELS sizeof(channelNames) / sizeof(channelNames[0])  // just to determine how many channels are in channelNames array
 
// map channelNumbers used to convert channelName into channelNumber
// This map is initialized in "setupChannelNumbers()" function by using the "channelNames" array
std::map<String, unsigned int> channelNumbers;
 
void setupChannelNumbers() {
  for (unsigned int i=0; i < MAX_CHANNELS; i++) {
    channelNumbers[channelNames[i]] = i;
  }
}
 
bool onSkipChannels(const String &deviceId, const int channelCount, String &channelName) {
  tvChannel += channelCount; // calculate new channel number
  if (tvChannel < 0) tvChannel = 0;
  if (tvChannel > MAX_CHANNELS-1) tvChannel = MAX_CHANNELS-1;
  channelName = String(channelNames[tvChannel]); // return channel name
 
  Serial.printf("Skip channel: %i (number: %i / name: \"%s\")\r\n", channelCount, tvChannel, channelName.c_str());
 
  return true;
}

◆ StartStopCallback

using StartStopCallback = std::function<bool(const String &, bool &)>

Definition for onStartStop callback.

Gets called when device receive a setStartStop reuqest

Parameters

[in]	deviceId	String which contains the ID of device
[in]	start	true for start, false for stop

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

◆ ThermostatModeCallback

using ThermostatModeCallback = std::function<bool(const String &, String &)>

Callback definition for onThermostatMode function.

Gets called when device receive a setThermostatMode request

Parameters

[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

Returns: the success of the request

Return values

true	request handled properly
false	request was not handled properly because of some error

Example-Code

bool onThermostatMode(const String& deviceId, String& mode) {
  Serial.printf("Deivce %s thermostat mode set to %s\r\n", deviceId.c_str(), mode);
  return true; // request handled properly
}

Classes

Typedefs

Detailed Description

Typedef Documentation

◆ AdjustBandsCallback

Example-Code

◆ AdjustBrightnessCallback

Example-Code

◆ AdjustDirectionOpenCloseCallback

Example-Code

◆ AdjustOpenCloseCallback

Example-Code

◆ AdjustPercentageCallback

Example-Code

◆ AdjustPowerLevelCallback

Example-Code

◆ AdjustRangeValueCallback

Example-Code

◆ AdjustTargetTemperatureCallback

Example-Code

◆ AdjustVolumeCallback

Example-Code

◆ BrightnessCallback

Example-Code

◆ ChangeChannelCallback

Example-Code

◆ ChangeChannelNumberCallback

Example-Code

◆ ColorCallback

Example-Code

◆ ColorTemperatureCallback

Example-Code

◆ ConnectedCallbackHandler

◆ DecreaseColorTemperatureCallback

Example-Code

◆ DirectionOpenCloseCallback

Example-Code

◆ DisconnectedCallbackHandler

◆ DoorCallback

Example-Code

◆ GenericAdjustRangeValueCallback_int

Example-Code

◆ GenericModeCallback

Example-Code

◆ GenericRangeValueCallback_int

Example-Code

◆ GenericSetRangeValueCallback_int

Example-Code

◆ GenericToggleStateCallback

Example-Code

◆ IncreaseColorTemperatureCallback

Example-Code

◆ KeystrokeCallback

Example-Code

◆ LockStateCallback

Example-Code

◆ MediaControlCallback

Example-Code

◆ ModeCallback

Example-Code

◆ MuteCallback

Example-Code

◆ OpenCloseCallback

Example-Code

◆ OTAUpdateCallbackHandler

◆ PauseUnpauseCallback

Example-Code

◆ PowerStateCallback

Example-Code

◆ ReportHealthCallbackHandler

◆ ResetBandsCallback

Example-Code

◆ SelectInputCallback

Example-Code

◆ SetBandsCallback

Example-Code

◆ SetPercentageCallback

Example-Code

◆ SetPowerLevelCallback

Example-Code