PiVals ( Frame4J -- the Java framework de.frame4j... )

All Superinterfaces:

ComVar

All Known Subinterfaces:

PiUtil, ThePi

All Known Implementing Classes:

BlinkOnPi, JustNotFLock, Pi1, Pi1WireThDemo, Pi2, Pi3, PiWDogDemo, RdGnPiGpioDBlink, TestOnPi, ThePi.ComBeh
```
public interface PiVals
extends ComVar
```
Type independent definitions for Raspberry Pis.

© Copyright 2021 Albrecht Weinert

This interface contains values for all Raspberry Pis and related applications.

Version:

56 (28.06.2021)

Author:

Albrecht Weinert

Nested Class Summary
- Nested classes/interfaces inherited from interface de.frame4j.util.ComVar
  ComVar.Impl

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GPIO_INP` GPIO input mode.
`static int`	`GPIO_OUT` GPIO output mode.
`static int`	`GPIOmax` Defines maximal existing GPIO number.
`static int`	`GPIOmin` Defines smallest existing GPIO number.
`static int`	`GPIOutM` Defines highest GPIO number allowed for output.
`static int`	`H1` Hi, ON.
`static boolean`	`HI` Hi, ON.
`static int`	`L0` Lo, OFF.
`static boolean`	`LO` Lo, OFF.
`static int`	`PI_PUD_DOWN`
`static int`	`PI_PUD_DT` Leave pull resistor setting as defaulted.
`static int`	`PI_PUD_KP` Leave pull resistor setting unchanged.
`static int`	`PI_PUD_OFF`
`static int`	`PI_PUD_UP`
`static int`	`PIN0` The Pi's GPIO pin connector mapping.
`static int`	`PIN00` The Pi's GPIO pin connector mapping.
`static int`	`PIN01` The Pi's 3.3 V µC supply pins.
`static int`	`PIN02` The Pi's 5.0 V µC board pins.
`static int`	`PIN04` The Pi's 5.0 V µC board pins.
`static int`	`PIN06` The Pi's ground pins.
`static int`	`PIN09` The Pi's ground pins.
`static int`	`PIN0V` Defines a Ground pin.
`static int`	`PIN1` The Pi's 3.3 V µC supply pins.
`static int`	`PIN14` The Pi's ground pins.
`static int`	`PIN17` The Pi's 3.3 V µC supply pins.
`static int`	`PIN2` The Pi's 5.0 V µC board pins.
`static int`	`PIN20` The Pi's ground pins.
`static int`	`PIN25` The Pi's ground pins.
`static int`	`PIN3V` Defines a 3.3 V pin.
`static int`	`PIN4` The Pi's 5.0 V µC board pins.
`static int`	`PIN5V` Defines a 5 V pin.
`static int`	`PIN6` The Pi's ground pins.
`static int`	`PIN9` The Pi's ground pins.
`static int`	`PINig` Defines non existing GPIO number for a disabled GPIO pin.
`static int`	`PINix` A GPIO number to mark a non existing pin.
`static int`	`PIO_ALT0` GPIO alternative mode 0.
`static int`	`PIO_ALT1` GPIO alternative mode 1.
`static int`	`PIO_ALT2` GPIO alternative mode 2.
`static int`	`PIO_ALT3` GPIO alternative mode 3.
`static int`	`PIO_ALT4` GPIO alternative mode 4.
`static int`	`PIO_ALT5` GPIO alternative mode 5.

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

- Field Detail
  - GPIOmax
```
static final int GPIOmax
```
    Defines maximal existing GPIO number.
    
    Value: 56
    
    See Also:
    
    GPIOmin, #PINig, Constant Field Values
  - GPIOmin
```
static final int GPIOmin
```
    Defines smallest existing GPIO number.
    
    Value: 0
    
    See Also:
    
    GPIOmax, #PINig, Constant Field Values
  - GPIOutM
```
static final int GPIOutM
```
    Defines highest GPIO number allowed for output.
    
    Principally all GPIO numbers in the range GPIOmin.. GPIOmax= 0..56 could be used for input and output – and pigpiod would allow this.
    Nevertheless it is highly recommended not to use GPIO numbers above {@link #GPIOouM} = 31 for output.
    Rationale: Any output related operation to GPIO 32 to 56 may spoil the operating system.
    Hence, all output related methods of this framework will reject the attempt as error.
    
    Value: 31
    
    See Also:
    
    GPIOmin, GPIOmax, PINig, ThePi.gpioMayOut(int), Constant Field Values
  - PINig
```
static final int PINig
```
    Defines non existing GPIO number for a disabled GPIO pin.
    
    Assigning this special undefined GPIO number to a GPIO variable or parameter means not assigned or disabled. All IO methods of this framework will accept this value as GPIO parameter and and won't do any action on it nor raise an error.
    Value: 57 = GPIOmax + 1
    
    See Also:
    
    Constant Field Values
  - PINix
```
static final int PINix
```
    A GPIO number to mark a non existing pin.
    
    This special undefined GPIO number will be returned for / assigned to non existing pin numbers, i.e. outside [1..40] for Pi3, Pi4 and Pi0 and outside [1..26] for Pi1. In any sequence of GPIO numbers this value, also, marks the end (as last+1 entry).
    Value: 99
    Nota bene: PINix as all constants called PIN** are GPIO numbers. A non existing pin or one for a non existent signal will get the pin number 0. The smallest possible pin number on a pin connector is 1.
    
    See Also:
    
    Constant Field Values
  - PIN0V
```
static final int PIN0V
```
    Defines a Ground pin.
    
    This special undefined GPIO number will be assigned to respectively returned for ground pins (Gnd, 0V). Methods asked to act on this pseudo GPIO number are free to do nothing (ignore) or raise an error. The recommended behaviour is ignore.
    Value: 90
    
    See Also:
    
    Constant Field Values
  - PIN3V
```
static final int PIN3V
```
    Defines a 3.3 V pin.
    
    This special undefined GPIO number will be assigned to respectively returned for µC supply voltage pins (3.3V). Methods asked to act on this pseudo GPIO number are free to do nothing (ignore) or raise an error. The recommended behaviour is ignore.
    Value: 93
    
    See Also:
    
    Constant Field Values
  - PIN5V
```
static final int PIN5V
```
    Defines a 5 V pin.
    
    This special undefined GPIO number will be assigned to respectively returned for µC supply voltage pins (3.3V). Methods asked to act on this pseudo GPIO number are free to do nothing (ignore) or raise an error. The recommended behaviour is ignore.
    Value: 95
    
    See Also:
    
    Constant Field Values
  - PIN00
```
static final int PIN00
```
    The Pi's GPIO pin connector mapping.
    
    There are int constants by name PINn and PINnn with hn resp. n in the range 1 resp. 01 to 40 with the GPIO number or function of the Pi type as value.
    
    As there is no pin 0 the extra constants PIN00 and PIN0 have the value PINix (non existent pin; error).
    
    This is ported from arch/config_raspberry_03.h
    
    See Also:
    
    Constant Field Values
  - PIN0
```
static final int PIN0
```
    The Pi's GPIO pin connector mapping.
    
    There are int constants by name PINn and PINnn with hn resp. n in the range 1 resp. 01 to 40 with the GPIO number or function of the Pi type as value.
    
    As there is no pin 0 the extra constants PIN00 and PIN0 have the value PINix (non existent pin; error).
    
    This is ported from arch/config_raspberry_03.h
    
    See Also:
    
    Constant Field Values
  - PIN01
```
static final int PIN01
```
    The Pi's 3.3 V µC supply pins.
    
    The 3.3 V pins are 1 and 17 on all Pi types denoted by constants PIN1, PIN01 and PIN17 with value PIN3V.
    
    See Also:
    
    Constant Field Values
  - PIN1
```
static final int PIN1
```
    The Pi's 3.3 V µC supply pins.
    
    The 3.3 V pins are 1 and 17 on all Pi types denoted by constants PIN1, PIN01 and PIN17 with value PIN3V.
    
    See Also:
    
    Constant Field Values
  - PIN17
```
static final int PIN17
```
    The Pi's 3.3 V µC supply pins.
    
    The 3.3 V pins are 1 and 17 on all Pi types denoted by constants PIN1, PIN01 and PIN17 with value PIN3V.
    
    See Also:
    
    Constant Field Values
  - PIN02
```
static final int PIN02
```
    The Pi's 5.0 V µC board pins.
    
    The 5 V pins are 2 and 4 on all Pi types denoted by constants PIN2, PIN02, PIN4 and PIN04 with value PIN5V.
    
    See Also:
    
    Constant Field Values
  - PIN2
```
static final int PIN2
```
    The Pi's 5.0 V µC board pins.
    
    The 5 V pins are 2 and 4 on all Pi types denoted by constants PIN2, PIN02, PIN4 and PIN04 with value PIN5V.
    
    See Also:
    
    Constant Field Values
  - PIN04
```
static final int PIN04
```
    The Pi's 5.0 V µC board pins.
    
    The 5 V pins are 2 and 4 on all Pi types denoted by constants PIN2, PIN02, PIN4 and PIN04 with value PIN5V.
    
    See Also:
    
    Constant Field Values
  - PIN4
```
static final int PIN4
```
    The Pi's 5.0 V µC board pins.
    
    The 5 V pins are 2 and 4 on all Pi types denoted by constants PIN2, PIN02, PIN4 and PIN04 with value PIN5V.
    
    See Also:
    
    Constant Field Values
  - PIN06
```
static final int PIN06
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - PIN6
```
static final int PIN6
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - PIN09
```
static final int PIN09
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - PIN9
```
static final int PIN9
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - PIN14
```
static final int PIN14
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - PIN20
```
static final int PIN20
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - PIN25
```
static final int PIN25
```
    The Pi's ground pins.
    
    The pins 6 (PIN6, PIN06), 9, 14 20 and 25 are ground (gnd, 0V) pins on all Pi types, value PIN0V.
    On those with a 40 pin connector (Pi 3,4 0) the pins 30, 34 and 39 are Gnd, too.
    
    See Also:
    
    Constant Field Values
  - HI
```
static final boolean HI
```
    Hi, ON.
    
    This is the boolean variant of High, On, An, Go. See also the int variant H1. In pure C software this distinction is not necessary as there is no boolean and 0 is false and any other value, as e.g. 1, is considered true.
    In pure Java the numeric variant would be obsolet, but here we communicate with C software partly expecting integer values for true and false.
    See HI, LO; H1, L0 and note the boolean variants ending with capital letters (I, O) and the int variants with digits.
    
    See Also:
    
    Constant Field Values
  - LO
```
static final boolean LO
```
    Lo, OFF.
    
    This is the boolean variant of Low, Off, Aus, Halt.
    See the explanation at HI.
    
    See Also:
    
    Constant Field Values
  - H1
```
static final int H1
```
    Hi, ON.
    
    See the explanation at HI; see also L0.
    
    See Also:
    
    Constant Field Values
  - L0
```
static final int L0
```
    Lo, OFF.
    
    See the explanation at HI; see also H1.
    
    See Also:
    
    Constant Field Values
  - GPIO_INP
```
static final int GPIO_INP
```
    GPIO input mode.
    
    See Also:
    
    Constant Field Values
  - GPIO_OUT
```
static final int GPIO_OUT
```
    GPIO output mode.
    
    See Also:
    
    Constant Field Values
  - PIO_ALT0
```
static final int PIO_ALT0
```
    GPIO alternative mode 0.
    
    See Also:
    
    Constant Field Values
  - PIO_ALT1
```
static final int PIO_ALT1
```
    GPIO alternative mode 1.
    
    See Also:
    
    Constant Field Values
  - PIO_ALT2
```
static final int PIO_ALT2
```
    GPIO alternative mode 2.
    
    See Also:
    
    Constant Field Values
  - PIO_ALT3
```
static final int PIO_ALT3
```
    GPIO alternative mode 3.
    
    See Also:
    
    Constant Field Values
  - PIO_ALT4
```
static final int PIO_ALT4
```
    GPIO alternative mode 4.
    
    See Also:
    
    Constant Field Values
  - PIO_ALT5
```
static final int PIO_ALT5
```
    GPIO alternative mode 5.
    
    See Also:
    
    Constant Field Values
  - PI_PUD_OFF
```
static final int PI_PUD_OFF
```
    See Also:
    
    Constant Field Values
  - PI_PUD_DOWN
```
static final int PI_PUD_DOWN
```
    See Also:
    
    Constant Field Values
  - PI_PUD_UP
```
static final int PI_PUD_UP
```
    See Also:
    
    Constant Field Values
  - PI_PUD_KP
```
static final int PI_PUD_KP
```
    Leave pull resistor setting unchanged.
    
    This is an illegal value (4) just one above the legal ones (0..2). Its purpose is to state the current whatever pull setting shall be left untouched.
    
    See Also:
    
    Constant Field Values
  - PI_PUD_DT
```
static final int PI_PUD_DT
```
    Leave pull resistor setting as defaulted.
    
    This is an illegal value (3) just one above the legal ones (0..2). Its purpose is to state that an otherwise defined default value shall be used. If no such default value is known, the current pull setting shall be left untouched.
    
    See Also:
    
    Constant Field Values

Interface PiVals

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.util.ComVar

Field Summary

Fields inherited from interface de.frame4j.util.ComVar

Field Detail

GPIOmax

GPIOmin

GPIOutM

PINig

PINix

PIN0V

PIN3V

PIN5V

PIN00

PIN0

PIN01

PIN1

PIN17

PIN02

PIN2

PIN04

PIN4

PIN06

PIN6

PIN09

PIN9

PIN14

PIN20

PIN25

HI

LO

H1

L0

GPIO_INP

GPIO_OUT

PIO_ALT0

PIO_ALT1

PIO_ALT2

PIO_ALT3

PIO_ALT4

PIO_ALT5

PI_PUD_OFF

PI_PUD_DOWN

PI_PUD_UP

PI_PUD_KP

PI_PUD_DT