com.yoctopuce.YoctoAPI

Class YPwmPowerSource

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YPwmPowerSource

public class YPwmPowerSource
extends YFunction

YPwmPowerSource Class: PWM generator power source control interface, available for instance in the Yocto-PWM-Tx The YPwmPowerSource class allows you to configure the voltage source used by all PWM outputs on the same device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	YPwmPowerSource.TimedReportCallback TimedReportCallback for PwmPowerSource
static interface	YPwmPowerSource.UpdateCallback Deprecated UpdateCallback for PwmPowerSource

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_powerMode
protected YPwmPowerSource.UpdateCallback	_valueCallbackPwmPowerSource
static int	POWERMODE_EXT_V
static int	POWERMODE_INVALID
static int	POWERMODE_OPNDRN
static int	POWERMODE_USB_3V
static int	POWERMODE_USB_5V invalid powerMode 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	YPwmPowerSource(String func)
protected	YPwmPowerSource(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 YPwmPowerSource	FindPwmPowerSource(String func) Retrieves a PWM generator power source for a given identifier.
static YPwmPowerSource	FindPwmPowerSourceInContext(YAPIContext yctx, String func) Retrieves a PWM generator power source for a given identifier in a YAPI context.
static YPwmPowerSource	FirstPwmPowerSource() Starts the enumeration of PWM generator power sources currently accessible.
static YPwmPowerSource	FirstPwmPowerSourceInContext(YAPIContext yctx) Starts the enumeration of PWM generator power sources currently accessible.
int	get_powerMode() Returns the selected power source for the PWM on the same device.
int	getPowerMode() Returns the selected power source for the PWM on the same device.
YPwmPowerSource	nextPwmPowerSource() Continues the enumeration of PWM generator power sources started using yFirstPwmPowerSource().
int	registerValueCallback(YPwmPowerSource.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_powerMode(int newval) Changes the PWM power source.
int	setPowerMode(int newval) Changes the PWM power source.

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

POWERMODE_USB_5V

public static final int POWERMODE_USB_5V

invalid powerMode value

See Also:

Constant Field Values

POWERMODE_USB_3V

public static final int POWERMODE_USB_3V

See Also:

Constant Field Values

POWERMODE_EXT_V

public static final int POWERMODE_EXT_V

See Also:

Constant Field Values

POWERMODE_OPNDRN

public static final int POWERMODE_OPNDRN

See Also:

Constant Field Values

POWERMODE_INVALID

public static final int POWERMODE_INVALID

See Also:

Constant Field Values

_powerMode

protected int _powerMode

_valueCallbackPwmPowerSource

protected YPwmPowerSource.UpdateCallback _valueCallbackPwmPowerSource

Constructor Detail

YPwmPowerSource

protected YPwmPowerSource(YAPIContext ctx,
                          String func)

Parameters:

func - : functionid

YPwmPowerSource

protected YPwmPowerSource(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_powerMode

public int get_powerMode()
                  throws YAPI_Exception

Returns the selected power source for the PWM on the same device.

Returns:

a value among YPwmPowerSource.POWERMODE_USB_5V, YPwmPowerSource.POWERMODE_USB_3V, YPwmPowerSource.POWERMODE_EXT_V and YPwmPowerSource.POWERMODE_OPNDRN corresponding to the selected power source for the PWM on the same device

Throws:

YAPI_Exception - on error

getPowerMode

public int getPowerMode()
                 throws YAPI_Exception

Returns the selected power source for the PWM on the same device.

Returns:

a value among YPwmPowerSource.POWERMODE_USB_5V, YPwmPowerSource.POWERMODE_USB_3V, YPwmPowerSource.POWERMODE_EXT_V and YPwmPowerSource.POWERMODE_OPNDRN corresponding to the selected power source for the PWM on the same device

Throws:

YAPI_Exception - on error

set_powerMode

public int set_powerMode(int newval)
                  throws YAPI_Exception

Changes the PWM power source. PWM can use isolated 5V from USB, isolated 3V from USB or voltage from an external power source. The PWM can also work in open drain mode. In that mode, the PWM actively pulls the line down. Warning: this setting is common to all PWM on the same device. If you change that parameter, all PWM located on the same device are affected. If you want the change to be kept after a device reboot, make sure to call the matching module saveToFlash().

Parameters:

newval - : a value among YPwmPowerSource.POWERMODE_USB_5V, YPwmPowerSource.POWERMODE_USB_3V, YPwmPowerSource.POWERMODE_EXT_V and YPwmPowerSource.POWERMODE_OPNDRN corresponding to the PWM power source

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setPowerMode

public int setPowerMode(int newval)
                 throws YAPI_Exception

Changes the PWM power source. PWM can use isolated 5V from USB, isolated 3V from USB or voltage from an external power source. The PWM can also work in open drain mode. In that mode, the PWM actively pulls the line down. Warning: this setting is common to all PWM on the same device. If you change that parameter, all PWM located on the same device are affected. If you want the change to be kept after a device reboot, make sure to call the matching module saveToFlash().

Parameters:

newval - : a value among YPwmPowerSource.POWERMODE_USB_5V, YPwmPowerSource.POWERMODE_USB_3V, YPwmPowerSource.POWERMODE_EXT_V and YPwmPowerSource.POWERMODE_OPNDRN corresponding to the PWM power source

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

FindPwmPowerSource

public static YPwmPowerSource FindPwmPowerSource(String func)

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

Returns:

a YPwmPowerSource object allowing you to drive the PWM generator power source.

FindPwmPowerSourceInContext

public static YPwmPowerSource FindPwmPowerSourceInContext(YAPIContext yctx,
                                                          String func)

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

Returns:

a YPwmPowerSource object allowing you to drive the PWM generator power source.

registerValueCallback

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

nextPwmPowerSource

public YPwmPowerSource nextPwmPowerSource()

Continues the enumeration of PWM generator power sources started using yFirstPwmPowerSource(). Caution: You can't make any assumption about the returned PWM generator power sources order. If you want to find a specific a PWM generator power source, use PwmPowerSource.findPwmPowerSource() and a hardwareID or a logical name.

Returns:

a pointer to a YPwmPowerSource object, corresponding to a PWM generator power source currently online, or a null pointer if there are no more PWM generator power sources to enumerate.

FirstPwmPowerSource

public static YPwmPowerSource FirstPwmPowerSource()

Starts the enumeration of PWM generator power sources currently accessible. Use the method YPwmPowerSource.nextPwmPowerSource() to iterate on next PWM generator power sources.

Returns:

a pointer to a YPwmPowerSource object, corresponding to the first PWM generator power source currently online, or a null pointer if there are none.

FirstPwmPowerSourceInContext

public static YPwmPowerSource FirstPwmPowerSourceInContext(YAPIContext yctx)

Starts the enumeration of PWM generator power sources currently accessible. Use the method YPwmPowerSource.nextPwmPowerSource() to iterate on next PWM generator power sources.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YPwmPowerSource object, corresponding to the first PWM generator power source currently online, or a null pointer if there are none.