com.yoctopuce.YoctoAPI

Class YOsControl

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YOsControl

public class YOsControl
extends YFunction

YOsControl Class: Operating system control interface via the VirtualHub application The YOScontrol class provides some control over the operating system running a VirtualHub. YOsControl is available on VirtualHub software only. This feature must be activated at the VirtualHub start up with -o option.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YOsControl.TimedReportCallback TimedReportCallback for OsControl
static interface	YOsControl.UpdateCallback Deprecated UpdateCallback for OsControl

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_shutdownCountdown
protected YOsControl.UpdateCallback	_valueCallbackOsControl
static int	SHUTDOWNCOUNTDOWN_INVALID invalid shutdownCountdown value

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	YOsControl(String func)
protected	YOsControl(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 YOsControl	FindOsControl(String func) Retrieves OS control for a given identifier.
static YOsControl	FindOsControlInContext(YAPIContext yctx, String func) Retrieves OS control for a given identifier in a YAPI context.
static YOsControl	FirstOsControl() Starts the enumeration of OS control currently accessible.
static YOsControl	FirstOsControlInContext(YAPIContext yctx) Starts the enumeration of OS control currently accessible.
int	get_shutdownCountdown() Returns the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled.
int	getShutdownCountdown() Returns the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled.
YOsControl	nextOsControl() Continues the enumeration of OS control started using yFirstOsControl().
int	reboot(int secBeforeReboot) Schedules an OS reboot after a given number of seconds.
int	registerValueCallback(YOsControl.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_shutdownCountdown(int newval)
int	shutdown(int secBeforeShutDown) Schedules an OS shutdown after a given number of seconds.

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

SHUTDOWNCOUNTDOWN_INVALID

public static final int SHUTDOWNCOUNTDOWN_INVALID

invalid shutdownCountdown value

See Also:

Constant Field Values

_shutdownCountdown

protected int _shutdownCountdown

_valueCallbackOsControl

protected YOsControl.UpdateCallback _valueCallbackOsControl

Constructor Detail

YOsControl

protected YOsControl(YAPIContext ctx,
                     String func)

Parameters:

func - : functionid

YOsControl

protected YOsControl(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_shutdownCountdown

public int get_shutdownCountdown()
                          throws YAPI_Exception

Returns the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled.

Returns:

an integer corresponding to the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled

Throws:

YAPI_Exception - on error

getShutdownCountdown

public int getShutdownCountdown()
                         throws YAPI_Exception

Returns the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled.

Returns:

an integer corresponding to the remaining number of seconds before the OS shutdown, or zero when no shutdown has been scheduled

Throws:

YAPI_Exception - on error

set_shutdownCountdown

public int set_shutdownCountdown(int newval)
                          throws YAPI_Exception

Throws:

YAPI_Exception

FindOsControl

public static YOsControl FindOsControl(String func)

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

Returns:

a YOsControl object allowing you to drive the OS control.

FindOsControlInContext

public static YOsControl FindOsControlInContext(YAPIContext yctx,
                                                String func)

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

Returns:

a YOsControl object allowing you to drive the OS control.

registerValueCallback

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

shutdown

public int shutdown(int secBeforeShutDown)
             throws YAPI_Exception

Schedules an OS shutdown after a given number of seconds.

Parameters:

secBeforeShutDown - : number of seconds before shutdown

Returns:

YAPI.SUCCESS when the call succeeds.

Throws:

YAPI_Exception - on error

reboot

public int reboot(int secBeforeReboot)
           throws YAPI_Exception

Schedules an OS reboot after a given number of seconds.

Parameters:

secBeforeReboot - : number of seconds before reboot

Returns:

YAPI.SUCCESS when the call succeeds.

Throws:

YAPI_Exception - on error

nextOsControl

public YOsControl nextOsControl()

Continues the enumeration of OS control started using yFirstOsControl(). Caution: You can't make any assumption about the returned OS control order. If you want to find a specific OS control, use OsControl.findOsControl() and a hardwareID or a logical name.

Returns:

a pointer to a YOsControl object, corresponding to OS control currently online, or a null pointer if there are no more OS control to enumerate.

FirstOsControl

public static YOsControl FirstOsControl()

Starts the enumeration of OS control currently accessible. Use the method YOsControl.nextOsControl() to iterate on next OS control.

Returns:

a pointer to a YOsControl object, corresponding to the first OS control currently online, or a null pointer if there are none.

FirstOsControlInContext

public static YOsControl FirstOsControlInContext(YAPIContext yctx)

Starts the enumeration of OS control currently accessible. Use the method YOsControl.nextOsControl() to iterate on next OS control.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YOsControl object, corresponding to the first OS control currently online, or a null pointer if there are none.