#include <yocto_led.h>

Inheritance diagram for YLed:

Public Member Functions
virtual int	_invokeValueCallback (string value)

Y_BLINKING_enum	blinking (void)

Y_BLINKING_enum	get_blinking (void)

int	get_luminosity (void)

Y_POWER_enum	get_power (void)

int	luminosity (void)

YLed *	next (void)

YLed *	nextLed (void)

Y_POWER_enum	power (void)

virtual int	registerValueCallback (YLedValueCallback callback)

int	set_blinking (Y_BLINKING_enum newval)

int	set_luminosity (int newval)

int	set_power (Y_POWER_enum newval)

int	setBlinking (Y_BLINKING_enum newval)

int	setLuminosity (int newval)

int	setPower (Y_POWER_enum newval)

	~YLed ()

Public Member Functions inherited from YFunction
void	_clearDataStreamCache ()

string	_decode_json_string (const string &json)

string	_download (const string &url)

YDataStream *	_findDataStream (YDataSet &dataset, const string &def)

string	_get_json_path (const string &json, const string &path)

vector< string >	_json_get_array (const string &json)

string	_json_get_key (const string &json, const string &data)

string	_json_get_string (const string &json)

int	_parseEx (yJsonStateMachine &j)

virtual int	_parserHelper (void)

string	_parseString (yJsonStateMachine &j)

string	_request (const string &request)

string	_requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)

void	_throw (YRETCODE errType, string errMsg)

YRETCODE	_upload (const string &path, const string &content)

YRETCODE	_uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)

string	advertisedValue (void)

void	clearCache ()

string	describe (void)

string	errMessage (void)

string	errorMessage (void)

YRETCODE	errorType (void)

YRETCODE	errType (void)

YFUN_DESCR	functionDescriptor (void)

string	get_advertisedValue (void)

string	get_errorMessage (void)

YRETCODE	get_errorType (void)

virtual string	get_friendlyName (void)

YFUN_DESCR	get_functionDescriptor (void)

string	get_functionId (void)

string	get_hardwareId (void)

string	get_hubSerial ()

string	get_logicalName (void)

YModule *	get_module (void)

void *	get_userData (void)

bool	isOnline (void)

YRETCODE	load (int msValidity)

virtual string	loadAttribute (string attrName)

string	logicalName (void)

YModule *	module (void)

virtual int	muteValueCallbacks (void)

YFunction *	next (void)

YFunction *	nextFunction (void)

virtual int	registerValueCallback (YFunctionValueCallback callback)

int	set_advertisedValue (const string &newval)

int	set_logicalName (const string &newval)

void	set_userData (void *data)

int	setAdvertisedValue (const string &newval)

int	setLogicalName (const string &newval)

void	setUserData (void *data)

virtual int	unmuteValueCallbacks (void)

void *	userData (void)

virtual	~YFunction ()

Static Public Member Functions
static YLed *	Find (string func)

static YLed *	FindLed (string func)

static YLed *	First (void)

static YLed *	FirstLed (void)

Static Public Member Functions inherited from YFunction
static void	_ClearCache (void)

static YFunction *	Find (string func)

static YFunction *	FindFunction (string func)

static YFunction *	First (void)

static YFunction *	FirstFunction (void)

Static Public Attributes
static const Y_BLINKING_enum	BLINKING_AWARE = Y_BLINKING_AWARE

static const Y_BLINKING_enum	BLINKING_CALL = Y_BLINKING_CALL

static const Y_BLINKING_enum	BLINKING_INVALID = Y_BLINKING_INVALID

static const Y_BLINKING_enum	BLINKING_PANIC = Y_BLINKING_PANIC

static const Y_BLINKING_enum	BLINKING_RELAX = Y_BLINKING_RELAX

static const Y_BLINKING_enum	BLINKING_RUN = Y_BLINKING_RUN

static const Y_BLINKING_enum	BLINKING_STILL = Y_BLINKING_STILL

static const int	LUMINOSITY_INVALID = YAPI_INVALID_UINT

static const Y_POWER_enum	POWER_INVALID = Y_POWER_INVALID

static const Y_POWER_enum	POWER_OFF = Y_POWER_OFF

static const Y_POWER_enum	POWER_ON = Y_POWER_ON

Static Public Attributes inherited from YFunction
static const string	ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING

static const string	FRIENDLYNAME_INVALID = YAPI_INVALID_STRING

static const YFUN_DESCR	FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID

static const string	FUNCTIONID_INVALID = YAPI_INVALID_STRING

static const string	HARDWAREID_INVALID = YAPI_INVALID_STRING

static const string	LOGICALNAME_INVALID = YAPI_INVALID_STRING

Protected Member Functions
virtual int	_parseAttr (YJSONObject *json_val)

	YLed (const string &func)

Protected Member Functions inherited from YFunction
YRETCODE	_buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)

string	_escapeAttr (const string &changeval)

YRETCODE	_getDescriptor (YFUN_DESCR &fundescr, string &errMsg)

YRETCODE	_getDevice (YDevice *&dev, string &errMsg)

YRETCODE	_load_unsafe (int msValidity)

YRETCODE	_nextFunction (string &hwId)

int	_parse (YJSONObject *j)

YRETCODE	_setAttr (string attrname, string newvalue)

	YFunction (const string &func)

Protected Attributes
Y_BLINKING_enum	_blinking

int	_luminosity

Y_POWER_enum	_power

YLedValueCallback	_valueCallbackLed

Protected Attributes inherited from YFunction
string	_advertisedValue

u64	_cacheExpiration

string	_className

std::map< string, YDataStream * >	_dataStreams

string	_func

YFUN_DESCR	_fundescr

string	_funId

string	_hwId

string	_lastErrorMsg

YRETCODE	_lastErrorType

string	_logicalName

string	_serial

yCRITICAL_SECTION	_this_cs

void *	_userData

YFunctionValueCallback	_valueCallbackFunction

Friends
YLed *	yFindLed (const string &func)

YLed *	yFirstLed (void)

Additional Inherited Members
Static Protected Member Functions inherited from YFunction
static void	_AddToCache (const string &classname, const string &func, YFunction *obj)

static YFunction *	_FindFromCache (const string &classname, const string &func)

static void	_UpdateTimedReportCallbackList (YFunction *func, bool add)

static void	_UpdateValueCallbackList (YFunction *func, bool add)

Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * >	_cache

Detailed Description

YLed Class: Led function interface

The Yoctopuce application programming interface allows you not only to drive the intensity of the LED, but also to have it blink at various preset frequencies.

Definition at line 86 of file yocto_led.h.

Constructor & Destructor Documentation

YLed::YLed ( const string & func )

protected

Definition at line 51 of file yocto_led.cpp.

YLed::~YLed ( )

Definition at line 62 of file yocto_led.cpp.

Member Function Documentation

int YLed::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 327 of file yocto_led.cpp.

int YLed::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 70 of file yocto_led.cpp.

Y_BLINKING_enum YLed::blinking ( void )

inline

Definition at line 185 of file yocto_led.h.

static YLed* YLed::Find ( string func )

inlinestatic

Definition at line 248 of file yocto_led.h.

YLed * YLed::FindLed ( string func )

static

Retrieves a LED for a given identifier. The identifier can be specified using several formats:

FunctionLogicalName
ModuleSerialNumber.FunctionIdentifier
ModuleSerialNumber.FunctionLogicalName
ModuleLogicalName.FunctionIdentifier
ModuleLogicalName.FunctionLogicalName

This function does not require that the LED is online at the time it is invoked. The returned object is nevertheless valid. Use the method YLed.isOnline() to test if the LED is indeed online at a given time. In case of ambiguity when looking for a LED by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the LED

Returns: a YLed object allowing you to drive the LED.

Definition at line 276 of file yocto_led.cpp.

static YLed* YLed::First ( void )

inlinestatic

Definition at line 272 of file yocto_led.h.

YLed * YLed::FirstLed ( void )

static

Starts the enumeration of LEDs currently accessible. Use the method YLed.nextLed() to iterate on next LEDs.

Returns: a pointer to a YLed object, corresponding to the first LED currently online, or a NULL pointer if there are none.

Definition at line 347 of file yocto_led.cpp.

Y_BLINKING_enum YLed::get_blinking ( void )

Returns the current LED signaling mode.

Returns: a value among Y_BLINKING_STILL, Y_BLINKING_RELAX, Y_BLINKING_AWARE, Y_BLINKING_RUN, Y_BLINKING_CALL and Y_BLINKING_PANIC corresponding to the current LED signaling mode

On failure, throws an exception or returns Y_BLINKING_INVALID.

Definition at line 201 of file yocto_led.cpp.

int YLed::get_luminosity ( void )

Returns the current LED intensity (in per cent).

Returns: an integer corresponding to the current LED intensity (in per cent)

On failure, throws an exception or returns Y_LUMINOSITY_INVALID.

Definition at line 146 of file yocto_led.cpp.

Y_POWER_enum YLed::get_power ( void )

Returns the current LED state.

Returns: either Y_POWER_OFF or Y_POWER_ON, according to the current LED state

On failure, throws an exception or returns Y_POWER_INVALID.

Definition at line 92 of file yocto_led.cpp.

int YLed::luminosity ( void )

inline

Definition at line 159 of file yocto_led.h.

YLed* YLed::next ( void )

inline

Definition at line 259 of file yocto_led.h.

YLed * YLed::nextLed ( void )

Continues the enumeration of LEDs started using yFirstLed().

Returns: a pointer to a YLed object, corresponding to a LED currently online, or a NULL pointer if there are no more LEDs to enumerate.

Definition at line 337 of file yocto_led.cpp.

Y_POWER_enum YLed::power ( void )

inline

Definition at line 134 of file yocto_led.h.

int YLed::registerValueCallback ( YLedValueCallback callback )

virtual

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.

Parameters

callback : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.

Definition at line 308 of file yocto_led.cpp.

int YLed::set_blinking ( Y_BLINKING_enum newval )

Changes the current LED signaling mode.

Parameters

newval : a value among Y_BLINKING_STILL, Y_BLINKING_RELAX, Y_BLINKING_AWARE, Y_BLINKING_RUN, Y_BLINKING_CALL and Y_BLINKING_PANIC corresponding to the current LED signaling mode

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 233 of file yocto_led.cpp.

int YLed::set_luminosity ( int newval )

Changes the current LED intensity (in per cent).

Parameters

newval : an integer corresponding to the current LED intensity (in per cent)

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 177 of file yocto_led.cpp.

int YLed::set_power ( Y_POWER_enum newval )

Changes the state of the LED.

Parameters

newval : either Y_POWER_OFF or Y_POWER_ON, according to the state of the LED

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 123 of file yocto_led.cpp.

int YLed::setBlinking ( Y_BLINKING_enum newval )

inline

Definition at line 199 of file yocto_led.h.

int YLed::setLuminosity ( int newval )

inline

Definition at line 172 of file yocto_led.h.

int YLed::setPower ( Y_POWER_enum newval )

inline

Definition at line 147 of file yocto_led.h.

Friends And Related Function Documentation

YLed* yFindLed ( const string & func )

friend

Retrieves a LED for a given identifier. The identifier can be specified using several formats:

FunctionLogicalName
ModuleSerialNumber.FunctionIdentifier
ModuleSerialNumber.FunctionLogicalName
ModuleLogicalName.FunctionIdentifier
ModuleLogicalName.FunctionLogicalName

This function does not require that the LED is online at the time it is invoked. The returned object is nevertheless valid. Use the method YLed.isOnline() to test if the LED is indeed online at a given time. In case of ambiguity when looking for a LED by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the LED

Returns: a YLed object allowing you to drive the LED.

Definition at line 309 of file yocto_led.h.

YLed* yFirstLed ( void )

friend

Starts the enumeration of LEDs currently accessible. Use the method YLed.nextLed() to iterate on next LEDs.

Returns: a pointer to a YLed object, corresponding to the first LED currently online, or a NULL pointer if there are none.

Definition at line 320 of file yocto_led.h.

Member Data Documentation

Y_BLINKING_enum YLed::_blinking

protected

Definition at line 96 of file yocto_led.h.

int YLed::_luminosity

protected

Definition at line 95 of file yocto_led.h.

Y_POWER_enum YLed::_power

protected

Definition at line 94 of file yocto_led.h.

YLedValueCallback YLed::_valueCallbackLed

protected

Definition at line 97 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_AWARE = Y_BLINKING_AWARE

static

Definition at line 119 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_CALL = Y_BLINKING_CALL

static

Definition at line 121 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_INVALID = Y_BLINKING_INVALID

static

Definition at line 123 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_PANIC = Y_BLINKING_PANIC

static

Definition at line 122 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_RELAX = Y_BLINKING_RELAX

static

Definition at line 118 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_RUN = Y_BLINKING_RUN

static

Definition at line 120 of file yocto_led.h.

const Y_BLINKING_enum YLed::BLINKING_STILL = Y_BLINKING_STILL

static

Definition at line 117 of file yocto_led.h.

const int YLed::LUMINOSITY_INVALID = YAPI_INVALID_UINT

static

Definition at line 116 of file yocto_led.h.

const Y_POWER_enum YLed::POWER_INVALID = Y_POWER_INVALID

static

Definition at line 115 of file yocto_led.h.

const Y_POWER_enum YLed::POWER_OFF = Y_POWER_OFF

static

Definition at line 113 of file yocto_led.h.

const Y_POWER_enum YLed::POWER_ON = Y_POWER_ON

static

Definition at line 114 of file yocto_led.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation