SinricPro Library
Loading...
Searching...
No Matches
BrightnessController< T >

BrightnessController. More...

#include <BrightnessController.h>

Inheritance diagram for BrightnessController< T >:

Public Member Functions

void onBrightness (BrightnessCallback cb)
 Set callback function for setBrightness request.
 
void onAdjustBrightness (AdjustBrightnessCallback cb)
 Set callback function for adjustBrightness request.
 
bool sendBrightnessEvent (int brightness, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
 Send setBrightness event to SinricPro Server indicating actual brightness.
 

Detailed Description

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

BrightnessController.

Member Function Documentation

◆ onAdjustBrightness()

template<typename T >
void onAdjustBrightness ( AdjustBrightnessCallback  cb)

Set callback function for adjustBrightness request.

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

◆ onBrightness()

template<typename T >
void onBrightness ( BrightnessCallback  cb)

Set callback function for setBrightness request.

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

◆ sendBrightnessEvent()

template<typename T >
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