de.weAut

Interface ThePi

All Superinterfaces:

ComVar, PiVals

All Known Implementing Classes:

Pi1, Pi2, Pi3, ThePi.ComBeh

public interface ThePi
extends PiVals

Definitions for the usage of a Raspberry Pi device.

© Copyright 2021 Albrecht Weinert

A derived interface of this type will contain constants and methods describing a Pi type like Pi1, Pi2, or Pi3 for Pi3, P4 and Pi0. Insofar this interface acts as an abstract class (allowing multiple inheritance for future applications).

A make() method here (respectively the one called in said sub interfaces) will yield a Pi object holding the type and some application data of a concrete Pi device.
A Pi (ThePi) object will be usually held and usually made within ClientPigpiod object holding also the pigpiod (socket) access data and comfortably implementing the IO.

Additionally, objects of the ThePi's inner class Port may be used to hold data (and behaviour) of one of this Pi's IO ports.

Version:

53 (21.06.2021)

Author:

Albrecht Weinert

See Also:

Pi1, Pi2, Pi3, ClientPigpiod

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ThePi.ComBeh Predefined behaviour for ThePi objects.
static class	ThePi.Impl Internal implementation class.
static class	ThePi.Port A port on this Pi.

Field Summary

Fields

Modifier and Type	Field and Description
static String	defaultHost The pigpiod default host.

Fields inherited from interface de.weAut.PiVals

GPIO_INP, GPIO_OUT, GPIOmax, GPIOmin, GPIOutM, H1, HI, L0, LO, PI_PUD_DOWN, PI_PUD_DT, PI_PUD_KP, PI_PUD_OFF, PI_PUD_UP, PIN0, PIN00, PIN01, PIN02, PIN04, PIN06, PIN09, PIN0V, PIN1, PIN14, PIN17, PIN2, PIN20, PIN25, PIN3V, PIN4, PIN5V, PIN6, PIN9, PINig, PINix, PIO_ALT0, PIO_ALT1, PIO_ALT2, PIO_ALT3, PIO_ALT4, PIO_ALT5

Fields inherited from interface de.frame4j.util.ComVar

AUTHOR, BLANK_STRING, cons, CONSOL_ENCODING, COPYRIGHT, D, D_NaN, D_NegInf, D_PosInf, EMPTY_INT_A, EMPTY_STRING, FILE_ENCODING, FRW_CLLD, FS, FSS, H, hasCons, HOST_IP, HOST_IPv4, HOST_NAME, INIT_ERROR, JAR_ENCODING, JH, JOB_DONE_OK, JRL, LOG_OUT_ERROR, M, MAIN_THREAD_EXC, NO_BYTES, NO_CLASSES, NO_DOUBLES, NO_OBJECTS, NO_PARS_ERROR, NO_STRINGS, NOT_WINDOWS, ON_PI, ONE_DAY, ONE_HOUR, ONE_LEAP_YEAR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR, OS, PROG_NAME, PROG_SHORT, PS, RUNTIME, S, SHY, UD, UL, UL_UR_da, UR

Method Summary

Modifier and Type	Method and Description
int	gpio2pin(int gpio) Pin number to GPIO number lookup.
static String	gpio2String(int gpio) Format a GPIO number.
int	gpio4pin(int pin) Pin number to GPIO number lookup.
default int	gpio4pinChck(CharSequence signal, int pin) Pin number to GPIO number lookup with check.
static boolean	gpioMayOut(int gpio) Allows a GPIO number output.
default int	gpios4pins(int[] pins) Pin number array to GPIO mask lookup.
default int	gpios4pinsChck(CharSequence signal, int[] pins) Pins array to GPIO mask lookup with check.
String	host() The Pi's hostname for a pigpiod socket connection.
static ThePi	make(String host, int port, int timeout, int type) Make a Pi.
default String	pinDescr(int pin, int pud)
default ThePi.Port	portByGPIO(int gpio, String name) Make an input/output port for this Pi.
default ThePi.Port	portByPin(int pin, String name) Make an input/output port for this Pi.
int	sockP() The Pi's socket port number for a pigpiod socket connection.
int	timeout() The Pi's tiemout for a pigpiod socket connect in ms.
int	type() The Pi's type.

Field Detail

defaultHost

static final String defaultHost

The pigpiod default host.

If the Java application is running on a Raspberry Pi the default host is 127.0.0.1, i.e. the local machine itself.
On other platforms it is p.r.v.67 (would be 192.168.178.67 in standard Fritzbox home net). Ending in .67 is our standard experimental Pi in the private home respectively laboratory (C net) LAN.
If another value (as 67 on a C net) shall be used use the respective factory methods in Pi3, Pi1 or Pi2.

Method Detail

portByPin

default ThePi.Port portByPin(int pin,
                             String name)
                      throws IOException

Make an input/output port for this Pi.

For this ThePi object and associated with it a ThePi.Port object will be made an returned.
Hint: Due to the association a ThePi object can't be garbage collected before all of the ThePi.Port objects made for it.

Parameters:

name - a short (best 7 char) description of the pin's attached device like "red LED", "servo16" etc.; must not be empty

pin - 0, 1..40 (26 [+8]) is the legal IO connector pin number

Returns:

an operable Port object on success

Throws:

IOException - if the pin does not allow input and output operations with a comprehensive message

portByGPIO

default ThePi.Port portByGPIO(int gpio,
                              String name)
                       throws IOException

Make an input/output port for this Pi.

Parameters:

name - a short (best 7 char) description of the pin's attached device like "red LED", "servo16" etc.; must not be empty

gpio - 0..32 or PiVals.PINig an operable / legal GPIO number

Returns:

an operable Port object on success

Throws:

IOException - if the pin does not allow the IO operation intended with a comprehensive message

gpioMayOut

static boolean gpioMayOut(int gpio)

Allows a GPIO number output.

This method return true for 0..31 and for PiVals.PINig.
Rationale: Output to gpio 32 to 56 may spoil the operating system (while input from there would be feasible). And operations on PiVals.PINig (ignore pin/gpio) will not be performed (and here ignored without error).

Parameters:

gpio - a GPIO number

Returns:

true when output is principally allowable

See Also:

{@link #PINig}

gpio2String

static String gpio2String(int gpio)

Format a GPIO number.

A legal gpio number will be formated as GPIO00 .. GPIO31 or gpio32 ..gpio56.
Pseudo GPIO numbers for non IO pins like PiVals.PIN3V etc. will be formated as gnd, 3V3, 5V0, ignore.

All other values (and PiVals.PINix) will get none.

Parameters:

gpio - a GPIO number

Returns:

the text

pinDescr

default String pinDescr(int pin,
                        int pud)

gpio4pin

int gpio4pin(int pin)

Pin number to GPIO number lookup.

Parameters:

pin - 0, 1..40 (26 [+8]) is the legal IO connector pin number

Returns:

0..31 (56) the GPIO number; PiVals.PIN0V, PiVals.PIN3V, PiVals.PIN5V, PiVals.PINix: undefined, i.e. illegal pin number or PiVals.PINig ignore for pin = 0

gpios4pins

default int gpios4pins(int[] pins)

Pin number array to GPIO mask lookup.

Parameters:

pins - an array of legal pin numbers 1..40 (26 [+8]) or 0 for ignore

Returns:

a bit mask for the GPIO numbers 0..31 set by the array pins. 0 means no non 0 entry in pins or erroneous entry or entries in pins

See Also:

gpios4pinsChck(CharSequence, int[])

gpio2pin

int gpio2pin(int gpio)

Pin number to GPIO number lookup.

Parameters:

gpio - 0..39 a GPIO number (eventually) available on the Pi's 40 (26) pins connector.

Returns:

1..40 as the respective pin or 0 if the GPIO is not on the pin connector.

gpio4pinChck

default int gpio4pinChck(CharSequence signal,
                         int pin)
                  throws IOException

Pin number to GPIO number lookup with check.

This method does (by delegating) the same pin to GPIO look up as gpio4pin(int). Additionally it raises an IOException with a comprehensive message, when the pin is no real IO pin for a GPIO in the range 0..31.

Parameters:

signal - a short (best 7 char) description of the pin's attached device like "red LED", "Ubat_12" etc. It is used for the IOexception message, only

pin - 0, 1..40 (26 [+8]) is the legal IO connector pin number

Returns:

0..31 (56) the GPIO number; PiVals.PIN0V, PiVals.PIN3V, PiVals.PIN5V, PiVals.PINix: undefined, i.e. illegal pin number or PiVals.PINig ignore for pin = 0

Throws:

IOException - if the pin does not allow the IO operation intended with a comprehensive message

gpios4pinsChck

default int gpios4pinsChck(CharSequence signal,
                           int[] pins)
                    throws IOException

Pins array to GPIO mask lookup with check.

This method does the same pin to GPIO look up as gpios4pins(int[]). Additionally it raises an IOException with a comprehensive message, when the pin is no real IO pin for a GPIO in the range 0..31 (instead of just returning 0).

Parameters:

signal - a short (best 7 char) description of the pin / signal or device group like "redLEDs", "relaysH" etc. It is used for the IOexception message, only

Throws:

IOException - on the first pinin the array not allowing the IO operation intended with a comprehensive message

See Also:

gpios4pins(int[])

sockP

int sockP()

The Pi's socket port number for a pigpiod socket connection.

Not used by ThePi itself; see ClientPigpiod.
default: 8888

host

String host()

The Pi's hostname for a pigpiod socket connection.

Not used by ThePi itself; see ClientPigpiod.
default: defaultHost

timeout

int timeout()

The Pi's tiemout for a pigpiod socket connect in ms.

Not used by ThePi itself; see ClientPigpiod.
default: 10000 (10s)

type

int type()

The Pi's type.

3, 0 and 4 stand for the Pi3 pinout.
1 stands for Pi1 and 2 for the Pi2.
The type information 1 and 2 may also be got by instanceof Pi1 and instanceof Pi2, respectively.

Returns:

1, 2 or 3, 0, 4

make

static ThePi make(String host,
                  int port,
                  int timeout,
                  int type)

Make a Pi.

Depending on type this method either makes a Pi3 (default), a Pi2 or a Pi1 object according to the other parameters. As the Pi4 and Pi0 have the same GPIO assignment as a Pi3 they all are represented by a Pi3 object.

Returns:

a ThePi object of given type with the given host, (socket) port and timeout

See Also:

Pi3.make(String, int, int, int), Pi1.make(String, int, int)