de.weAut

Class ThePi.Port

java.lang.Object

de.weAut.ThePi.Port

Enclosing interface:

ThePi

public static class ThePi.Port
extends Object

A port on this Pi.

See Also:

ThePi.portByGPIO(int, String), ThePi.portByPin(int, String)

Field Summary

Fields

Modifier and Type	Field and Description
String	name The port's (short) name.
int	pud A flag to record the port's pull resistor setting.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Equal with other port.
int	getGpio() The pin and GPIO number.
int	getPin() The pin number.
int	hashCode() Hashcode.
boolean	isIO() Usable for IO.
void	setGpio(int gpio) Set GPIO for IO operations.
void	setPin(int pin) Set pin for IO operations.
void	setPort(String port) Change IO settings.
String	toString() Short description of the port.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

public final String name

The port's (short) name.

Neither null nor empty; recommended length: 7.

pud

public int pud

A flag to record the port's pull resistor setting.

default: PiVals.PI_PUD_KP

See Also:

PiVals.PI_PUD_OFF, PiVals.PI_PUD_DOWN, PiVals.PI_PUD_UP, PiVals.PI_PUD_DT, ClientPigpiod

Method Detail

getPin

public int getPin()

The pin number.

See Also:

setPin(int), getGpio(), setGpio(int), setPort(String)

getGpio

public int getGpio()

The pin and GPIO number.

See Also:

getPin(), setPin(int), setGpio(int), setPort(String)

isIO

public final boolean isIO()

Usable for IO.

This method returns true when this port's GPIO can be used for both real input and output operations.

Returns:

gpio < 32

setGpio

public void setGpio(int gpio)

Set GPIO for IO operations.

setPin

public void setPin(int pin)

Set pin for IO operations.

setPort

public void setPort(String port)

Change IO settings.

This method sets the port's IO either as pin number or as GPIO with a prefix G. A postfix U, D or N will set the pull resistor flag as up, down or none.
Without postfix the pull resistor setting pud will be kept untouched.

Parameters:

port - pin (12N, e.g.) or gpio (with leading G; G18, e.g.)

toString

public final String toString()

Short description of the port.

The text returned consists of the name, the port number, a letter for the pull resistor setting and the gpio number with a prefix "G".

Overrides:

toString in class Object

equals

public final boolean equals(Object other)

Equal with other port.

From the physical sight of a Raspberry Pi's IO to outside world two ports have equal effects or information when the GPIO numbers are equal.
This sight is implemented here and, consistently, in hashCode().

Overrides:

equals in class Object

Returns:

true when other is a Port object with the same GPIO

hashCode

public final int hashCode()

Hashcode.

Overrides:

hashCode in class Object

Returns:

gpio

See Also:

equals(Object)