Package com.pi4j.io.gpio

Class PinProvider

java.lang.Object

com.pi4j.io.gpio.PinProvider

Direct Known Subclasses:

RaspiBcmPin, RaspiPin, RCMPin

public abstract class PinProvider
extends Object

Pi4J pin definitions

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<String,Pin>	pins

Constructor Summary

Constructors

Constructor	Description
PinProvider()

Method Summary

Modifier and Type	Method	Description
static Pin[]	allPins()	Get all pin instances from this provider.
static Pin[]	allPins(PinMode... mode)	Get all pin instances from this provider that support one of the provided pin modes.
protected static Pin	createAnalogInputPin(String providerName, int address, String name)
protected static Pin	createDigitalAndPwmPin(String providerName, int address, String name)
protected static Pin	createDigitalAndPwmPin(String providerName, int address, String name, EnumSet<PinEdge> edges)
protected static Pin	createDigitalPin(String providerName, int address, String name)
protected static Pin	createDigitalPin(String providerName, int address, String name, EnumSet<PinEdge> edges)
protected static Pin	createDigitalPin(String providerName, int address, String name, EnumSet<PinPullResistance> resistance, EnumSet<PinEdge> edges)
protected static Pin	createPin(String providerName, int address, String name, EnumSet<PinMode> modes)
protected static Pin	createPin(String providerName, int address, String name, EnumSet<PinMode> modes, EnumSet<PinPullResistance> resistance, EnumSet<PinEdge> edges)
static Pin	getPinByAddress(int address)
static Pin	getPinByName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

pins

protected static final Map<String,Pin> pins

Constructor Detail

PinProvider

public PinProvider()

Method Detail

createDigitalPin

protected static Pin createDigitalPin(String providerName,
                                      int address,
                                      String name)

createDigitalPin

protected static Pin createDigitalPin(String providerName,
                                      int address,
                                      String name,
                                      EnumSet<PinPullResistance> resistance,
                                      EnumSet<PinEdge> edges)

createDigitalPin

protected static Pin createDigitalPin(String providerName,
                                      int address,
                                      String name,
                                      EnumSet<PinEdge> edges)

createDigitalAndPwmPin

protected static Pin createDigitalAndPwmPin(String providerName,
                                            int address,
                                            String name,
                                            EnumSet<PinEdge> edges)

createDigitalAndPwmPin

protected static Pin createDigitalAndPwmPin(String providerName,
                                            int address,
                                            String name)

createAnalogInputPin

protected static Pin createAnalogInputPin(String providerName,
                                          int address,
                                          String name)

createPin

protected static Pin createPin(String providerName,
                               int address,
                               String name,
                               EnumSet<PinMode> modes)

createPin

protected static Pin createPin(String providerName,
                               int address,
                               String name,
                               EnumSet<PinMode> modes,
                               EnumSet<PinPullResistance> resistance,
                               EnumSet<PinEdge> edges)

getPinByName

public static Pin getPinByName(String name)

getPinByAddress

public static Pin getPinByAddress(int address)

allPins

public static Pin[] allPins()

Get all pin instances from this provider.

Returns:

all pin instances support by this provider

allPins

public static Pin[] allPins(PinMode... mode)

Get all pin instances from this provider that support one of the provided pin modes.

Parameters:

mode - one or more pin modes that you wish to include in the result set

Returns:

pin instances that support the provided pin modes