com.yoctopuce.YoctoAPI

Class YLed

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YLed

public class YLed
extends YFunction

YLed Class: monochrome LED control interface, available for instance in the Yocto-Buzzer, the YoctoBox-Short-Thin-Black-Prox, the YoctoBox-Short-Thin-Transp or the YoctoBox-Short-Thin-Transp-Prox The YLed class allows you to drive a monocolor LED. You can not only to drive the intensity of the LED, but also to have it blink at various preset frequencies.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YLed.TimedReportCallback TimedReportCallback for Led
static interface	YLed.UpdateCallback Deprecated UpdateCallback for Led

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_blinking
protected int	_luminosity
protected int	_power
protected YLed.UpdateCallback	_valueCallbackLed
static int	BLINKING_AWARE
static int	BLINKING_CALL
static int	BLINKING_INVALID
static int	BLINKING_PANIC
static int	BLINKING_RELAX
static int	BLINKING_RUN
static int	BLINKING_STILL invalid blinking value
static int	LUMINOSITY_INVALID invalid luminosity value
static int	POWER_INVALID
static int	POWER_OFF invalid power value
static int	POWER_ON

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YLed(String func)
protected	YLed(YAPIContext ctx, String func)

Method Summary

Modifier and Type	Method and Description
int	_invokeValueCallback(String value)
protected void	_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
static YLed	FindLed(String func) Retrieves a monochrome LED for a given identifier.
static YLed	FindLedInContext(YAPIContext yctx, String func) Retrieves a monochrome LED for a given identifier in a YAPI context.
static YLed	FirstLed() Starts the enumeration of monochrome LEDs currently accessible.
static YLed	FirstLedInContext(YAPIContext yctx) Starts the enumeration of monochrome LEDs currently accessible.
int	get_blinking() Returns the current LED signaling mode.
int	get_luminosity() Returns the current LED intensity (in per cent).
int	get_power() Returns the current LED state.
int	getBlinking() Returns the current LED signaling mode.
int	getLuminosity() Returns the current LED intensity (in per cent).
int	getPower() Returns the current LED state.
YLed	nextLed() Continues the enumeration of monochrome LEDs started using yFirstLed().
int	registerValueCallback(YLed.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_blinking(int newval) Changes the current LED signaling mode.
int	set_luminosity(int newval) Changes the current LED intensity (in per cent).
int	set_power(int newval) Changes the state of the LED.
int	setBlinking(int newval) Changes the current LED signaling mode.
int	setLuminosity(int newval) Changes the current LED intensity (in per cent).
int	setPower(int newval) Changes the state of the LED.

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

POWER_OFF

public static final int POWER_OFF

invalid power value

See Also:

Constant Field Values

POWER_ON

public static final int POWER_ON

See Also:

Constant Field Values

POWER_INVALID

public static final int POWER_INVALID

See Also:

Constant Field Values

LUMINOSITY_INVALID

public static final int LUMINOSITY_INVALID

invalid luminosity value

See Also:

Constant Field Values

BLINKING_STILL

public static final int BLINKING_STILL

invalid blinking value

See Also:

Constant Field Values

BLINKING_RELAX

public static final int BLINKING_RELAX

See Also:

Constant Field Values

BLINKING_AWARE

public static final int BLINKING_AWARE

See Also:

Constant Field Values

BLINKING_RUN

public static final int BLINKING_RUN

See Also:

Constant Field Values

BLINKING_CALL

public static final int BLINKING_CALL

See Also:

Constant Field Values

BLINKING_PANIC

public static final int BLINKING_PANIC

See Also:

Constant Field Values

BLINKING_INVALID

public static final int BLINKING_INVALID

See Also:

Constant Field Values

_power

protected int _power

_luminosity

protected int _luminosity

_blinking

protected int _blinking

_valueCallbackLed

protected YLed.UpdateCallback _valueCallbackLed

Constructor Detail

YLed

protected YLed(YAPIContext ctx,
               String func)

Parameters:

func - : functionid

YLed

protected YLed(String func)

Parameters:

func - : functionid

Method Detail

_parseAttr

protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception

Overrides:

_parseAttr in class YFunction

Throws:

Exception

get_power

public int get_power()
              throws YAPI_Exception

Returns the current LED state.

Returns:

either YLed.POWER_OFF or YLed.POWER_ON, according to the current LED state

Throws:

YAPI_Exception - on error

getPower

public int getPower()
             throws YAPI_Exception

Returns the current LED state.

Returns:

either YLed.POWER_OFF or YLed.POWER_ON, according to the current LED state

Throws:

YAPI_Exception - on error

set_power

public int set_power(int newval)
              throws YAPI_Exception

Changes the state of the LED.

Parameters:

newval - : either YLed.POWER_OFF or YLed.POWER_ON, according to the state of the LED

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setPower

public int setPower(int newval)
             throws YAPI_Exception

Changes the state of the LED.

Parameters:

newval - : either YLed.POWER_OFF or YLed.POWER_ON, according to the state of the LED

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_luminosity

public int get_luminosity()
                   throws YAPI_Exception

Returns the current LED intensity (in per cent).

Returns:

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

Throws:

YAPI_Exception - on error

getLuminosity

public int getLuminosity()
                  throws YAPI_Exception

Returns the current LED intensity (in per cent).

Returns:

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

Throws:

YAPI_Exception - on error

set_luminosity

public int set_luminosity(int newval)
                   throws YAPI_Exception

Changes the current LED intensity (in per cent). Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

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

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setLuminosity

public int setLuminosity(int newval)
                  throws YAPI_Exception

Changes the current LED intensity (in per cent). Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

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

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_blinking

public int get_blinking()
                 throws YAPI_Exception

Returns the current LED signaling mode.

Returns:

a value among YLed.BLINKING_STILL, YLed.BLINKING_RELAX, YLed.BLINKING_AWARE, YLed.BLINKING_RUN, YLed.BLINKING_CALL and YLed.BLINKING_PANIC corresponding to the current LED signaling mode

Throws:

YAPI_Exception - on error

getBlinking

public int getBlinking()
                throws YAPI_Exception

Returns the current LED signaling mode.

Returns:

a value among YLed.BLINKING_STILL, YLed.BLINKING_RELAX, YLed.BLINKING_AWARE, YLed.BLINKING_RUN, YLed.BLINKING_CALL and YLed.BLINKING_PANIC corresponding to the current LED signaling mode

Throws:

YAPI_Exception - on error

set_blinking

public int set_blinking(int newval)
                 throws YAPI_Exception

Changes the current LED signaling mode.

Parameters:

newval - : a value among YLed.BLINKING_STILL, YLed.BLINKING_RELAX, YLed.BLINKING_AWARE, YLed.BLINKING_RUN, YLed.BLINKING_CALL and YLed.BLINKING_PANIC corresponding to the current LED signaling mode

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setBlinking

public int setBlinking(int newval)
                throws YAPI_Exception

Changes the current LED signaling mode.

Parameters:

newval - : a value among YLed.BLINKING_STILL, YLed.BLINKING_RELAX, YLed.BLINKING_AWARE, YLed.BLINKING_RUN, YLed.BLINKING_CALL and YLed.BLINKING_PANIC corresponding to the current LED signaling mode

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

FindLed

public static YLed FindLed(String func)

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

Returns:

a YLed object allowing you to drive the monochrome LED.

FindLedInContext

public static YLed FindLedInContext(YAPIContext yctx,
                                    String func)

Retrieves a monochrome LED for a given identifier in a YAPI context. The identifier can be specified using several formats:

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

This function does not require that the monochrome LED is online at the time it is invoked. The returned object is nevertheless valid. Use the method YLed.isOnline() to test if the monochrome LED is indeed online at a given time. In case of ambiguity when looking for a monochrome 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.

Parameters:

yctx - : a YAPI context

func - : a string that uniquely characterizes the monochrome LED, for instance YBUZZER2.led1.

Returns:

a YLed object allowing you to drive the monochrome LED.

registerValueCallback

public int registerValueCallback(YLed.UpdateCallback callback)

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.

_invokeValueCallback

public int _invokeValueCallback(String value)

Overrides:

_invokeValueCallback in class YFunction

nextLed

public YLed nextLed()

Continues the enumeration of monochrome LEDs started using yFirstLed(). Caution: You can't make any assumption about the returned monochrome LEDs order. If you want to find a specific a monochrome LED, use Led.findLed() and a hardwareID or a logical name.

Returns:

a pointer to a YLed object, corresponding to a monochrome LED currently online, or a null pointer if there are no more monochrome LEDs to enumerate.

FirstLed

public static YLed FirstLed()

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

Returns:

a pointer to a YLed object, corresponding to the first monochrome LED currently online, or a null pointer if there are none.

FirstLedInContext

public static YLed FirstLedInContext(YAPIContext yctx)

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

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YLed object, corresponding to the first monochrome LED currently online, or a null pointer if there are none.