Package com.diozero.sbc
Class BoardPinInfo
- java.lang.Object
-
- com.diozero.sbc.BoardPinInfo
-
- Direct Known Subclasses:
BoardInfo
,MCP23x08.MCP23x08BoardPinInfo
,MCP23x17.MCP23x17BoardPinInfo
,McpAdc.McpAdcBoardPinInfo
,PCA9685.PCA9685BoardPinInfo
,PCF8574.PCF8574BoardPinInfo
,PCF8591.PCF8591BoardPinInfo
,PiconZero.PiconZeroBoardPinInfo
public class BoardPinInfo extends Object
Provide information about the GPIOs that are available on the connected board.
-
-
Field Summary
Fields Modifier and Type Field Description static String
ADC_KEY_PREFIX
static String
DAC_KEY_PREFIX
static String
DEFAULT_ADC_NAME_PREFIX
static String
DEFAULT_DAC_NAME_PREFIX
static String
DEFAULT_GPIO_NAME_PREFIX
static String
GPIO_KEY_PREFIX
-
Constructor Summary
Constructors Constructor Description BoardPinInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PinInfo
addAdcPinInfo(int adcNumber, int physicalPin)
PinInfo
addAdcPinInfo(int adcNumber, String name, int physicalPin)
void
addAdcPinInfo(PinInfo pinInfo)
PinInfo
addAdcPinInfo(String header, int adcNumber, String name, int physicalPin)
PinInfo
addDacPinInfo(int dacNumber, int pin)
PinInfo
addDacPinInfo(int dacNumber, String name, int pin)
void
addDacPinInfo(PinInfo pinInfo)
PinInfo
addDacPinInfo(String header, int dacNumber, int pin)
PinInfo
addDacPinInfo(String header, int dacNumber, String name, int pin)
void
addGeneralPinInfo(int physicalPin, String name)
void
addGeneralPinInfo(int physicalPin, String name, int chip, int line)
void
addGeneralPinInfo(PinInfo pinInfo)
void
addGeneralPinInfo(String header, int physicalPin, String name)
void
addGeneralPinInfo(String header, int physicalPin, String name, int chip, int line)
PinInfo
addGpioPinInfo(int gpioNum, int physicalPin, Collection<DeviceMode> modes)
PinInfo
addGpioPinInfo(int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes)
PinInfo
addGpioPinInfo(int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes, int chip, int line)
void
addGpioPinInfo(PinInfo pinInfo)
PinInfo
addGpioPinInfo(String header, int gpioNum, int physicalPin, Collection<DeviceMode> modes)
PinInfo
addGpioPinInfo(String header, int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes)
PinInfo
addGpioPinInfo(String header, int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes, int chip, int line)
PinInfo
addPwmPinInfo(int gpioNum, int physicalPin, int pwmNum, Collection<DeviceMode> modes)
PinInfo
addPwmPinInfo(int gpioNum, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes)
PinInfo
addPwmPinInfo(int gpioNum, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes, int chip, int line)
PinInfo
addPwmPinInfo(String header, int gpioNumber, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes)
PinInfo
addPwmPinInfo(String header, int gpioNumber, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes, int chip, int line)
Collection<PinInfo>
getAdcPins()
Optional<PinInfo>
getByAdcNumber(int adcNumber)
PinInfo
getByAdcNumberOrThrow(int adcNumber)
Optional<PinInfo>
getByChipAndLineOffset(int chipId, int lineOffset)
PinInfo
getByChipAndLineOffsetOrThrow(int chipId, int lineOffset)
Optional<PinInfo>
getByDacNumber(int dacNumber)
PinInfo
getByDacNumberOrThrow(int dacNumber)
Optional<PinInfo>
getByGpioNumber(int gpio)
PinInfo
getByGpioNumberOrThrow(int gpio)
PinInfo
getByName(String name)
Optional<PinInfo>
getByPhysicalPin(String headerName, int physicalPin)
PinInfo
getByPhysicalPinOrThrow(String headerName, int physicalPin)
Optional<PinInfo>
getByPwmNumber(int pwmNum)
PinInfo
getByPwmNumberOrThrow(int pwmNum)
Optional<PinInfo>
getByPwmOrGpioNumber(int pwmOrGpioNum)
PinInfo
getByPwmOrGpioNumberOrThrow(int pwmOrGpioNum)
Collection<PinInfo>
getDacPins()
Collection<PinInfo>
getGpioPins()
Map<Integer,PinInfo>
getGpios()
Collection<String>
getHeaderNames()
Map<String,Map<Integer,PinInfo>>
getHeaders()
Collection<Map<Integer,PinInfo>>
getHeaderValues()
int
mapToSysFsGpioNumber(int gpio)
-
-
-
Field Detail
-
GPIO_KEY_PREFIX
public static final String GPIO_KEY_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_GPIO_NAME_PREFIX
public static final String DEFAULT_GPIO_NAME_PREFIX
- See Also:
- Constant Field Values
-
ADC_KEY_PREFIX
public static final String ADC_KEY_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_ADC_NAME_PREFIX
public static final String DEFAULT_ADC_NAME_PREFIX
- See Also:
- Constant Field Values
-
DAC_KEY_PREFIX
public static final String DAC_KEY_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_DAC_NAME_PREFIX
public static final String DEFAULT_DAC_NAME_PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
addGeneralPinInfo
public void addGeneralPinInfo(int physicalPin, String name)
-
addGeneralPinInfo
public void addGeneralPinInfo(int physicalPin, String name, int chip, int line)
-
addGeneralPinInfo
public void addGeneralPinInfo(String header, int physicalPin, String name, int chip, int line)
-
addGeneralPinInfo
public void addGeneralPinInfo(PinInfo pinInfo)
-
addGpioPinInfo
public PinInfo addGpioPinInfo(int gpioNum, int physicalPin, Collection<DeviceMode> modes)
-
addGpioPinInfo
public PinInfo addGpioPinInfo(int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes)
-
addGpioPinInfo
public PinInfo addGpioPinInfo(int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes, int chip, int line)
-
addGpioPinInfo
public PinInfo addGpioPinInfo(String header, int gpioNum, int physicalPin, Collection<DeviceMode> modes)
-
addGpioPinInfo
public PinInfo addGpioPinInfo(String header, int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes)
-
addGpioPinInfo
public PinInfo addGpioPinInfo(String header, int gpioNum, String name, int physicalPin, Collection<DeviceMode> modes, int chip, int line)
-
addGpioPinInfo
public void addGpioPinInfo(PinInfo pinInfo)
-
addPwmPinInfo
public PinInfo addPwmPinInfo(int gpioNum, int physicalPin, int pwmNum, Collection<DeviceMode> modes)
-
addPwmPinInfo
public PinInfo addPwmPinInfo(int gpioNum, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes)
-
addPwmPinInfo
public PinInfo addPwmPinInfo(int gpioNum, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes, int chip, int line)
-
addPwmPinInfo
public PinInfo addPwmPinInfo(String header, int gpioNumber, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes)
-
addPwmPinInfo
public PinInfo addPwmPinInfo(String header, int gpioNumber, String name, int physicalPin, int pwmNum, Collection<DeviceMode> modes, int chip, int line)
-
addAdcPinInfo
public PinInfo addAdcPinInfo(int adcNumber, int physicalPin)
-
addAdcPinInfo
public PinInfo addAdcPinInfo(String header, int adcNumber, String name, int physicalPin)
-
addAdcPinInfo
public void addAdcPinInfo(PinInfo pinInfo)
-
addDacPinInfo
public PinInfo addDacPinInfo(int dacNumber, int pin)
-
addDacPinInfo
public void addDacPinInfo(PinInfo pinInfo)
-
getByGpioNumberOrThrow
public PinInfo getByGpioNumberOrThrow(int gpio) throws NoSuchDeviceException
- Throws:
NoSuchDeviceException
-
getByPhysicalPinOrThrow
public PinInfo getByPhysicalPinOrThrow(String headerName, int physicalPin) throws NoSuchDeviceException
- Throws:
NoSuchDeviceException
-
getByChipAndLineOffsetOrThrow
public PinInfo getByChipAndLineOffsetOrThrow(int chipId, int lineOffset) throws NoSuchDeviceException
- Throws:
NoSuchDeviceException
-
getByPwmNumberOrThrow
public PinInfo getByPwmNumberOrThrow(int pwmNum)
-
getByPwmOrGpioNumberOrThrow
public PinInfo getByPwmOrGpioNumberOrThrow(int pwmOrGpioNum)
-
getByAdcNumberOrThrow
public PinInfo getByAdcNumberOrThrow(int adcNumber)
-
getByDacNumberOrThrow
public PinInfo getByDacNumberOrThrow(int dacNumber)
-
getHeaderNames
public Collection<String> getHeaderNames()
-
getHeaderValues
public Collection<Map<Integer,PinInfo>> getHeaderValues()
-
getGpioPins
public Collection<PinInfo> getGpioPins()
-
getAdcPins
public Collection<PinInfo> getAdcPins()
-
getDacPins
public Collection<PinInfo> getDacPins()
-
mapToSysFsGpioNumber
public int mapToSysFsGpioNumber(int gpio)
-
-