YPwmOutput (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

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

```
public class YPwmOutput
extends YFunction
```
YPwmOutput Class: PWM generator control interface, available for instance in the Yocto-PWM-Tx The YPwmOutput class allows you to drive a pulse-width modulated output (PWM). You can configure the frequency as well as the duty cycle, and set up progressive transitions.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YPwmOutput.TimedReportCallback` TimedReportCallback for PwmOutput
`static interface`	`YPwmOutput.UpdateCallback` Deprecated UpdateCallback for PwmOutput

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`_dutyCycle`
`protected double`	`_dutyCycleAtPowerOn`
`protected int`	`_enabled`
`protected int`	`_enabledAtPowerOn`
`protected double`	`_frequency`
`protected int`	`_invertedOutput`
`protected double`	`_period`
`protected double`	`_pulseDuration`
`protected String`	`_pwmTransition`
`protected YPwmOutput.UpdateCallback`	`_valueCallbackPwmOutput`
`static double`	`DUTYCYCLE_INVALID` invalid dutyCycle value
`static double`	`DUTYCYCLEATPOWERON_INVALID` invalid dutyCycleAtPowerOn value
`static int`	`ENABLED_FALSE` invalid enabled value
`static int`	`ENABLED_INVALID`
`static int`	`ENABLED_TRUE`
`static int`	`ENABLEDATPOWERON_FALSE` invalid enabledAtPowerOn value
`static int`	`ENABLEDATPOWERON_INVALID`
`static int`	`ENABLEDATPOWERON_TRUE`
`static double`	`FREQUENCY_INVALID` invalid frequency value
`static int`	`INVERTEDOUTPUT_FALSE` invalid invertedOutput value
`static int`	`INVERTEDOUTPUT_INVALID`
`static int`	`INVERTEDOUTPUT_TRUE`
`static double`	`PERIOD_INVALID` invalid period value
`static double`	`PULSEDURATION_INVALID` invalid pulseDuration value
`static String`	`PWMTRANSITION_INVALID` invalid pwmTransition 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 YPwmOutput(String func)

protected YPwmOutput(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YPwmOutput(String func)`
`protected`	`YPwmOutput(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)`
`int`	`dutyCycleMove(double target, int ms_duration)` Performs a smooth change of the duty cycle toward a given value.
`static YPwmOutput`	`FindPwmOutput(String func)` Retrieves a PWM generator for a given identifier.
`static YPwmOutput`	`FindPwmOutputInContext(YAPIContext yctx, String func)` Retrieves a PWM generator for a given identifier in a YAPI context.
`static YPwmOutput`	`FirstPwmOutput()` Starts the enumeration of PWM generators currently accessible.
`static YPwmOutput`	`FirstPwmOutputInContext(YAPIContext yctx)` Starts the enumeration of PWM generators currently accessible.
`int`	`frequencyMove(double target, int ms_duration)` Performs a smooth frequency change toward a given value.
`double`	`get_dutyCycle()` Returns the PWM duty cycle, in per cents.
`double`	`get_dutyCycleAtPowerOn()` Returns the PWM generators duty cycle at device power on as a floating point number between 0 and 100.
`int`	`get_enabled()` Returns the state of the PWM generators.
`int`	`get_enabledAtPowerOn()` Returns the state of the PWM at device power on.
`double`	`get_frequency()` Returns the PWM frequency in Hz.
`int`	`get_invertedOutput()` Returns true if the output signal is configured as inverted, and false otherwise.
`double`	`get_period()` Returns the PWM period in milliseconds.
`double`	`get_pulseDuration()` Returns the PWM pulse length in milliseconds, as a floating point number.
`String`	`get_pwmTransition()`
`double`	`getDutyCycle()` Returns the PWM duty cycle, in per cents.
`double`	`getDutyCycleAtPowerOn()` Returns the PWM generators duty cycle at device power on as a floating point number between 0 and 100.
`int`	`getEnabled()` Returns the state of the PWM generators.
`int`	`getEnabledAtPowerOn()` Returns the state of the PWM at device power on.
`double`	`getFrequency()` Returns the PWM frequency in Hz.
`int`	`getInvertedOutput()` Returns true if the output signal is configured as inverted, and false otherwise.
`double`	`getPeriod()` Returns the PWM period in milliseconds.
`double`	`getPulseDuration()` Returns the PWM pulse length in milliseconds, as a floating point number.
`int`	`markForRepeat()`
`YPwmOutput`	`nextPwmOutput()` Continues the enumeration of PWM generators started using yFirstPwmOutput().
`int`	`phaseMove(double target, int ms_duration)` Performs a smooth transition toward a specified value of the phase shift between this channel and the other channel.
`int`	`pulseDurationMove(double ms_target, int ms_duration)` Performs a smooth transition of the pulse duration toward a given value.
`int`	`registerValueCallback(YPwmOutput.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`repeatFromMark()`
`int`	`set_dutyCycle(double newval)` Changes the PWM duty cycle, in per cents.
`int`	`set_dutyCycleAtPowerOn(double newval)` Changes the PWM duty cycle at device power on.
`int`	`set_enabled(int newval)` Stops or starts the PWM.
`int`	`set_enabledAtPowerOn(int newval)` Changes the state of the PWM at device power on.
`int`	`set_frequency(double newval)` Changes the PWM frequency.
`int`	`set_invertedOutput(int newval)` Changes the inversion mode of the output signal.
`int`	`set_period(double newval)` Changes the PWM period in milliseconds.
`int`	`set_pulseDuration(double newval)` Changes the PWM pulse length, in milliseconds.
`int`	`set_pwmTransition(String newval)`
`int`	`setDutyCycle(double newval)` Changes the PWM duty cycle, in per cents.
`int`	`setDutyCycleAtPowerOn(double newval)` Changes the PWM duty cycle at device power on.
`int`	`setEnabled(int newval)` Stops or starts the PWM.
`int`	`setEnabledAtPowerOn(int newval)` Changes the state of the PWM at device power on.
`int`	`setFrequency(double newval)` Changes the PWM frequency.
`int`	`setInvertedOutput(int newval)` Changes the inversion mode of the output signal.
`int`	`setPeriod(double newval)` Changes the PWM period in milliseconds.
`int`	`setPulseDuration(double newval)` Changes the PWM pulse length, in milliseconds.
`int`	`triggerPulsesByDuration(double ms_target, int n_pulses)` Trigger a given number of pulses of specified duration, at current frequency.
`int`	`triggerPulsesByDutyCycle(double target, int n_pulses)` Trigger a given number of pulses of specified duration, at current frequency.
`int`	`triggerPulsesByFrequency(double target, int n_pulses)` Trigger a given number of pulses at the specified frequency, using current duty cycle.

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
  - ENABLED_FALSE
```
public static final int ENABLED_FALSE
```
    invalid enabled value
    
    See Also:
    
    Constant Field Values
  - ENABLED_TRUE
```
public static final int ENABLED_TRUE
```
    See Also:
    
    Constant Field Values
  - ENABLED_INVALID
```
public static final int ENABLED_INVALID
```
    See Also:
    
    Constant Field Values
  - FREQUENCY_INVALID
```
public static final double FREQUENCY_INVALID
```
    invalid frequency value
    
    See Also:
    
    Constant Field Values
  - PERIOD_INVALID
```
public static final double PERIOD_INVALID
```
    invalid period value
    
    See Also:
    
    Constant Field Values
  - DUTYCYCLE_INVALID
```
public static final double DUTYCYCLE_INVALID
```
    invalid dutyCycle value
    
    See Also:
    
    Constant Field Values
  - PULSEDURATION_INVALID
```
public static final double PULSEDURATION_INVALID
```
    invalid pulseDuration value
    
    See Also:
    
    Constant Field Values
  - PWMTRANSITION_INVALID
```
public static final String PWMTRANSITION_INVALID
```
    invalid pwmTransition value
    
    See Also:
    
    Constant Field Values
  - INVERTEDOUTPUT_FALSE
```
public static final int INVERTEDOUTPUT_FALSE
```
    invalid invertedOutput value
    
    See Also:
    
    Constant Field Values
  - INVERTEDOUTPUT_TRUE
```
public static final int INVERTEDOUTPUT_TRUE
```
    See Also:
    
    Constant Field Values
  - INVERTEDOUTPUT_INVALID
```
public static final int INVERTEDOUTPUT_INVALID
```
    See Also:
    
    Constant Field Values
  - ENABLEDATPOWERON_FALSE
```
public static final int ENABLEDATPOWERON_FALSE
```
    invalid enabledAtPowerOn value
    
    See Also:
    
    Constant Field Values
  - ENABLEDATPOWERON_TRUE
```
public static final int ENABLEDATPOWERON_TRUE
```
    See Also:
    
    Constant Field Values
  - ENABLEDATPOWERON_INVALID
```
public static final int ENABLEDATPOWERON_INVALID
```
    See Also:
    
    Constant Field Values
  - DUTYCYCLEATPOWERON_INVALID
```
public static final double DUTYCYCLEATPOWERON_INVALID
```
    invalid dutyCycleAtPowerOn value
    
    See Also:
    
    Constant Field Values
  - _enabled
```
protected int _enabled
```
  - _frequency
```
protected double _frequency
```
  - _period
```
protected double _period
```
  - _dutyCycle
```
protected double _dutyCycle
```
  - _pulseDuration
```
protected double _pulseDuration
```
  - _pwmTransition
```
protected String _pwmTransition
```
  - _invertedOutput
```
protected int _invertedOutput
```
  - _enabledAtPowerOn
```
protected int _enabledAtPowerOn
```
  - _dutyCycleAtPowerOn
```
protected double _dutyCycleAtPowerOn
```
  - _valueCallbackPwmOutput
```
protected YPwmOutput.UpdateCallback _valueCallbackPwmOutput
```
- Constructor Detail
  - YPwmOutput
```
protected YPwmOutput(YAPIContext ctx,
                     String func)
```
    Parameters:
    
    func - : functionid
  - YPwmOutput
```
protected YPwmOutput(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_enabled
```
public int get_enabled()
                throws YAPI_Exception
```
    Returns the state of the PWM generators.
    
    Returns:
    
    either YPwmOutput.ENABLED_FALSE or YPwmOutput.ENABLED_TRUE, according to the state of the PWM generators
    
    Throws:
    
    YAPI_Exception - on error
  - getEnabled
```
public int getEnabled()
               throws YAPI_Exception
```
    Returns the state of the PWM generators.
    
    Returns:
    
    either YPwmOutput.ENABLED_FALSE or YPwmOutput.ENABLED_TRUE, according to the state of the PWM generators
    
    Throws:
    
    YAPI_Exception - on error
  - set_enabled
```
public int set_enabled(int newval)
                throws YAPI_Exception
```
    Stops or starts the PWM.
    
    Parameters:
    
    newval - : either YPwmOutput.ENABLED_FALSE or YPwmOutput.ENABLED_TRUE
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setEnabled
```
public int setEnabled(int newval)
               throws YAPI_Exception
```
    Stops or starts the PWM.
    
    Parameters:
    
    newval - : either YPwmOutput.ENABLED_FALSE or YPwmOutput.ENABLED_TRUE
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - set_frequency
```
public int set_frequency(double newval)
                  throws YAPI_Exception
```
    Changes the PWM frequency. The duty cycle is kept unchanged thanks to an automatic pulse width change, in other words, the change will not be applied before the end of the current period. This can significantly affect reaction time at low frequencies. If you call the matching module saveToFlash() method, the frequency will be kept after a device power cycle. To stop the PWM signal, do not set the frequency to zero, use the set_enabled() method instead.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM frequency
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setFrequency
```
public int setFrequency(double newval)
                 throws YAPI_Exception
```
    Changes the PWM frequency. The duty cycle is kept unchanged thanks to an automatic pulse width change, in other words, the change will not be applied before the end of the current period. This can significantly affect reaction time at low frequencies. If you call the matching module saveToFlash() method, the frequency will be kept after a device power cycle. To stop the PWM signal, do not set the frequency to zero, use the set_enabled() method instead.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM frequency
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_frequency
```
public double get_frequency()
                     throws YAPI_Exception
```
    Returns the PWM frequency in Hz.
    
    Returns:
    
    a floating point number corresponding to the PWM frequency in Hz
    
    Throws:
    
    YAPI_Exception - on error
  - getFrequency
```
public double getFrequency()
                    throws YAPI_Exception
```
    Returns the PWM frequency in Hz.
    
    Returns:
    
    a floating point number corresponding to the PWM frequency in Hz
    
    Throws:
    
    YAPI_Exception - on error
  - set_period
```
public int set_period(double newval)
               throws YAPI_Exception
```
    Changes the PWM period in milliseconds. Caution: in order to avoid random truncation of the current pulse, the change will not be applied before the end of the current period. This can significantly affect reaction time at low frequencies. If you call the matching module saveToFlash() method, the frequency will be kept after a device power cycle.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM period in milliseconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setPeriod
```
public int setPeriod(double newval)
              throws YAPI_Exception
```
    Changes the PWM period in milliseconds. Caution: in order to avoid random truncation of the current pulse, the change will not be applied before the end of the current period. This can significantly affect reaction time at low frequencies. If you call the matching module saveToFlash() method, the frequency will be kept after a device power cycle.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM period in milliseconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_period
```
public double get_period()
                  throws YAPI_Exception
```
    Returns the PWM period in milliseconds.
    
    Returns:
    
    a floating point number corresponding to the PWM period in milliseconds
    
    Throws:
    
    YAPI_Exception - on error
  - getPeriod
```
public double getPeriod()
                 throws YAPI_Exception
```
    Returns the PWM period in milliseconds.
    
    Returns:
    
    a floating point number corresponding to the PWM period in milliseconds
    
    Throws:
    
    YAPI_Exception - on error
  - set_dutyCycle
```
public int set_dutyCycle(double newval)
                  throws YAPI_Exception
```
    Changes the PWM duty cycle, in per cents.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM duty cycle, in per cents
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setDutyCycle
```
public int setDutyCycle(double newval)
                 throws YAPI_Exception
```
    Changes the PWM duty cycle, in per cents.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM duty cycle, in per cents
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_dutyCycle
```
public double get_dutyCycle()
                     throws YAPI_Exception
```
    Returns the PWM duty cycle, in per cents.
    
    Returns:
    
    a floating point number corresponding to the PWM duty cycle, in per cents
    
    Throws:
    
    YAPI_Exception - on error
  - getDutyCycle
```
public double getDutyCycle()
                    throws YAPI_Exception
```
    Returns the PWM duty cycle, in per cents.
    
    Returns:
    
    a floating point number corresponding to the PWM duty cycle, in per cents
    
    Throws:
    
    YAPI_Exception - on error
  - set_pulseDuration
```
public int set_pulseDuration(double newval)
                      throws YAPI_Exception
```
    Changes the PWM pulse length, in milliseconds. A pulse length cannot be longer than period, otherwise it is truncated.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM pulse length, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setPulseDuration
```
public int setPulseDuration(double newval)
                     throws YAPI_Exception
```
    Changes the PWM pulse length, in milliseconds. A pulse length cannot be longer than period, otherwise it is truncated.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM pulse length, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_pulseDuration
```
public double get_pulseDuration()
                         throws YAPI_Exception
```
    Returns the PWM pulse length in milliseconds, as a floating point number.
    
    Returns:
    
    a floating point number corresponding to the PWM pulse length in milliseconds, as a floating point number
    
    Throws:
    
    YAPI_Exception - on error
  - getPulseDuration
```
public double getPulseDuration()
                        throws YAPI_Exception
```
    Returns the PWM pulse length in milliseconds, as a floating point number.
    
    Returns:
    
    a floating point number corresponding to the PWM pulse length in milliseconds, as a floating point number
    
    Throws:
    
    YAPI_Exception - on error
  - get_pwmTransition
```
public String get_pwmTransition()
                         throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_pwmTransition
```
public int set_pwmTransition(String newval)
                      throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_invertedOutput
```
public int get_invertedOutput()
                       throws YAPI_Exception
```
    Returns true if the output signal is configured as inverted, and false otherwise.
    
    Returns:
    
    either YPwmOutput.INVERTEDOUTPUT_FALSE or YPwmOutput.INVERTEDOUTPUT_TRUE, according to true if the output signal is configured as inverted, and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getInvertedOutput
```
public int getInvertedOutput()
                      throws YAPI_Exception
```
    Returns true if the output signal is configured as inverted, and false otherwise.
    
    Returns:
    
    either YPwmOutput.INVERTEDOUTPUT_FALSE or YPwmOutput.INVERTEDOUTPUT_TRUE, according to true if the output signal is configured as inverted, and false otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - set_invertedOutput
```
public int set_invertedOutput(int newval)
                       throws YAPI_Exception
```
    Changes the inversion mode of the output signal. Remember to call the matching module saveToFlash() method if you want the change to be kept after power cycle.
    
    Parameters:
    
    newval - : either YPwmOutput.INVERTEDOUTPUT_FALSE or YPwmOutput.INVERTEDOUTPUT_TRUE, according to the inversion mode of the output signal
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setInvertedOutput
```
public int setInvertedOutput(int newval)
                      throws YAPI_Exception
```
    Changes the inversion mode of the output signal. Remember to call the matching module saveToFlash() method if you want the change to be kept after power cycle.
    
    Parameters:
    
    newval - : either YPwmOutput.INVERTEDOUTPUT_FALSE or YPwmOutput.INVERTEDOUTPUT_TRUE, according to the inversion mode of the output signal
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_enabledAtPowerOn
```
public int get_enabledAtPowerOn()
                         throws YAPI_Exception
```
    Returns the state of the PWM at device power on.
    
    Returns:
    
    either YPwmOutput.ENABLEDATPOWERON_FALSE or YPwmOutput.ENABLEDATPOWERON_TRUE, according to the state of the PWM at device power on
    
    Throws:
    
    YAPI_Exception - on error
  - getEnabledAtPowerOn
```
public int getEnabledAtPowerOn()
                        throws YAPI_Exception
```
    Returns the state of the PWM at device power on.
    
    Returns:
    
    either YPwmOutput.ENABLEDATPOWERON_FALSE or YPwmOutput.ENABLEDATPOWERON_TRUE, according to the state of the PWM at device power on
    
    Throws:
    
    YAPI_Exception - on error
  - set_enabledAtPowerOn
```
public int set_enabledAtPowerOn(int newval)
                         throws YAPI_Exception
```
    Changes the state of the PWM at device power on. Remember to call the matching module saveToFlash() method, otherwise this call will have no effect.
    
    Parameters:
    
    newval - : either YPwmOutput.ENABLEDATPOWERON_FALSE or YPwmOutput.ENABLEDATPOWERON_TRUE, according to the state of the PWM at device power on
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setEnabledAtPowerOn
```
public int setEnabledAtPowerOn(int newval)
                        throws YAPI_Exception
```
    Changes the state of the PWM at device power on. Remember to call the matching module saveToFlash() method, otherwise this call will have no effect.
    
    Parameters:
    
    newval - : either YPwmOutput.ENABLEDATPOWERON_FALSE or YPwmOutput.ENABLEDATPOWERON_TRUE, according to the state of the PWM at device power on
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - set_dutyCycleAtPowerOn
```
public int set_dutyCycleAtPowerOn(double newval)
                           throws YAPI_Exception
```
    Changes the PWM duty cycle at device power on. Remember to call the matching module saveToFlash() method, otherwise this call will have no effect.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM duty cycle at device power on
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setDutyCycleAtPowerOn
```
public int setDutyCycleAtPowerOn(double newval)
                          throws YAPI_Exception
```
    Changes the PWM duty cycle at device power on. Remember to call the matching module saveToFlash() method, otherwise this call will have no effect.
    
    Parameters:
    
    newval - : a floating point number corresponding to the PWM duty cycle at device power on
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_dutyCycleAtPowerOn
```
public double get_dutyCycleAtPowerOn()
                              throws YAPI_Exception
```
    Returns the PWM generators duty cycle at device power on as a floating point number between 0 and 100.
    
    Returns:
    
    a floating point number corresponding to the PWM generators duty cycle at device power on as a floating point number between 0 and 100
    
    Throws:
    
    YAPI_Exception - on error
  - getDutyCycleAtPowerOn
```
public double getDutyCycleAtPowerOn()
                             throws YAPI_Exception
```
    Returns the PWM generators duty cycle at device power on as a floating point number between 0 and 100.
    
    Returns:
    
    a floating point number corresponding to the PWM generators duty cycle at device power on as a floating point number between 0 and 100
    
    Throws:
    
    YAPI_Exception - on error
  - FindPwmOutput
```
public static YPwmOutput FindPwmOutput(String func)
```
    Retrieves a PWM generator 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 is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPwmOutput.isOnline() to test if the PWM generator is indeed online at a given time. In case of ambiguity when looking for a PWM generator 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, for instance YPWMTX01.pwmOutput1.
    
    Returns:
    
    a YPwmOutput object allowing you to drive the PWM generator.
  - FindPwmOutputInContext
```
public static YPwmOutput FindPwmOutputInContext(YAPIContext yctx,
                                                String func)
```
    Retrieves a PWM generator 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 is online at the time it is invoked. The returned object is nevertheless valid. Use the method YPwmOutput.isOnline() to test if the PWM generator is indeed online at a given time. In case of ambiguity when looking for a PWM generator 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, for instance YPWMTX01.pwmOutput1.
    
    Returns:
    
    a YPwmOutput object allowing you to drive the PWM generator.
  - registerValueCallback
```
public int registerValueCallback(YPwmOutput.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
  - pulseDurationMove
```
public int pulseDurationMove(double ms_target,
                             int ms_duration)
                      throws YAPI_Exception
```
    Performs a smooth transition of the pulse duration toward a given value. Any period, frequency, duty cycle or pulse width change will cancel any ongoing transition process.
    
    Parameters:
    
    ms_target - : new pulse duration at the end of the transition (floating-point number, representing the pulse duration in milliseconds)
    
    ms_duration - : total duration of the transition, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - dutyCycleMove
```
public int dutyCycleMove(double target,
                         int ms_duration)
                  throws YAPI_Exception
```
    Performs a smooth change of the duty cycle toward a given value. Any period, frequency, duty cycle or pulse width change will cancel any ongoing transition process.
    
    Parameters:
    
    target - : new duty cycle at the end of the transition (percentage, floating-point number between 0 and 100)
    
    ms_duration - : total duration of the transition, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - frequencyMove
```
public int frequencyMove(double target,
                         int ms_duration)
                  throws YAPI_Exception
```
    Performs a smooth frequency change toward a given value. Any period, frequency, duty cycle or pulse width change will cancel any ongoing transition process.
    
    Parameters:
    
    target - : new frequency at the end of the transition (floating-point number)
    
    ms_duration - : total duration of the transition, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - phaseMove
```
public int phaseMove(double target,
                     int ms_duration)
              throws YAPI_Exception
```
    Performs a smooth transition toward a specified value of the phase shift between this channel and the other channel. The phase shift is executed by slightly changing the frequency temporarily during the specified duration. This function only makes sense when both channels are running, either at the same frequency, or at a multiple of the channel frequency. Any period, frequency, duty cycle or pulse width change will cancel any ongoing transition process.
    
    Parameters:
    
    target - : phase shift at the end of the transition, in milliseconds (floating-point number)
    
    ms_duration - : total duration of the transition, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - triggerPulsesByDuration
```
public int triggerPulsesByDuration(double ms_target,
                                   int n_pulses)
                            throws YAPI_Exception
```
    Trigger a given number of pulses of specified duration, at current frequency. At the end of the pulse train, revert to the original state of the PWM generator.
    
    Parameters:
    
    ms_target - : desired pulse duration (floating-point number, representing the pulse duration in milliseconds)
    
    n_pulses - : desired pulse count
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - triggerPulsesByDutyCycle
```
public int triggerPulsesByDutyCycle(double target,
                                    int n_pulses)
                             throws YAPI_Exception
```
    Trigger a given number of pulses of specified duration, at current frequency. At the end of the pulse train, revert to the original state of the PWM generator.
    
    Parameters:
    
    target - : desired duty cycle for the generated pulses (percentage, floating-point number between 0 and 100)
    
    n_pulses - : desired pulse count
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - triggerPulsesByFrequency
```
public int triggerPulsesByFrequency(double target,
                                    int n_pulses)
                             throws YAPI_Exception
```
    Trigger a given number of pulses at the specified frequency, using current duty cycle. At the end of the pulse train, revert to the original state of the PWM generator.
    
    Parameters:
    
    target - : desired frequency for the generated pulses (floating-point number)
    
    n_pulses - : desired pulse count
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - markForRepeat
```
public int markForRepeat()
                  throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - repeatFromMark
```
public int repeatFromMark()
                   throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - nextPwmOutput
```
public YPwmOutput nextPwmOutput()
```
    Continues the enumeration of PWM generators started using yFirstPwmOutput(). Caution: You can't make any assumption about the returned PWM generators order. If you want to find a specific a PWM generator, use PwmOutput.findPwmOutput() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YPwmOutput object, corresponding to a PWM generator currently online, or a null pointer if there are no more PWM generators to enumerate.
  - FirstPwmOutput
```
public static YPwmOutput FirstPwmOutput()
```
    Starts the enumeration of PWM generators currently accessible. Use the method YPwmOutput.nextPwmOutput() to iterate on next PWM generators.
    
    Returns:
    
    a pointer to a YPwmOutput object, corresponding to the first PWM generator currently online, or a null pointer if there are none.
  - FirstPwmOutputInContext
```
public static YPwmOutput FirstPwmOutputInContext(YAPIContext yctx)
```
    Starts the enumeration of PWM generators currently accessible. Use the method YPwmOutput.nextPwmOutput() to iterate on next PWM generators.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YPwmOutput object, corresponding to the first PWM generator currently online, or a null pointer if there are none.

Class YPwmOutput

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

ENABLED_FALSE

ENABLED_TRUE

ENABLED_INVALID

FREQUENCY_INVALID

PERIOD_INVALID

DUTYCYCLE_INVALID

PULSEDURATION_INVALID

PWMTRANSITION_INVALID

INVERTEDOUTPUT_FALSE

INVERTEDOUTPUT_TRUE

INVERTEDOUTPUT_INVALID

ENABLEDATPOWERON_FALSE

ENABLEDATPOWERON_TRUE

ENABLEDATPOWERON_INVALID

DUTYCYCLEATPOWERON_INVALID

_enabled

_frequency

_period

_dutyCycle

_pulseDuration

_pwmTransition

_invertedOutput

_enabledAtPowerOn

_dutyCycleAtPowerOn

_valueCallbackPwmOutput

Constructor Detail

YPwmOutput

YPwmOutput

Method Detail

_parseAttr

get_enabled

getEnabled

set_enabled

setEnabled

set_frequency

setFrequency

get_frequency

getFrequency

set_period

setPeriod

get_period

getPeriod

set_dutyCycle

setDutyCycle

get_dutyCycle

getDutyCycle

set_pulseDuration

setPulseDuration

get_pulseDuration

getPulseDuration

get_pwmTransition

set_pwmTransition

get_invertedOutput

getInvertedOutput

set_invertedOutput

setInvertedOutput

get_enabledAtPowerOn

getEnabledAtPowerOn

set_enabledAtPowerOn

setEnabledAtPowerOn

set_dutyCycleAtPowerOn

setDutyCycleAtPowerOn

get_dutyCycleAtPowerOn

getDutyCycleAtPowerOn

FindPwmOutput

FindPwmOutputInContext

registerValueCallback

_invokeValueCallback

pulseDurationMove

dutyCycleMove

frequencyMove