YPowerSupply (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YPowerSupply

```
public class YPowerSupply
extends YFunction
```
YPowerSupply Class: regulated power supply control interface The YPowerSupply class allows you to drive a Yoctopuce power supply. It can be use to change the voltage and current limits, and to enable/disable the output.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YPowerSupply.TimedReportCallback` TimedReportCallback for PowerSupply
`static interface`	`YPowerSupply.UpdateCallback` Deprecated UpdateCallback for PowerSupply

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_command`
`protected double`	`_currentLimit`
`protected double`	`_currentLimitAtStartUp`
`protected double`	`_inputVoltage`
`protected double`	`_measuredCurrent`
`protected double`	`_measuredVoltage`
`protected int`	`_powerOutput`
`protected int`	`_powerOutputAtStartUp`
`protected YPowerSupply.UpdateCallback`	`_valueCallbackPowerSupply`
`protected double`	`_voltageLimit`
`protected double`	`_voltageLimitAtStartUp`
`protected String`	`_voltageTransition`
`static String`	`COMMAND_INVALID` invalid command value
`static double`	`CURRENTLIMIT_INVALID` invalid currentLimit value
`static double`	`CURRENTLIMITATSTARTUP_INVALID` invalid currentLimitAtStartUp value
`static double`	`INPUTVOLTAGE_INVALID` invalid inputVoltage value
`static double`	`MEASUREDCURRENT_INVALID` invalid measuredCurrent value
`static double`	`MEASUREDVOLTAGE_INVALID` invalid measuredVoltage value
`static int`	`POWEROUTPUT_INVALID`
`static int`	`POWEROUTPUT_OFF` invalid powerOutput value
`static int`	`POWEROUTPUT_ON`
`static int`	`POWEROUTPUTATSTARTUP_INVALID`
`static int`	`POWEROUTPUTATSTARTUP_OFF` invalid powerOutputAtStartUp value
`static int`	`POWEROUTPUTATSTARTUP_ON`
`static double`	`VOLTAGELIMIT_INVALID` invalid voltageLimit value
`static double`	`VOLTAGELIMITATSTARTUP_INVALID` invalid voltageLimitAtStartUp value
`static String`	`VOLTAGETRANSITION_INVALID` invalid voltageTransition 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 YPowerSupply(String func)

protected YPowerSupply(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YPowerSupply(String func)`
`protected`	`YPowerSupply(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`static YPowerSupply`	`FindPowerSupply(String func)` Retrieves a regulated power supply for a given identifier.
`static YPowerSupply`	`FindPowerSupplyInContext(YAPIContext yctx, String func)` Retrieves a regulated power supply for a given identifier in a YAPI context.
`static YPowerSupply`	`FirstPowerSupply()` Starts the enumeration of regulated power supplies currently accessible.
`static YPowerSupply`	`FirstPowerSupplyInContext(YAPIContext yctx)` Starts the enumeration of regulated power supplies currently accessible.
`String`	`get_command()`
`double`	`get_currentLimit()` Returns the current limit, in mA.
`double`	`get_currentLimitAtStartUp()` Returns the selected current limit at device startup, in mA.
`double`	`get_inputVoltage()` Returns the measured input voltage, in V.
`double`	`get_measuredCurrent()` Returns the measured output current, in mA.
`double`	`get_measuredVoltage()` Returns the measured output voltage, in V.
`int`	`get_powerOutput()` Returns the power supply output switch state.
`int`	`get_powerOutputAtStartUp()` Returns the power supply output switch state.
`double`	`get_voltageLimit()` Returns the voltage limit, in V.
`double`	`get_voltageLimitAtStartUp()` Returns the selected voltage limit at device startup, in V.
`String`	`get_voltageTransition()`
`double`	`getCurrentLimit()` Returns the current limit, in mA.
`double`	`getCurrentLimitAtStartUp()` Returns the selected current limit at device startup, in mA.
`double`	`getInputVoltage()` Returns the measured input voltage, in V.
`double`	`getMeasuredCurrent()` Returns the measured output current, in mA.
`double`	`getMeasuredVoltage()` Returns the measured output voltage, in V.
`int`	`getPowerOutput()` Returns the power supply output switch state.
`int`	`getPowerOutputAtStartUp()` Returns the power supply output switch state.
`double`	`getVoltageLimit()` Returns the voltage limit, in V.
`double`	`getVoltageLimitAtStartUp()` Returns the selected voltage limit at device startup, in V.
`YPowerSupply`	`nextPowerSupply()` Continues the enumeration of regulated power supplies started using yFirstPowerSupply().
`int`	`registerValueCallback(YPowerSupply.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`set_command(String newval)`
`int`	`set_currentLimit(double newval)` Changes the current limit, in mA.
`int`	`set_currentLimitAtStartUp(double newval)` Changes the current limit at device start up.
`int`	`set_powerOutput(int newval)` Changes the power supply output switch state.
`int`	`set_powerOutputAtStartUp(int newval)` Changes the power supply output switch state at device start up.
`int`	`set_voltageLimit(double newval)` Changes the voltage limit, in V.
`int`	`set_voltageLimitAtStartUp(double newval)` Changes the voltage set point at device start up.
`int`	`set_voltageTransition(String newval)`
`int`	`setCurrentLimit(double newval)` Changes the current limit, in mA.
`int`	`setCurrentLimitAtStartUp(double newval)` Changes the current limit at device start up.
`int`	`setPowerOutput(int newval)` Changes the power supply output switch state.
`int`	`setPowerOutputAtStartUp(int newval)` Changes the power supply output switch state at device start up.
`int`	`setVoltageLimit(double newval)` Changes the voltage limit, in V.
`int`	`setVoltageLimitAtStartUp(double newval)` Changes the voltage set point at device start up.
`int`	`voltageMove(double V_target, int ms_duration)` Performs a smooth transition of output voltage.

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
  - VOLTAGELIMIT_INVALID
```
public static final double VOLTAGELIMIT_INVALID
```
    invalid voltageLimit value
    
    See Also:
    
    Constant Field Values
  - CURRENTLIMIT_INVALID
```
public static final double CURRENTLIMIT_INVALID
```
    invalid currentLimit value
    
    See Also:
    
    Constant Field Values
  - POWEROUTPUT_OFF
```
public static final int POWEROUTPUT_OFF
```
    invalid powerOutput value
    
    See Also:
    
    Constant Field Values
  - POWEROUTPUT_ON
```
public static final int POWEROUTPUT_ON
```
    See Also:
    
    Constant Field Values
  - POWEROUTPUT_INVALID
```
public static final int POWEROUTPUT_INVALID
```
    See Also:
    
    Constant Field Values
  - MEASUREDVOLTAGE_INVALID
```
public static final double MEASUREDVOLTAGE_INVALID
```
    invalid measuredVoltage value
    
    See Also:
    
    Constant Field Values
  - MEASUREDCURRENT_INVALID
```
public static final double MEASUREDCURRENT_INVALID
```
    invalid measuredCurrent value
    
    See Also:
    
    Constant Field Values
  - INPUTVOLTAGE_INVALID
```
public static final double INPUTVOLTAGE_INVALID
```
    invalid inputVoltage value
    
    See Also:
    
    Constant Field Values
  - VOLTAGETRANSITION_INVALID
```
public static final String VOLTAGETRANSITION_INVALID
```
    invalid voltageTransition value
    
    See Also:
    
    Constant Field Values
  - VOLTAGELIMITATSTARTUP_INVALID
```
public static final double VOLTAGELIMITATSTARTUP_INVALID
```
    invalid voltageLimitAtStartUp value
    
    See Also:
    
    Constant Field Values
  - CURRENTLIMITATSTARTUP_INVALID
```
public static final double CURRENTLIMITATSTARTUP_INVALID
```
    invalid currentLimitAtStartUp value
    
    See Also:
    
    Constant Field Values
  - POWEROUTPUTATSTARTUP_OFF
```
public static final int POWEROUTPUTATSTARTUP_OFF
```
    invalid powerOutputAtStartUp value
    
    See Also:
    
    Constant Field Values
  - POWEROUTPUTATSTARTUP_ON
```
public static final int POWEROUTPUTATSTARTUP_ON
```
    See Also:
    
    Constant Field Values
  - POWEROUTPUTATSTARTUP_INVALID
```
public static final int POWEROUTPUTATSTARTUP_INVALID
```
    See Also:
    
    Constant Field Values
  - COMMAND_INVALID
```
public static final String COMMAND_INVALID
```
    invalid command value
    
    See Also:
    
    Constant Field Values
  - _voltageLimit
```
protected double _voltageLimit
```
  - _currentLimit
```
protected double _currentLimit
```
  - _powerOutput
```
protected int _powerOutput
```
  - _measuredVoltage
```
protected double _measuredVoltage
```
  - _measuredCurrent
```
protected double _measuredCurrent
```
  - _inputVoltage
```
protected double _inputVoltage
```
  - _voltageTransition
```
protected String _voltageTransition
```
  - _voltageLimitAtStartUp
```
protected double _voltageLimitAtStartUp
```
  - _currentLimitAtStartUp
```
protected double _currentLimitAtStartUp
```
  - _powerOutputAtStartUp
```
protected int _powerOutputAtStartUp
```
  - _command
```
protected String _command
```
  - _valueCallbackPowerSupply
```
protected YPowerSupply.UpdateCallback _valueCallbackPowerSupply
```
- Constructor Detail
  - YPowerSupply
```
protected YPowerSupply(YAPIContext ctx,
                       String func)
```
    Parameters:
    
    func - : functionid
  - YPowerSupply
```
protected YPowerSupply(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
  - set_voltageLimit
```
public int set_voltageLimit(double newval)
                     throws YAPI_Exception
```
    Changes the voltage limit, in V.
    
    Parameters:
    
    newval - : a floating point number corresponding to the voltage limit, in V
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setVoltageLimit
```
public int setVoltageLimit(double newval)
                    throws YAPI_Exception
```
    Changes the voltage limit, in V.
    
    Parameters:
    
    newval - : a floating point number corresponding to the voltage limit, in V
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_voltageLimit
```
public double get_voltageLimit()
                        throws YAPI_Exception
```
    Returns the voltage limit, in V.
    
    Returns:
    
    a floating point number corresponding to the voltage limit, in V
    
    Throws:
    
    YAPI_Exception - on error
  - getVoltageLimit
```
public double getVoltageLimit()
                       throws YAPI_Exception
```
    Returns the voltage limit, in V.
    
    Returns:
    
    a floating point number corresponding to the voltage limit, in V
    
    Throws:
    
    YAPI_Exception - on error
  - set_currentLimit
```
public int set_currentLimit(double newval)
                     throws YAPI_Exception
```
    Changes the current limit, in mA.
    
    Parameters:
    
    newval - : a floating point number corresponding to the current limit, in mA
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCurrentLimit
```
public int setCurrentLimit(double newval)
                    throws YAPI_Exception
```
    Changes the current limit, in mA.
    
    Parameters:
    
    newval - : a floating point number corresponding to the current limit, in mA
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_currentLimit
```
public double get_currentLimit()
                        throws YAPI_Exception
```
    Returns the current limit, in mA.
    
    Returns:
    
    a floating point number corresponding to the current limit, in mA
    
    Throws:
    
    YAPI_Exception - on error
  - getCurrentLimit
```
public double getCurrentLimit()
                       throws YAPI_Exception
```
    Returns the current limit, in mA.
    
    Returns:
    
    a floating point number corresponding to the current limit, in mA
    
    Throws:
    
    YAPI_Exception - on error
  - get_powerOutput
```
public int get_powerOutput()
                    throws YAPI_Exception
```
    Returns the power supply output switch state.
    
    Returns:
    
    either YPowerSupply.POWEROUTPUT_OFF or YPowerSupply.POWEROUTPUT_ON, according to the power supply output switch state
    
    Throws:
    
    YAPI_Exception - on error
  - getPowerOutput
```
public int getPowerOutput()
                   throws YAPI_Exception
```
    Returns the power supply output switch state.
    
    Returns:
    
    either YPowerSupply.POWEROUTPUT_OFF or YPowerSupply.POWEROUTPUT_ON, according to the power supply output switch state
    
    Throws:
    
    YAPI_Exception - on error
  - set_powerOutput
```
public int set_powerOutput(int newval)
                    throws YAPI_Exception
```
    Changes the power supply output switch state.
    
    Parameters:
    
    newval - : either YPowerSupply.POWEROUTPUT_OFF or YPowerSupply.POWEROUTPUT_ON, according to the power supply output switch state
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setPowerOutput
```
public int setPowerOutput(int newval)
                   throws YAPI_Exception
```
    Changes the power supply output switch state.
    
    Parameters:
    
    newval - : either YPowerSupply.POWEROUTPUT_OFF or YPowerSupply.POWEROUTPUT_ON, according to the power supply output switch state
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_measuredVoltage
```
public double get_measuredVoltage()
                           throws YAPI_Exception
```
    Returns the measured output voltage, in V.
    
    Returns:
    
    a floating point number corresponding to the measured output voltage, in V
    
    Throws:
    
    YAPI_Exception - on error
  - getMeasuredVoltage
```
public double getMeasuredVoltage()
                          throws YAPI_Exception
```
    Returns the measured output voltage, in V.
    
    Returns:
    
    a floating point number corresponding to the measured output voltage, in V
    
    Throws:
    
    YAPI_Exception - on error
  - get_measuredCurrent
```
public double get_measuredCurrent()
                           throws YAPI_Exception
```
    Returns the measured output current, in mA.
    
    Returns:
    
    a floating point number corresponding to the measured output current, in mA
    
    Throws:
    
    YAPI_Exception - on error
  - getMeasuredCurrent
```
public double getMeasuredCurrent()
                          throws YAPI_Exception
```
    Returns the measured output current, in mA.
    
    Returns:
    
    a floating point number corresponding to the measured output current, in mA
    
    Throws:
    
    YAPI_Exception - on error
  - get_inputVoltage
```
public double get_inputVoltage()
                        throws YAPI_Exception
```
    Returns the measured input voltage, in V.
    
    Returns:
    
    a floating point number corresponding to the measured input voltage, in V
    
    Throws:
    
    YAPI_Exception - on error
  - getInputVoltage
```
public double getInputVoltage()
                       throws YAPI_Exception
```
    Returns the measured input voltage, in V.
    
    Returns:
    
    a floating point number corresponding to the measured input voltage, in V
    
    Throws:
    
    YAPI_Exception - on error
  - get_voltageTransition
```
public String get_voltageTransition()
                             throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_voltageTransition
```
public int set_voltageTransition(String newval)
                          throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_voltageLimitAtStartUp
```
public int set_voltageLimitAtStartUp(double newval)
                              throws YAPI_Exception
```
    Changes the voltage set point at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.
    
    Parameters:
    
    newval - : a floating point number corresponding to the voltage set point at device start up
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setVoltageLimitAtStartUp
```
public int setVoltageLimitAtStartUp(double newval)
                             throws YAPI_Exception
```
    Changes the voltage set point at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.
    
    Parameters:
    
    newval - : a floating point number corresponding to the voltage set point at device start up
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_voltageLimitAtStartUp
```
public double get_voltageLimitAtStartUp()
                                 throws YAPI_Exception
```
    Returns the selected voltage limit at device startup, in V.
    
    Returns:
    
    a floating point number corresponding to the selected voltage limit at device startup, in V
    
    Throws:
    
    YAPI_Exception - on error
  - getVoltageLimitAtStartUp
```
public double getVoltageLimitAtStartUp()
                                throws YAPI_Exception
```
    Returns the selected voltage limit at device startup, in V.
    
    Returns:
    
    a floating point number corresponding to the selected voltage limit at device startup, in V
    
    Throws:
    
    YAPI_Exception - on error
  - set_currentLimitAtStartUp
```
public int set_currentLimitAtStartUp(double newval)
                              throws YAPI_Exception
```
    Changes the current limit at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.
    
    Parameters:
    
    newval - : a floating point number corresponding to the current limit at device start up
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCurrentLimitAtStartUp
```
public int setCurrentLimitAtStartUp(double newval)
                             throws YAPI_Exception
```
    Changes the current limit at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.
    
    Parameters:
    
    newval - : a floating point number corresponding to the current limit at device start up
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_currentLimitAtStartUp
```
public double get_currentLimitAtStartUp()
                                 throws YAPI_Exception
```
    Returns the selected current limit at device startup, in mA.
    
    Returns:
    
    a floating point number corresponding to the selected current limit at device startup, in mA
    
    Throws:
    
    YAPI_Exception - on error
  - getCurrentLimitAtStartUp
```
public double getCurrentLimitAtStartUp()
                                throws YAPI_Exception
```
    Returns the selected current limit at device startup, in mA.
    
    Returns:
    
    a floating point number corresponding to the selected current limit at device startup, in mA
    
    Throws:
    
    YAPI_Exception - on error
  - get_powerOutputAtStartUp
```
public int get_powerOutputAtStartUp()
                             throws YAPI_Exception
```
    Returns the power supply output switch state.
    
    Returns:
    
    either YPowerSupply.POWEROUTPUTATSTARTUP_OFF or YPowerSupply.POWEROUTPUTATSTARTUP_ON, according to the power supply output switch state
    
    Throws:
    
    YAPI_Exception - on error
  - getPowerOutputAtStartUp
```
public int getPowerOutputAtStartUp()
                            throws YAPI_Exception
```
    Returns the power supply output switch state.
    
    Returns:
    
    either YPowerSupply.POWEROUTPUTATSTARTUP_OFF or YPowerSupply.POWEROUTPUTATSTARTUP_ON, according to the power supply output switch state
    
    Throws:
    
    YAPI_Exception - on error
  - set_powerOutputAtStartUp
```
public int set_powerOutputAtStartUp(int newval)
                             throws YAPI_Exception
```
    Changes the power supply output switch state at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.
    
    Parameters:
    
    newval - : either YPowerSupply.POWEROUTPUTATSTARTUP_OFF or YPowerSupply.POWEROUTPUTATSTARTUP_ON, according to the power supply output switch state at device start up
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setPowerOutputAtStartUp
```
public int setPowerOutputAtStartUp(int newval)
                            throws YAPI_Exception
```
    Changes the power supply output switch state at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.
    
    Parameters:
    
    newval - : either YPowerSupply.POWEROUTPUTATSTARTUP_OFF or YPowerSupply.POWEROUTPUTATSTARTUP_ON, according to the power supply output switch state at device start up
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_command
```
public String get_command()
                   throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_command
```
public int set_command(String newval)
                throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - FindPowerSupply
```
public static YPowerSupply FindPowerSupply(String func)
```
    Retrieves a regulated power supply 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 regulated power supply is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPowerSupply.isOnline() to test if the regulated power supply is indeed online at a given time. In case of ambiguity when looking for a regulated power supply 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 regulated power supply, for instance MyDevice.powerSupply.
    
    Returns:
    
    a YPowerSupply object allowing you to drive the regulated power supply.
  - FindPowerSupplyInContext
```
public static YPowerSupply FindPowerSupplyInContext(YAPIContext yctx,
                                                    String func)
```
    Retrieves a regulated power supply 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 regulated power supply is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPowerSupply.isOnline() to test if the regulated power supply is indeed online at a given time. In case of ambiguity when looking for a regulated power supply 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 regulated power supply, for instance MyDevice.powerSupply.
    
    Returns:
    
    a YPowerSupply object allowing you to drive the regulated power supply.
  - registerValueCallback
```
public int registerValueCallback(YPowerSupply.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
  - voltageMove
```
public int voltageMove(double V_target,
                       int ms_duration)
                throws YAPI_Exception
```
    Performs a smooth transition of output voltage. Any explicit voltage change cancels any ongoing transition process.
    
    Parameters:
    
    V_target - : new output voltage value at the end of the transition (floating-point number, representing the end voltage in V)
    
    ms_duration - : total duration of the transition, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception
  - nextPowerSupply
```
public YPowerSupply nextPowerSupply()
```
    Continues the enumeration of regulated power supplies started using yFirstPowerSupply(). Caution: You can't make any assumption about the returned regulated power supplies order. If you want to find a specific a regulated power supply, use PowerSupply.findPowerSupply() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YPowerSupply object, corresponding to a regulated power supply currently online, or a null pointer if there are no more regulated power supplies to enumerate.
  - FirstPowerSupply
```
public static YPowerSupply FirstPowerSupply()
```
    Starts the enumeration of regulated power supplies currently accessible. Use the method YPowerSupply.nextPowerSupply() to iterate on next regulated power supplies.
    
    Returns:
    
    a pointer to a YPowerSupply object, corresponding to the first regulated power supply currently online, or a null pointer if there are none.
  - FirstPowerSupplyInContext
```
public static YPowerSupply FirstPowerSupplyInContext(YAPIContext yctx)
```
    Starts the enumeration of regulated power supplies currently accessible. Use the method YPowerSupply.nextPowerSupply() to iterate on next regulated power supplies.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YPowerSupply object, corresponding to the first regulated power supply currently online, or a null pointer if there are none.

Class YPowerSupply

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

VOLTAGELIMIT_INVALID

CURRENTLIMIT_INVALID

POWEROUTPUT_OFF

POWEROUTPUT_ON

POWEROUTPUT_INVALID

MEASUREDVOLTAGE_INVALID

MEASUREDCURRENT_INVALID

INPUTVOLTAGE_INVALID

VOLTAGETRANSITION_INVALID

VOLTAGELIMITATSTARTUP_INVALID

CURRENTLIMITATSTARTUP_INVALID

POWEROUTPUTATSTARTUP_OFF

POWEROUTPUTATSTARTUP_ON

POWEROUTPUTATSTARTUP_INVALID

COMMAND_INVALID

_voltageLimit

_currentLimit

_powerOutput

_measuredVoltage

_measuredCurrent

_inputVoltage

_voltageTransition

_voltageLimitAtStartUp

_currentLimitAtStartUp

_powerOutputAtStartUp

_command

_valueCallbackPowerSupply

Constructor Detail

YPowerSupply

YPowerSupply

Method Detail

_parseAttr

set_voltageLimit

setVoltageLimit

get_voltageLimit

getVoltageLimit

set_currentLimit

setCurrentLimit

get_currentLimit

getCurrentLimit

get_powerOutput

getPowerOutput

set_powerOutput

setPowerOutput

get_measuredVoltage

getMeasuredVoltage

get_measuredCurrent

getMeasuredCurrent

get_inputVoltage

getInputVoltage

get_voltageTransition

set_voltageTransition

set_voltageLimitAtStartUp

setVoltageLimitAtStartUp

get_voltageLimitAtStartUp

getVoltageLimitAtStartUp

set_currentLimitAtStartUp

setCurrentLimitAtStartUp

get_currentLimitAtStartUp

getCurrentLimitAtStartUp

get_powerOutputAtStartUp

getPowerOutputAtStartUp

set_powerOutputAtStartUp

setPowerOutputAtStartUp

get_command

set_command

FindPowerSupply

FindPowerSupplyInContext

registerValueCallback

_invokeValueCallback

voltageMove