Module com.pi4j.plugin.pigpio

Package com.pi4j.plugin.pigpio.provider.pwm

Class PiGpioPwmBase

java.lang.Object

com.pi4j.common.IdentityBase

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

com.pi4j.io.pwm.PwmBase

com.pi4j.plugin.pigpio.provider.pwm.PiGpioPwmBase

All Implemented Interfaces:

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

Direct Known Subclasses:

PiGpioPwmHardware, PiGpioPwmSoftware

public abstract class PiGpioPwmBase
extends PwmBase
implements Pwm

Abstract PiGpioPwmBase 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 PiGpio	piGpio
protected final int	range

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
PiGpioPwmBase(PiGpio piGpio, PwmProvider provider, PwmConfig config, int range)	Constructor for PiGpioPwmBase.

Method Summary

Modifier and Type	Method	Description
protected int	calculateActualDutyCycle(float dutyCycle)	calculateActualDutyCycle.
int	getActualFrequency()
Pwm	initialize(Context context)

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

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

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.common.Lifecycle

shutdown

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, isOn, off, on, on, on, polarity, preset, presets, pwmType, setDutyCycle, setFrequency

Field Details

piGpio

protected final PiGpio piGpio

range

protected final int range

actualFrequency

protected int actualFrequency

logger

protected org.slf4j.Logger logger

Constructor Details

PiGpioPwmBase

public PiGpioPwmBase(PiGpio piGpio,
 PwmProvider provider,
 PwmConfig config,
 int range)

Constructor for PiGpioPwmBase.

Parameters:

piGpio - a PiGpio object.

provider - a PwmProvider object.

config - a PwmConfig object.

range - a int.

Method Details

calculateActualDutyCycle

protected int calculateActualDutyCycle(float dutyCycle)

calculateActualDutyCycle.

Parameters:

dutyCycle - a float.

Returns:

a int.

getActualFrequency

public int getActualFrequency()

Specified by:

getActualFrequency in interface Pwm

Overrides:

getActualFrequency in class PwmBase

initialize

public Pwm initialize(Context context)
               throws InitializeException

Specified by:

initialize in interface Lifecycle

Overrides:

initialize in class PwmBase

Throws:

InitializeException