PercentageController< T >

PercentageController. More...

#include <PercentageController.h>

Public Member Functions
void	onSetPercentage (SetPercentageCallback cb)
	Set callback function for setPercentage request.
void	onAdjustPercentage (AdjustPercentageCallback cb)
	Set callback function for adjustPercentage request.
bool	sendSetPercentageEvent (int percentage, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
	Send setPercentage event to SinricPro Server indicating actual percentage has changed.

Detailed Description

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

PercentageController.

Member Function Documentation

onAdjustPercentage()

template<typename T >

void onAdjustPercentage

(

AdjustPercentageCallback

cb

)

Set callback function for adjustPercentage request.

Parameters

cb	Function pointer to a AdjustPercentageCallback function

Returns

void

See also

AdjustPercentageCallback

onSetPercentage()

template<typename T >

void onSetPercentage

(

SetPercentageCallback

cb

)

Set callback function for setPercentage request.

Parameters

cb	Function pointer to a SetPercentageCallback function

Returns

void

See also

SetPercentageCallback

sendSetPercentageEvent()

template<typename T >

bool sendSetPercentageEvent	(	int	percentage,
		String	cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION
	)

Send setPercentage event to SinricPro Server indicating actual percentage has changed.

Parameters

percentage	Integer reporting the percentage that the device have been set to
cause	(optional) Reason why event is sent (default = "PHYSICAL_INTERACTION")

Returns

the success of sending the event

Return values

true	event has been sent successfully
false	event has not been sent, maybe you sent to much events in a short distance of time