RangeController< T >

RangeControllerFloatInt. More...

#include <RangeController.h>

Inheritance diagram for RangeController< T >:

Public Member Functions
void	onRangeValue (SetRangeValueCallback cb)
	Set callback function for setRangeValue request.
void	onRangeValue (const String &instance, GenericSetRangeValueCallback_int cb)
	Set callback function for setRangeValue request on a specific instance (custom device)
void	onAdjustRangeValue (AdjustRangeValueCallback cb)
	Set callback function for adjustRangeValue request.
bool	sendRangeValueEvent (int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
	Send rangeValue event to report curent rangeValue to SinricPro server.
bool	sendRangeValueEvent (const String &instance, int rangeValue, String cause=FSTR_SINRICPRO_PHYSICAL_INTERACTION)
	Send rangeValue event to report curent rangeValue to SinricPro server for a specific instance (custom device)

Detailed Description

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

RangeControllerFloatInt.

Member Function Documentation

onAdjustRangeValue()

template<typename T >

void onAdjustRangeValue

(

AdjustRangeValueCallback

cb

)

Set callback function for adjustRangeValue request.

Parameters

cb	Function pointer to a AdjustRangeValueCallback function

See also

AdjustRangeValueCallback

onRangeValue() [1/2]

template<typename T >

void onRangeValue	(	const String &	instance,
		GenericSetRangeValueCallback_int	cb
	)

Set callback function for setRangeValue request on a specific instance (custom device)

Parameters

instance	String instance name (custom device)
cb	Function pointer to a GenericSetRangeValueCallback function

See also

GenericSetRangeValueCallback

onRangeValue() [2/2]

template<typename T >

void onRangeValue

(

SetRangeValueCallback

cb

)

Set callback function for setRangeValue request.

Parameters

cb	Function pointer to a SetRangeValueCallback function

See also

SetRangeValueCallback

sendRangeValueEvent() [1/2]

template<typename T >

bool sendRangeValueEvent	(	const String &	instance,
		int	rangeValue,
		String	cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION
	)

Send rangeValue event to report curent rangeValue to SinricPro server for a specific instance (custom device)

Parameters

instance	String instance name
rangeValue	Value between 0..3
cause	(optional) String reason why event is sent (default = "PHYSICAL_INTERACTION")

Returns

the success of sending the even

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

sendRangeValueEvent() [2/2]

template<typename T >

bool sendRangeValueEvent	(	int	rangeValue,
		String	cause = FSTR_SINRICPRO_PHYSICAL_INTERACTION
	)

Send rangeValue event to report curent rangeValue to SinricPro server.

Parameters

rangeValue	Value between 0..3
cause	(optional) String reason why event is sent (default = "PHYSICAL_INTERACTION")

Returns

the success of sending the even

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