com.yoctopuce.YoctoAPI

Class YSegmentedDisplay

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSegmentedDisplay

public class YSegmentedDisplay
extends YFunction

YSegmentedDisplay Class: segmented display control interface The SegmentedDisplay class allows you to drive segmented displays.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YSegmentedDisplay.TimedReportCallback TimedReportCallback for SegmentedDisplay
static interface	YSegmentedDisplay.UpdateCallback Deprecated UpdateCallback for SegmentedDisplay

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_displayedText
protected int	_displayMode
protected YSegmentedDisplay.UpdateCallback	_valueCallbackSegmentedDisplay
static String	DISPLAYEDTEXT_INVALID invalid displayedText value
static int	DISPLAYMODE_AUTO1
static int	DISPLAYMODE_AUTO60
static int	DISPLAYMODE_DISCONNECTED invalid displayMode value
static int	DISPLAYMODE_INVALID
static int	DISPLAYMODE_MANUAL

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	YSegmentedDisplay(String func)
protected	YSegmentedDisplay(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 YSegmentedDisplay	FindSegmentedDisplay(String func) Retrieves a segmented display for a given identifier.
static YSegmentedDisplay	FindSegmentedDisplayInContext(YAPIContext yctx, String func) Retrieves a segmented display for a given identifier in a YAPI context.
static YSegmentedDisplay	FirstSegmentedDisplay() Starts the enumeration of segmented displays currently accessible.
static YSegmentedDisplay	FirstSegmentedDisplayInContext(YAPIContext yctx) Starts the enumeration of segmented displays currently accessible.
String	get_displayedText() Returns the text currently displayed on the screen.
int	get_displayMode()
String	getDisplayedText() Returns the text currently displayed on the screen.
YSegmentedDisplay	nextSegmentedDisplay() Continues the enumeration of segmented displays started using yFirstSegmentedDisplay().
int	registerValueCallback(YSegmentedDisplay.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_displayedText(String newval) Changes the text currently displayed on the screen.
int	set_displayMode(int newval)
int	setDisplayedText(String newval) Changes the text currently displayed on the screen.

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

DISPLAYEDTEXT_INVALID

public static final String DISPLAYEDTEXT_INVALID

invalid displayedText value

See Also:

Constant Field Values

DISPLAYMODE_DISCONNECTED

public static final int DISPLAYMODE_DISCONNECTED

invalid displayMode value

See Also:

Constant Field Values

DISPLAYMODE_MANUAL

public static final int DISPLAYMODE_MANUAL

See Also:

Constant Field Values

DISPLAYMODE_AUTO1

public static final int DISPLAYMODE_AUTO1

See Also:

Constant Field Values

DISPLAYMODE_AUTO60

public static final int DISPLAYMODE_AUTO60

See Also:

Constant Field Values

DISPLAYMODE_INVALID

public static final int DISPLAYMODE_INVALID

See Also:

Constant Field Values

_displayedText

protected String _displayedText

_displayMode

protected int _displayMode

_valueCallbackSegmentedDisplay

protected YSegmentedDisplay.UpdateCallback _valueCallbackSegmentedDisplay

Constructor Detail

YSegmentedDisplay

protected YSegmentedDisplay(YAPIContext ctx,
                            String func)

Parameters:

func - : functionid

YSegmentedDisplay

protected YSegmentedDisplay(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_displayedText

public String get_displayedText()
                         throws YAPI_Exception

Returns the text currently displayed on the screen.

Returns:

a string corresponding to the text currently displayed on the screen

Throws:

YAPI_Exception - on error

getDisplayedText

public String getDisplayedText()
                        throws YAPI_Exception

Returns the text currently displayed on the screen.

Returns:

a string corresponding to the text currently displayed on the screen

Throws:

YAPI_Exception - on error

set_displayedText

public int set_displayedText(String newval)
                      throws YAPI_Exception

Changes the text currently displayed on the screen.

Parameters:

newval - : a string corresponding to the text currently displayed on the screen

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setDisplayedText

public int setDisplayedText(String newval)
                     throws YAPI_Exception

Changes the text currently displayed on the screen.

Parameters:

newval - : a string corresponding to the text currently displayed on the screen

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_displayMode

public int get_displayMode()
                    throws YAPI_Exception

Throws:

YAPI_Exception

set_displayMode

public int set_displayMode(int newval)
                    throws YAPI_Exception

Throws:

YAPI_Exception

FindSegmentedDisplay

public static YSegmentedDisplay FindSegmentedDisplay(String func)

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

Returns:

a YSegmentedDisplay object allowing you to drive the segmented display.

FindSegmentedDisplayInContext

public static YSegmentedDisplay FindSegmentedDisplayInContext(YAPIContext yctx,
                                                              String func)

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

Returns:

a YSegmentedDisplay object allowing you to drive the segmented display.

registerValueCallback

public int registerValueCallback(YSegmentedDisplay.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

nextSegmentedDisplay

public YSegmentedDisplay nextSegmentedDisplay()

Continues the enumeration of segmented displays started using yFirstSegmentedDisplay(). Caution: You can't make any assumption about the returned segmented displays order. If you want to find a specific a segmented display, use SegmentedDisplay.findSegmentedDisplay() and a hardwareID or a logical name.

Returns:

a pointer to a YSegmentedDisplay object, corresponding to a segmented display currently online, or a null pointer if there are no more segmented displays to enumerate.

FirstSegmentedDisplay

public static YSegmentedDisplay FirstSegmentedDisplay()

Starts the enumeration of segmented displays currently accessible. Use the method YSegmentedDisplay.nextSegmentedDisplay() to iterate on next segmented displays.

Returns:

a pointer to a YSegmentedDisplay object, corresponding to the first segmented display currently online, or a null pointer if there are none.

FirstSegmentedDisplayInContext

public static YSegmentedDisplay FirstSegmentedDisplayInContext(YAPIContext yctx)

Starts the enumeration of segmented displays currently accessible. Use the method YSegmentedDisplay.nextSegmentedDisplay() to iterate on next segmented displays.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YSegmentedDisplay object, corresponding to the first segmented display currently online, or a null pointer if there are none.