Package com.diozero.internal.provider.builtin

Class SysFsPwmOutputDevice

java.lang.Object

com.diozero.internal.spi.AbstractDevice

com.diozero.internal.provider.builtin.SysFsPwmOutputDevice

All Implemented Interfaces:

DeviceInterface, GpioDeviceInterface, InternalDeviceInterface, PwmOutputDeviceInterface, AutoCloseable

public class SysFsPwmOutputDevice
extends AbstractDevice
implements PwmOutputDeviceInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SysFsPwmOutputDevice.Polarity

Constructor Summary

Constructors

Constructor	Description
SysFsPwmOutputDevice(String key, DeviceFactoryInterface deviceFactory, int pwmChip, PwmPinInfo pinInfo, int frequencyHz, float initialValue)

Method Summary

Modifier and Type	Method	Description
protected void	closeDevice()
int	getGpio()
int	getPwmFrequency()	Get the PWM frequency in Hz
int	getPwmNum()	Get the device PWM output device number
float	getValue()	Get the current PWM output value (0..1)
void	setPwmFrequency(int frequencyHz)	Set the PWM output frequency
void	setValue(float value)	Set the PWM output value (0..1)

Methods inherited from class com.diozero.internal.spi.AbstractDevice

close, getDeviceFactory, getKey, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.diozero.api.DeviceInterface

close

Methods inherited from interface com.diozero.internal.spi.InternalDeviceInterface

getKey, isOpen

Methods inherited from interface com.diozero.internal.spi.PwmOutputDeviceInterface

getMode

Constructor Detail

SysFsPwmOutputDevice

public SysFsPwmOutputDevice(String key,
                            DeviceFactoryInterface deviceFactory,
                            int pwmChip,
                            PwmPinInfo pinInfo,
                            int frequencyHz,
                            float initialValue)

Method Detail

closeDevice

protected void closeDevice()

Specified by:

closeDevice in class AbstractDevice

getGpio

public int getGpio()

Specified by:

getGpio in interface GpioDeviceInterface

getPwmNum

public int getPwmNum()

Description copied from interface: PwmOutputDeviceInterface

Get the device PWM output device number

Specified by:

getPwmNum in interface PwmOutputDeviceInterface

Returns:

Device native PWM output

getValue

public float getValue()
               throws RuntimeIOException

Description copied from interface: PwmOutputDeviceInterface

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

Specified by:

getValue in interface PwmOutputDeviceInterface

Returns:

Range is 0..1

Throws:

RuntimeIOException - if an I/O error occurs

setValue

public void setValue(float value)
              throws RuntimeIOException

Description copied from interface: PwmOutputDeviceInterface

Set the PWM output value (0..1)

Specified by:

setValue in interface PwmOutputDeviceInterface

Parameters:

value - Relative value in the range 0..1

Throws:

RuntimeIOException - if an I/O error occurs

getPwmFrequency

public int getPwmFrequency()

Description copied from interface: PwmOutputDeviceInterface

Get the PWM frequency in Hz

Specified by:

getPwmFrequency in interface PwmOutputDeviceInterface

Returns:

frequency in Hz

setPwmFrequency

public void setPwmFrequency(int frequencyHz)
                     throws RuntimeIOException

Description copied from interface: PwmOutputDeviceInterface

Set the PWM output frequency

Specified by:

setPwmFrequency in interface PwmOutputDeviceInterface

Parameters:

frequencyHz - frequency in Hz

Throws:

RuntimeIOException - if an I/O error occurs