Go to the source code of this file.
Classes | |
| class | YColorLedCluster |
Macros | |
| #define | Y_ACTIVELEDCOUNT_INVALID (YAPI_INVALID_UINT) |
| #define | Y_BLINKSEQMAXCOUNT_INVALID (YAPI_INVALID_UINT) |
| #define | Y_BLINKSEQMAXSIZE_INVALID (YAPI_INVALID_UINT) |
| #define | Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
| #define | Y_MAXLEDCOUNT_INVALID (YAPI_INVALID_UINT) |
Typedefs | |
| typedef void(* | YColorLedClusterValueCallback) (YColorLedCluster *func, const string &functionValue) |
Functions | |
| YColorLedCluster * | yFindColorLedCluster (const string &func) |
| YColorLedCluster * | yFirstColorLedCluster (void) |
Macro Definition Documentation
| #define Y_ACTIVELEDCOUNT_INVALID (YAPI_INVALID_UINT) |
Definition at line 55 of file yocto_colorledcluster.h.
| #define Y_BLINKSEQMAXCOUNT_INVALID (YAPI_INVALID_UINT) |
Definition at line 57 of file yocto_colorledcluster.h.
| #define Y_BLINKSEQMAXSIZE_INVALID (YAPI_INVALID_UINT) |
Definition at line 58 of file yocto_colorledcluster.h.
| #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
Definition at line 59 of file yocto_colorledcluster.h.
| #define Y_MAXLEDCOUNT_INVALID (YAPI_INVALID_UINT) |
Definition at line 56 of file yocto_colorledcluster.h.
Typedef Documentation
| typedef void(* YColorLedClusterValueCallback) (YColorLedCluster *func, const string &functionValue) |
Definition at line 54 of file yocto_colorledcluster.h.
Function Documentation
|
inline |
Retrieves a RGB LED cluster 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 cluster is online at the time it is invoked. The returned object is nevertheless valid. Use the method YColorLedCluster.isOnline() to test if the RGB LED cluster is indeed online at a given time. In case of ambiguity when looking for a RGB LED cluster 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 cluster
- Returns
- a YColorLedCluster object allowing you to drive the RGB LED cluster.
Definition at line 813 of file yocto_colorledcluster.h.
|
inline |
Starts the enumeration of RGB LED clusters currently accessible. Use the method YColorLedCluster.nextColorLedCluster() to iterate on next RGB LED clusters.
- Returns
- a pointer to a YColorLedCluster object, corresponding to the first RGB LED cluster currently online, or a NULL pointer if there are none.
Definition at line 824 of file yocto_colorledcluster.h.