com.yoctopuce.YoctoAPI

Class YDualPower

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YDualPower

public class YDualPower
extends YFunction

YDualPower Class: dual power switch control interface, available for instance in the Yocto-Servo The YDualPower class allows you to control the power source to use for module functions that require high current. The module can also automatically disconnect the external power when a voltage drop is observed on the external power source (external battery running out of power).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YDualPower.TimedReportCallback TimedReportCallback for DualPower
static interface	YDualPower.UpdateCallback Deprecated UpdateCallback for DualPower

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_extVoltage
protected int	_powerControl
protected int	_powerState
protected YDualPower.UpdateCallback	_valueCallbackDualPower
static int	EXTVOLTAGE_INVALID invalid extVoltage value
static int	POWERCONTROL_AUTO invalid powerControl value
static int	POWERCONTROL_FROM_EXT
static int	POWERCONTROL_FROM_USB
static int	POWERCONTROL_INVALID
static int	POWERCONTROL_OFF
static int	POWERSTATE_FROM_EXT
static int	POWERSTATE_FROM_USB
static int	POWERSTATE_INVALID
static int	POWERSTATE_OFF invalid powerState 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	YDualPower(String func)
protected	YDualPower(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 YDualPower	FindDualPower(String func) Retrieves a dual power switch for a given identifier.
static YDualPower	FindDualPowerInContext(YAPIContext yctx, String func) Retrieves a dual power switch for a given identifier in a YAPI context.
static YDualPower	FirstDualPower() Starts the enumeration of dual power switches currently accessible.
static YDualPower	FirstDualPowerInContext(YAPIContext yctx) Starts the enumeration of dual power switches currently accessible.
int	get_extVoltage() Returns the measured voltage on the external power source, in millivolts.
int	get_powerControl() Returns the selected power source for module functions that require lots of current.
int	get_powerState() Returns the current power source for module functions that require lots of current.
int	getExtVoltage() Returns the measured voltage on the external power source, in millivolts.
int	getPowerControl() Returns the selected power source for module functions that require lots of current.
int	getPowerState() Returns the current power source for module functions that require lots of current.
YDualPower	nextDualPower() Continues the enumeration of dual power switches started using yFirstDualPower().
int	registerValueCallback(YDualPower.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_powerControl(int newval) Changes the selected power source for module functions that require lots of current.
int	setPowerControl(int newval) Changes the selected power source for module functions that require lots of current.

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

POWERSTATE_OFF

public static final int POWERSTATE_OFF

invalid powerState value

See Also:

Constant Field Values

POWERSTATE_FROM_USB

public static final int POWERSTATE_FROM_USB

See Also:

Constant Field Values

POWERSTATE_FROM_EXT

public static final int POWERSTATE_FROM_EXT

See Also:

Constant Field Values

POWERSTATE_INVALID

public static final int POWERSTATE_INVALID

See Also:

Constant Field Values

POWERCONTROL_AUTO

public static final int POWERCONTROL_AUTO

invalid powerControl value

See Also:

Constant Field Values

POWERCONTROL_FROM_USB

public static final int POWERCONTROL_FROM_USB

See Also:

Constant Field Values

POWERCONTROL_FROM_EXT

public static final int POWERCONTROL_FROM_EXT

See Also:

Constant Field Values

POWERCONTROL_OFF

public static final int POWERCONTROL_OFF

See Also:

Constant Field Values

POWERCONTROL_INVALID

public static final int POWERCONTROL_INVALID

See Also:

Constant Field Values

EXTVOLTAGE_INVALID

public static final int EXTVOLTAGE_INVALID

invalid extVoltage value

See Also:

Constant Field Values

_powerState

protected int _powerState

_powerControl

protected int _powerControl

_extVoltage

protected int _extVoltage

_valueCallbackDualPower

protected YDualPower.UpdateCallback _valueCallbackDualPower

Constructor Detail

YDualPower

protected YDualPower(YAPIContext ctx,
                     String func)

Parameters:

func - : functionid

YDualPower

protected YDualPower(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_powerState

public int get_powerState()
                   throws YAPI_Exception

Returns the current power source for module functions that require lots of current.

Returns:

a value among YDualPower.POWERSTATE_OFF, YDualPower.POWERSTATE_FROM_USB and YDualPower.POWERSTATE_FROM_EXT corresponding to the current power source for module functions that require lots of current

Throws:

YAPI_Exception - on error

getPowerState

public int getPowerState()
                  throws YAPI_Exception

Returns the current power source for module functions that require lots of current.

Returns:

a value among YDualPower.POWERSTATE_OFF, YDualPower.POWERSTATE_FROM_USB and YDualPower.POWERSTATE_FROM_EXT corresponding to the current power source for module functions that require lots of current

Throws:

YAPI_Exception - on error

get_powerControl

public int get_powerControl()
                     throws YAPI_Exception

Returns the selected power source for module functions that require lots of current.

Returns:

a value among YDualPower.POWERCONTROL_AUTO, YDualPower.POWERCONTROL_FROM_USB, YDualPower.POWERCONTROL_FROM_EXT and YDualPower.POWERCONTROL_OFF corresponding to the selected power source for module functions that require lots of current

Throws:

YAPI_Exception - on error

getPowerControl

public int getPowerControl()
                    throws YAPI_Exception

Returns the selected power source for module functions that require lots of current.

Returns:

a value among YDualPower.POWERCONTROL_AUTO, YDualPower.POWERCONTROL_FROM_USB, YDualPower.POWERCONTROL_FROM_EXT and YDualPower.POWERCONTROL_OFF corresponding to the selected power source for module functions that require lots of current

Throws:

YAPI_Exception - on error

set_powerControl

public int set_powerControl(int newval)
                     throws YAPI_Exception

Changes the selected power source for module functions that require lots of current. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a value among YDualPower.POWERCONTROL_AUTO, YDualPower.POWERCONTROL_FROM_USB, YDualPower.POWERCONTROL_FROM_EXT and YDualPower.POWERCONTROL_OFF corresponding to the selected power source for module functions that require lots of current

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setPowerControl

public int setPowerControl(int newval)
                    throws YAPI_Exception

Changes the selected power source for module functions that require lots of current. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a value among YDualPower.POWERCONTROL_AUTO, YDualPower.POWERCONTROL_FROM_USB, YDualPower.POWERCONTROL_FROM_EXT and YDualPower.POWERCONTROL_OFF corresponding to the selected power source for module functions that require lots of current

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_extVoltage

public int get_extVoltage()
                   throws YAPI_Exception

Returns the measured voltage on the external power source, in millivolts.

Returns:

an integer corresponding to the measured voltage on the external power source, in millivolts

Throws:

YAPI_Exception - on error

getExtVoltage

public int getExtVoltage()
                  throws YAPI_Exception

Returns the measured voltage on the external power source, in millivolts.

Returns:

an integer corresponding to the measured voltage on the external power source, in millivolts

Throws:

YAPI_Exception - on error

FindDualPower

public static YDualPower FindDualPower(String func)

Retrieves a dual power switch 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 dual power switch is online at the time it is invoked. The returned object is nevertheless valid. Use the method YDualPower.isOnline() to test if the dual power switch is indeed online at a given time. In case of ambiguity when looking for a dual power switch 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 dual power switch, for instance SERVORC1.dualPower.

Returns:

a YDualPower object allowing you to drive the dual power switch.

FindDualPowerInContext

public static YDualPower FindDualPowerInContext(YAPIContext yctx,
                                                String func)

Retrieves a dual power switch 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 dual power switch is online at the time it is invoked. The returned object is nevertheless valid. Use the method YDualPower.isOnline() to test if the dual power switch is indeed online at a given time. In case of ambiguity when looking for a dual power switch 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 dual power switch, for instance SERVORC1.dualPower.

Returns:

a YDualPower object allowing you to drive the dual power switch.

registerValueCallback

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

nextDualPower

public YDualPower nextDualPower()

Continues the enumeration of dual power switches started using yFirstDualPower(). Caution: You can't make any assumption about the returned dual power switches order. If you want to find a specific a dual power switch, use DualPower.findDualPower() and a hardwareID or a logical name.

Returns:

a pointer to a YDualPower object, corresponding to a dual power switch currently online, or a null pointer if there are no more dual power switches to enumerate.

FirstDualPower

public static YDualPower FirstDualPower()

Starts the enumeration of dual power switches currently accessible. Use the method YDualPower.nextDualPower() to iterate on next dual power switches.

Returns:

a pointer to a YDualPower object, corresponding to the first dual power switch currently online, or a null pointer if there are none.

FirstDualPowerInContext

public static YDualPower FirstDualPowerInContext(YAPIContext yctx)

Starts the enumeration of dual power switches currently accessible. Use the method YDualPower.nextDualPower() to iterate on next dual power switches.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YDualPower object, corresponding to the first dual power switch currently online, or a null pointer if there are none.