Package com.diozero.api

Class PwmOutputDevice

java.lang.Object

com.diozero.api.GpioDevice

com.diozero.api.PwmOutputDevice

All Implemented Interfaces:

OutputDeviceInterface, Closeable, AutoCloseable

Direct Known Subclasses:

PwmLed

public class PwmOutputDevice
extends GpioDevice
implements OutputDeviceInterface

Provide generic Pulse Width Modulation (PWM) output control.

Field Summary

Fields

Modifier and Type	Field	Description
static int	INFINITE_ITERATIONS

Fields inherited from class com.diozero.api.GpioDevice

gpio

Constructor Summary

Constructors

Constructor	Description
PwmOutputDevice(int gpio)
PwmOutputDevice(int gpio, float initialValue)
PwmOutputDevice(int gpio, int pwmFrequency, float initialValue)
PwmOutputDevice(PwmOutputDeviceFactoryInterface pwmDeviceFactory, int gpio, float initialValue)
PwmOutputDevice(PwmOutputDeviceFactoryInterface pwmDeviceFactory, int gpio, int pwmFrequency, float initialValue)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	fadeInOutLoop(float fadeTime, int steps, int iterations, boolean background)
float	getValue()	Get the current PWM output value (0..1).
boolean	isOn()	Get the device on / off status.
void	off()	Turn off the device (same as setValue(0)).
void	on()	Turn on the device (same as setValue(1)).
protected void	onOffLoop(float onTime, float offTime, int n, boolean background)
void	setValue(float value)	Set the PWM output value (0..1).
protected void	setValueInternal(float value)
void	toggle()	Toggle the state of the device (same as setValue(1 - getvalue()) ).

Methods inherited from class com.diozero.api.GpioDevice

getGpio

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INFINITE_ITERATIONS

public static final int INFINITE_ITERATIONS

See Also:

Constant Field Values

Constructor Details

PwmOutputDevice

public PwmOutputDevice(int gpio)
                throws RuntimeIOException

Parameters:

gpio - GPIO to which the output device is connected.

Throws:

RuntimeIOException - If an I/O error occurred.

PwmOutputDevice

public PwmOutputDevice(int gpio,
float initialValue)
                throws RuntimeIOException

Parameters:

gpio - GPIO to which the output device is connected.

initialValue - Initial output value (0..1).

Throws:

RuntimeIOException - If an I/O error occurred.

PwmOutputDevice

public PwmOutputDevice(int gpio,
int pwmFrequency,
float initialValue)
                throws RuntimeIOException

Parameters:

gpio - GPIO to which the output device is connected.

initialValue - Initial output value (0..1).

pwmFrequency - PWM frequency (Hz).

Throws:

RuntimeIOException - If an I/O error occurred.

PwmOutputDevice

public PwmOutputDevice(PwmOutputDeviceFactoryInterface pwmDeviceFactory,
int gpio,
float initialValue)
                throws RuntimeIOException

Parameters:

pwmDeviceFactory - Device factory to use to provision this device.

gpio - GPIO to which the output device is connected.

initialValue - Initial output value (0..1).

Throws:

RuntimeIOException - If an I/O error occurred.

PwmOutputDevice

public PwmOutputDevice(PwmOutputDeviceFactoryInterface pwmDeviceFactory,
int gpio,
int pwmFrequency,
float initialValue)
                throws RuntimeIOException

Parameters:

pwmDeviceFactory - Device factory to use to provision this device.

gpio - GPIO to which the output device is connected.

pwmFrequency - PWM frequency (Hz).

initialValue - Initial output value (0..1).

Throws:

RuntimeIOException - If an I/O error occurred.

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

onOffLoop

protected void onOffLoop(float onTime,
float offTime,
int n,
boolean background)
                  throws RuntimeIOException

Throws:

RuntimeIOException

fadeInOutLoop

protected void fadeInOutLoop(float fadeTime,
int steps,
int iterations,
boolean background)
                      throws RuntimeIOException

Throws:

RuntimeIOException

setValueInternal

protected void setValueInternal(float value)
                         throws RuntimeIOException

Throws:

RuntimeIOException

getValue

public float getValue()
               throws RuntimeIOException

Get the current PWM output value (0..1).

Returns:

Current PWM output value.

Throws:

RuntimeIOException - If an I/O error occurred.

setValue

public void setValue(float value)
              throws RuntimeIOException

Set the PWM output value (0..1).

Specified by:

setValue in interface OutputDeviceInterface

Parameters:

value - New PWM output value.

Throws:

RuntimeIOException - If an I/O error occurred.

on

public void on()
        throws RuntimeIOException

Turn on the device (same as setValue(1)).

Throws:

RuntimeIOException - If an I/O error occurred.

off

public void off()
         throws RuntimeIOException

Turn off the device (same as setValue(0)).

Throws:

RuntimeIOException - If an I/O error occurred.

toggle

public void toggle()
            throws RuntimeIOException

Toggle the state of the device (same as setValue(1 - getvalue()) ).

Throws:

RuntimeIOException - If an I/O error occurred.

isOn

public boolean isOn()
             throws RuntimeIOException

Get the device on / off status.

Returns:

Returns true if the device currently has a value > 0.

Throws:

RuntimeIOException - If an I/O error occurred.