SinricPro Library
ColorTemperatureController< T >

ColorTemperatureController. More...

Inheritance diagram for ColorTemperatureController< T >:

Public Types

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...
 

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="PHYSICAL_INTERACTION")
 Send setColorTemperature event to SinricPro Server indicating actual color temperature. More...
 

Detailed Description

template<typename T>
class ColorTemperatureController< T >

ColorTemperatureController.

Member Typedef Documentation

◆ ColorTemperatureCallback

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

Callback definition for onColorTemperature function.

Gets called when device receive a setColorTemperature request

Parameters
[in]deviceIdString which contains the ID of device
[in]colorTemperatureInteger value with color temperature the device should set to
2200 = warm white
2700 = soft white
4000 = white
5500 = daylight white
7000 = cool white
[out]colorTemperatureInteger 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
truerequest handled properly
falserequest 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
}
void onColorTemperature(ColorTemperatureCallback cb)
Set callback function for setColorTemperature request.
Definition: ColorTemperatureController.h:82

◆ DecreaseColorTemperatureCallback

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

Callback definition for onDecreaseColorTemperature function.

Gets called when device receive a decreaseColorTemperature request

Parameters
[in]deviceIdString which contains the ID of device
[in]colorTemperatureInteger value -1 = Device should decrease color temperature
[out]colorTemperatureInteger 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
truerequest handled properly
falserequest 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
}
void onDecreaseColorTemperature(DecreaseColorTemperatureCallback cb)
Set callback function for decreaseColorTemperature request.
Definition: ColorTemperatureController.h:106

◆ IncreaseColorTemperatureCallback

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

Callback definition for onIncreaseColorTemperature function.

Gets called when device receive a increaseColorTemperature request

Parameters
[in]deviceIdString which contains the ID of device
[in]colorTemperatureInteger value 1 = Device should increase color temperature
[out]colorTemperatureInteger 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
truerequest handled properly
falserequest 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
}
void onIncreaseColorTemperature(IncreaseColorTemperatureCallback cb)
Set callback function for increaseColorTemperature request.
Definition: ColorTemperatureController.h:94

Member Function Documentation

◆ onColorTemperature()

void onColorTemperature ( ColorTemperatureCallback  cb)

Set callback function for setColorTemperature request.

Parameters
cbFunction pointer to a ColorTemperatureCallback function
Returns
void
See also
ColorTemperatureCallback

◆ onDecreaseColorTemperature()

void onDecreaseColorTemperature ( DecreaseColorTemperatureCallback  cb)

Set callback function for decreaseColorTemperature request.

Parameters
cbFunction pointer to a DecreaseColorTemperatureCallback function
Returns
void
See also
DecreaseColorTemperatureCallback

◆ onIncreaseColorTemperature()

void onIncreaseColorTemperature ( IncreaseColorTemperatureCallback  cb)

Set callback function for increaseColorTemperature request.

Parameters
cbFunction pointer to a IncreaseColorTemperatureCallback function
Returns
void
See also
IncreaseColorTemperatureCallback

◆ sendColorTemperatureEvent()

bool sendColorTemperatureEvent ( int  colorTemperature,
String  cause = "PHYSICAL_INTERACTION" 
)

Send setColorTemperature event to SinricPro Server indicating actual color temperature.

Parameters
colorTemperatureInteger 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")
Returns
the success of sending the even
Return values
trueevent has been sent successfully
falseevent has not been sent, maybe you sent to much events in a short distance of time