Module com.pi4j.plugin.linuxfs

Package com.pi4j.plugin.linuxfs.provider.pwm

Class LinuxFsPwm

java.lang.Object

com.pi4j.common.IdentityBase

com.pi4j.io.IOBase<Pwm,PwmConfig,PwmProvider>

com.pi4j.io.pwm.PwmBase

com.pi4j.plugin.linuxfs.provider.pwm.LinuxFsPwm

All Implemented Interfaces:

Describable, Identity, Lifecycle, Extension, IO<Pwm,PwmConfig,PwmProvider>, OnOff<Pwm>, OnOffRead<Pwm>, OnOffWrite<Pwm>, Pwm

public class LinuxFsPwm
extends PwmBase
implements Pwm

LinuxFsPwm class.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected int	actualFrequency
protected org.slf4j.Logger	logger
protected final com.pi4j.plugin.linuxfs.internal.LinuxPwm	pwm

Fields inherited from class com.pi4j.io.pwm.PwmBase

dutyCycle, frequency, onState, polarity, presets

Fields inherited from class com.pi4j.io.IOBase

config, provider

Fields inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Fields inherited from interface com.pi4j.io.pwm.Pwm

HERTZ, KILOHERTZ, MEGAHERTZ

Constructor Summary

Constructors

Constructor	Description
LinuxFsPwm(com.pi4j.plugin.linuxfs.internal.LinuxPwm pwm, PwmProvider provider, PwmConfig config)	Constructor for PiGpioPwmHardware.

Method Summary

Modifier and Type	Method	Description
int	getActualFrequency()
Pwm	initialize(Context context)
boolean	isOn()
Pwm	off()
Pwm	on()
Pwm	shutdown(Context context)

Methods inherited from class com.pi4j.io.pwm.PwmBase

addPreset, applyPreset, deletePreset, getDutyCycle, getFrequency, getPreset, getPresets, setDutyCycle, setFrequency

Methods inherited from class com.pi4j.io.IOBase

config, context, describe, description, name, provider

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.io.OnOff

toggle

Methods inherited from interface com.pi4j.io.pwm.Pwm

actualFrequency, addPreset, address, applyPreset, deletePreset, dutyCycle, dutyCycle, frequency, frequency, getAddress, getDutyCycle, getFrequency, getPolarity, getPreset, getPresets, getPwmType, isOff, on, on, polarity, preset, presets, pwmType, setDutyCycle, setFrequency

Field Details

pwm

protected final com.pi4j.plugin.linuxfs.internal.LinuxPwm pwm

actualFrequency

protected int actualFrequency

logger

protected org.slf4j.Logger logger

Constructor Details

LinuxFsPwm

public LinuxFsPwm(com.pi4j.plugin.linuxfs.internal.LinuxPwm pwm,
 PwmProvider provider,
 PwmConfig config)

Constructor for PiGpioPwmHardware.

Parameters:

pwm - a LinuxPwm object.

provider - a PwmProvider object.

config - a PwmConfig object.

Method Details

initialize

public Pwm initialize(Context context)
               throws InitializeException

Specified by:

initialize in interface Lifecycle

Overrides:

initialize in class PwmBase

Throws:

InitializeException

on

public Pwm on()
       throws IOException

Specified by:

on in interface OnOffWrite<Pwm>

Specified by:

on in interface Pwm

Throws:

IOException

off

public Pwm off()
        throws IOException

Specified by:

off in interface OnOffWrite<Pwm>

Specified by:

off in interface Pwm

Throws:

IOException

isOn

public boolean isOn()

Specified by:

isOn in interface OnOffRead<Pwm>

Specified by:

isOn in interface Pwm

Overrides:

isOn in class PwmBase

getActualFrequency

public int getActualFrequency()
                       throws IOException

Specified by:

getActualFrequency in interface Pwm

Overrides:

getActualFrequency in class PwmBase

Throws:

IOException

shutdown

public Pwm shutdown(Context context)
             throws ShutdownException

Specified by:

shutdown in interface Lifecycle

Overrides:

shutdown in class PwmBase

Throws:

ShutdownException