SinricPro Library
BrightnessController< T >

BrightnessController. More...

Inheritance diagram for BrightnessController< T >:

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

Detailed Description

template<typename T>
class SINRICPRO_2_9_17::BrightnessController< T >

BrightnessController.

Member Function Documentation

◆ onAdjustBrightness()

void onAdjustBrightness ( AdjustBrightnessCallback  cb)

Set callback function for adjustBrightness request.

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

◆ onBrightness()

void onBrightness ( BrightnessCallback  cb)

Set callback function for setBrightness request.

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

◆ sendBrightnessEvent()

bool sendBrightnessEvent ( int  brightness,
String  cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION 
)

Send setBrightness event to SinricPro Server indicating actual brightness.

Parameters
brightnessInteger value with actual brightness the device is set to
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