yocto_colorled.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_colorled.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YColorLed
class	YMove

Macros
#define	_CLASS_YMOVE
#define	Y_BLINKSEQMAXSIZE_INVALID   (YAPI_INVALID_UINT)
#define	Y_BLINKSEQSIGNATURE_INVALID   (YAPI_INVALID_UINT)
#define	Y_BLINKSEQSIZE_INVALID   (YAPI_INVALID_UINT)
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_HSLCOLOR_INVALID   (YAPI_INVALID_UINT)
#define	Y_RGBCOLOR_INVALID   (YAPI_INVALID_UINT)
#define	Y_RGBCOLORATPOWERON_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YColorLedValueCallback) (YColorLed *func, const string &functionValue)

Functions
YColorLed *	yFindColorLed (const string &func)
YColorLed *	yFirstColorLed (void)

Macro Definition Documentation

#define _CLASS_YMOVE

Definition at line 56 of file yocto_colorled.h.

#define Y_BLINKSEQMAXSIZE_INVALID   (YAPI_INVALID_UINT)

Definition at line 76 of file yocto_colorled.h.

#define Y_BLINKSEQSIGNATURE_INVALID   (YAPI_INVALID_UINT)

Definition at line 77 of file yocto_colorled.h.

#define Y_BLINKSEQSIZE_INVALID   (YAPI_INVALID_UINT)

Definition at line 75 of file yocto_colorled.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 78 of file yocto_colorled.h.

#define Y_HSLCOLOR_INVALID   (YAPI_INVALID_UINT)

Definition at line 73 of file yocto_colorled.h.

#define Y_RGBCOLOR_INVALID   (YAPI_INVALID_UINT)

Definition at line 72 of file yocto_colorled.h.

#define Y_RGBCOLORATPOWERON_INVALID   (YAPI_INVALID_UINT)

Definition at line 74 of file yocto_colorled.h.

Typedef Documentation

typedef void(* YColorLedValueCallback) (YColorLed *func, const string &functionValue)

Definition at line 54 of file yocto_colorled.h.

Function Documentation

YColorLed* yFindColorLed ( const string &  func )

inline

Retrieves an RGB 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 RGB LED is online at the time it is invoked. The returned object is nevertheless valid. Use the method YColorLed.isOnline() to test if the RGB LED is indeed online at a given time. In case of ambiguity when looking for an RGB 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 RGB LED

Returns

a YColorLed object allowing you to drive the RGB LED.

Definition at line 460 of file yocto_colorled.h.

YColorLed* yFirstColorLed ( void  )

inline

Starts the enumeration of RGB LEDs currently accessible. Use the method YColorLed.nextColorLed() to iterate on next RGB LEDs.

Returns

a pointer to a YColorLed object, corresponding to the first RGB LED currently online, or a NULL pointer if there are none.

Definition at line 471 of file yocto_colorled.h.