com.yoctopuce.YoctoAPI

Class YPowerOutput

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YPowerOutput

public class YPowerOutput
extends YFunction

YPowerOutput Class: power output control interface, available for instance in the Yocto-I2C, the Yocto-MaxiMicroVolt-Rx, the Yocto-SPI or the Yocto-Serial The YPowerOutput class allows you to control the power output featured on some Yoctopuce devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YPowerOutput.TimedReportCallback TimedReportCallback for PowerOutput
static interface	YPowerOutput.UpdateCallback Deprecated UpdateCallback for PowerOutput

Field Summary

Fields

Modifier and Type	Field and Description
protected YPowerOutput.UpdateCallback	_valueCallbackPowerOutput
protected int	_voltage
static int	VOLTAGE_INVALID
static int	VOLTAGE_OFF invalid voltage value
static int	VOLTAGE_OUT1V8
static int	VOLTAGE_OUT3V3
static int	VOLTAGE_OUT4V7
static int	VOLTAGE_OUT5V

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	YPowerOutput(String func)
protected	YPowerOutput(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 YPowerOutput	FindPowerOutput(String func) Retrieves a power output for a given identifier.
static YPowerOutput	FindPowerOutputInContext(YAPIContext yctx, String func) Retrieves a power output for a given identifier in a YAPI context.
static YPowerOutput	FirstPowerOutput() Starts the enumeration of power output currently accessible.
static YPowerOutput	FirstPowerOutputInContext(YAPIContext yctx) Starts the enumeration of power output currently accessible.
int	get_voltage() Returns the voltage on the power output featured by the module.
int	getVoltage() Returns the voltage on the power output featured by the module.
YPowerOutput	nextPowerOutput() Continues the enumeration of power output started using yFirstPowerOutput().
int	registerValueCallback(YPowerOutput.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_voltage(int newval) Changes the voltage on the power output provided by the module.
int	setVoltage(int newval) Changes the voltage on the power output provided by the module.

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

VOLTAGE_OFF

public static final int VOLTAGE_OFF

invalid voltage value

See Also:

Constant Field Values

VOLTAGE_OUT3V3

public static final int VOLTAGE_OUT3V3

See Also:

Constant Field Values

VOLTAGE_OUT5V

public static final int VOLTAGE_OUT5V

See Also:

Constant Field Values

VOLTAGE_OUT4V7

public static final int VOLTAGE_OUT4V7

See Also:

Constant Field Values

VOLTAGE_OUT1V8

public static final int VOLTAGE_OUT1V8

See Also:

Constant Field Values

VOLTAGE_INVALID

public static final int VOLTAGE_INVALID

See Also:

Constant Field Values

_voltage

protected int _voltage

_valueCallbackPowerOutput

protected YPowerOutput.UpdateCallback _valueCallbackPowerOutput

Constructor Detail

YPowerOutput

protected YPowerOutput(YAPIContext ctx,
                       String func)

Parameters:

func - : functionid

YPowerOutput

protected YPowerOutput(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_voltage

public int get_voltage()
                throws YAPI_Exception

Returns the voltage on the power output featured by the module.

Returns:

a value among YPowerOutput.VOLTAGE_OFF, YPowerOutput.VOLTAGE_OUT3V3, YPowerOutput.VOLTAGE_OUT5V, YPowerOutput.VOLTAGE_OUT4V7 and YPowerOutput.VOLTAGE_OUT1V8 corresponding to the voltage on the power output featured by the module

Throws:

YAPI_Exception - on error

getVoltage

public int getVoltage()
               throws YAPI_Exception

Returns the voltage on the power output featured by the module.

Returns:

a value among YPowerOutput.VOLTAGE_OFF, YPowerOutput.VOLTAGE_OUT3V3, YPowerOutput.VOLTAGE_OUT5V, YPowerOutput.VOLTAGE_OUT4V7 and YPowerOutput.VOLTAGE_OUT1V8 corresponding to the voltage on the power output featured by the module

Throws:

YAPI_Exception - on error

set_voltage

public int set_voltage(int newval)
                throws YAPI_Exception

Changes the voltage on the power output provided by the module. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a value among YPowerOutput.VOLTAGE_OFF, YPowerOutput.VOLTAGE_OUT3V3, YPowerOutput.VOLTAGE_OUT5V, YPowerOutput.VOLTAGE_OUT4V7 and YPowerOutput.VOLTAGE_OUT1V8 corresponding to the voltage on the power output provided by the module

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setVoltage

public int setVoltage(int newval)
               throws YAPI_Exception

Changes the voltage on the power output provided by the module. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a value among YPowerOutput.VOLTAGE_OFF, YPowerOutput.VOLTAGE_OUT3V3, YPowerOutput.VOLTAGE_OUT5V, YPowerOutput.VOLTAGE_OUT4V7 and YPowerOutput.VOLTAGE_OUT1V8 corresponding to the voltage on the power output provided by the module

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

FindPowerOutput

public static YPowerOutput FindPowerOutput(String func)

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

Returns:

a YPowerOutput object allowing you to drive the power output.

FindPowerOutputInContext

public static YPowerOutput FindPowerOutputInContext(YAPIContext yctx,
                                                    String func)

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

Returns:

a YPowerOutput object allowing you to drive the power output.

registerValueCallback

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

nextPowerOutput

public YPowerOutput nextPowerOutput()

Continues the enumeration of power output started using yFirstPowerOutput(). Caution: You can't make any assumption about the returned power output order. If you want to find a specific a power output, use PowerOutput.findPowerOutput() and a hardwareID or a logical name.

Returns:

a pointer to a YPowerOutput object, corresponding to a power output currently online, or a null pointer if there are no more power output to enumerate.

FirstPowerOutput

public static YPowerOutput FirstPowerOutput()

Starts the enumeration of power output currently accessible. Use the method YPowerOutput.nextPowerOutput() to iterate on next power output.

Returns:

a pointer to a YPowerOutput object, corresponding to the first power output currently online, or a null pointer if there are none.

FirstPowerOutputInContext

public static YPowerOutput FirstPowerOutputInContext(YAPIContext yctx)

Starts the enumeration of power output currently accessible. Use the method YPowerOutput.nextPowerOutput() to iterate on next power output.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YPowerOutput object, corresponding to the first power output currently online, or a null pointer if there are none.