de.weAut.demos

Class BlinkOnPi

java.lang.Object

de.frame4j.util.App

de.weAut.demos.BlinkOnPi

All Implemented Interfaces:

AttrSettable, TextHelper.MessageComponents, AppMBean, ComVar, UIInfo, BlinkOnPiMBean, PiUtil, PiVals, ActionListener, EventListener

@MinDoc(copyright="Copyright 2021  A. Weinert",
        version="V.56",
        lastModified="28.06.2021",
        usage="start as Java application (-? for help)",
        purpose="a Frame4J program to blink LEDs on a Pi via pigpioD")
public class BlinkOnPi
extends App
implements PiUtil, BlinkOnPiMBean

BlinkOnPi – a pigpiod test and demo program.

This program uses Joan N.N's pigpio library's socket interface directly. Hence, it is 100% pure Java — that means no JNI (Java native interface) is used.

Its main function is to blink three LEDs:

  Pi 1  / Pi 3       Pin
  GPIO17/ 17 : red    11
  GPIO25     : yellow 22 
  GPIO21/ 27 : green  13

Additionally, a Lo input on Pin 7 will set Pin 12 Hi. Those Pins are a Lo active button and a buzzer in the trafficPi shield (featuring also 12 LEDs as traffic lights on a cross road to play with).
The button to buzzer function can be disabled by start parameter -noButBuz and the four (trafficPi) traffic light can be chosen as LEDs by options -north -east -south or -west.
This program's help output by
java de.weAut.demos.BlinkOnPi -help [-en | -de]
will show all options and parameters. -en or -de will switch the program's (help) output to English respectively German if the operating system tells otherwise.

In Java, for good reasons, we do not have the "make and macro and all can be automatically changed" mechanism. In a Java program, by playing with inheritance and polymorphism, we can postpone the Pi type decision in a better way to runtime, e.g. by making a ThePi object either by a Pi3 (for Pi0, 3 and 4), Pi1 or Pi2 interface's inner class.

Settings, start parameter evaluation etc. are defined by BlinkOnPi.properties.

Copyright © 2021 Albrecht Weinert

Version:

56 (28.06.2021)

Author:

Albrecht Weinert a-weinert.de

See Also:

BlinkOnPiMBean, TestOnPi, BlinkOnPiMBean, PiUtil, BlinkOnPi.properties, Raspi4testPins

Nested Class Summary

Nested classes/interfaces inherited from interface de.weAut.PiUtil

PiUtil.Impl, PiUtil.LeTick

Field Summary

Fields

Modifier and Type	Field and Description
int	buttPin The button pin.
int	buzzPin The buzzer.
int	ledGNpin A LED to blink.
int	ledRDpin A LED to blink.
int	ledYEpin A LED to blink.

Fields inherited from class de.frame4j.util.App

ano, appBase, appIO, appStartTime, appStartTimeMS, args, argsOrig, bgColor, err, fullClassName, help, icon, log, mainThread, myClass, myFrame, name, out, outMode, packName, prop, retCode, runFlag, shortClassName, title, verbose, verbosity

Fields inherited from interface de.weAut.PiUtil

ERR_ASSIGN_PIN, ERR_CLOSE_WDOG, ERR_NoGPIOLOCK, ERR_NoLOCKFILE, ERR_NoLOCKPROC, ERR_NOT_LOCKED, ERR_OPEN_W_DOG, ERR_PIGPIOD_CON, lckPiGpioPth, lckWinGpioPth

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

Fields inherited from interface de.frame4j.net.AttrSettable

ILLEGAL_TYPE, ILLEGAL_VALUE, NO_ATTRIBUTE, NO_KNOWN_ATTRIBUTE, NO_VALUE, OK, retVtext

Constructor Summary

Constructors

Constructor and Description
BlinkOnPi()

Method Summary

Modifier and Type	Method and Description
int	doIt() The application's work.
Integer	getCycCount() See the number of cycles.
Boolean	getLeBut() The state of the button.
Boolean	getLeBuz() The state of the buzzer.
Integer	getLeBuzPWM() The PWM state of the buzzer.
Boolean	getLEDgn() The state of the green LED(s).
Boolean	getLEDrd() The state of the red LED(s).
Boolean	getLEDye() The state of the yellow LED(s).
Integer	getPiType() Get the Pi type.
static void	main(String[] args) The application start.
void	setCycCount(Integer cycCount) Set the number of cycles.
void	setLeBuz(Boolean on) The state of the buzzer.
void	setLeBuzPWM(Integer pwm) Set buzzer output by PMM.

Methods inherited from class de.frame4j.util.App

actionPerformed, allowNoPropertiesFile, clientOrder, condHelpLog, connect, errMeld, errMeld, errorExit, errorExit, errorText, extraPropertiesFile, formMessage, formMessage, formMessage, getAbout, getAboutText, getActTime, getAppLogger, getAppStartTime, getArgs, getAuthor, getCopyright, getDbLogger, getExecTimeMs, getExecTimeMsL, getExecTimeString, getHelp, getHelpText, getIcon, getLanguage, getLogHandler, getMessageComponent, getMessageComponentsLength, getMyFrame, getName, getNameWithVersDate, getOutMode, getProp, getPurpose, getStartTime, getStateString, getTheCloser, getTitle, getUsage, getVerbose, getVerbosity, getVersDate, go, go, go, haveIcon, isDebug, isHelp, isHelpLog, isNormal, isRunFlag, isSilent, isTest, isVerbose, logVerbose, logVerbose, makeStatusTextEnd, makeStatusTextStart, messageFormat, normalExit, parsePartial, performeAction, queueAction, regAsStdMBean, repExc, setAboutText, setAttribute, setAttribute, setAuthor, setBgColor, setCodePages, setCopyright, setHelp, setLogOut2, setName, setOutMode, setOutMode, setPurpose, setTitle, setUsage, setVerbose, setVerbose, setVerbosity, setVerbosity, setVersDate, stop, threeLineEndMsg, toString, twoLineEndMsg, twoLineStartMsg, valueLang, valueLang, wakeMainThread

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.weAut.PiUtil

argHost, argPiType, argPort, argTimeout, closeLock, closeWatchdog, eightDigitHex, errorText, getDelCnt, getLastExcept, getLastExcMess, getLastLockFN, getOut, getOvrCnt, getUseLock, openLock, openLockPi, openWatchdog, regAsStdMBean, repExc, setArgHost, setArgPiType, setArgPort, setArgTimeout, setUseLock, systemExit, thrDelay, triggerWatchdog, twoDigitDec

Methods inherited from interface de.frame4j.util.AppMBean

getActTime, getArgs, getCopyright, getExecTimeMsL, getLanguage, getName, getPurpose, getStartTime, getVerbose, getVersDate, stop

Methods inherited from interface de.frame4j.net.AttrSettable

retVtext

Field Detail

ledRDpin

public int ledRDpin

A LED to blink.

The default pins for rd/ye/gn LED are 11, 22, and 13. This is the traditional (2017) experimental setup.
With a piTraffic (cross roads) head ledGNpin would be south yellow and ledYEpin west green.

ledYEpin

public int ledYEpin

A LED to blink.

The default pins for rd/ye/gn LED are 11, 22, and 13. This is the traditional (2017) experimental setup.
With a piTraffic (cross roads) head ledGNpin would be south yellow and ledYEpin west green.

ledGNpin

public int ledGNpin

A LED to blink.

The default pins for rd/ye/gn LED are 11, 22, and 13. This is the traditional (2017) experimental setup.
With a piTraffic (cross roads) head ledGNpin would be south yellow and ledYEpin west green.

buzzPin

public int buzzPin

The buzzer.

The default pin for a buzzer (respectively its switching transistor) is 12. This is the trafficPi assignment.

buttPin

public int buttPin

The button pin.

The default pin for a low active button (would need a pull up, internal or external) is 7. This is the trafficPi assignment.

Constructor Detail

BlinkOnPi

public BlinkOnPi()

Method Detail

getCycCount

public Integer getCycCount()

Description copied from interface: BlinkOnPiMBean

See the number of cycles.

As the duration of one cycle is 600ms (for BlinkOnPi it would take more than 40 years to overflow to negative.
Note: Java has no unsigned number type. In the C counterpart the type would be uint32_t.

Specified by:

getCycCount in interface BlinkOnPiMBean

Returns:

the loop count

See Also:

BlinkOnPiMBean.setCycCount(Integer)

setCycCount

public void setCycCount(Integer cycCount)

Description copied from interface: BlinkOnPiMBean

Set the number of cycles.

Specified by:

setCycCount in interface BlinkOnPiMBean

See Also:

BlinkOnPiMBean.getCycCount()

getLEDye

public Boolean getLEDye()

Description copied from interface: BlinkOnPiMBean

The state of the yellow LED(s).

The yellow LED(s) are inverted only once in a cycle.

Specified by:

getLEDye in interface BlinkOnPiMBean

Returns:

true when ON

getLEDgn

public Boolean getLEDgn()

Description copied from interface: BlinkOnPiMBean

The state of the green LED(s).

The yellow LED(s) are inverted twice in a cycle.

Specified by:

getLEDgn in interface BlinkOnPiMBean

Returns:

true when ON

getLEDrd

public Boolean getLEDrd()

Description copied from interface: BlinkOnPiMBean

The state of the red LED(s).

The red LED(s) are inverted twice in a cycle.

Specified by:

getLEDrd in interface BlinkOnPiMBean

Returns:

true when ON

getLeBut

public Boolean getLeBut()

Description copied from interface: BlinkOnPiMBean

The state of the button.

The button is low active. Hence, false means pressed.

Specified by:

getLeBut in interface BlinkOnPiMBean

Returns:

true when open, released

getLeBuz

public Boolean getLeBuz()

Description copied from interface: BlinkOnPiMBean

The state of the buzzer.

The buzzer is an extra output. Default is pin 12. On the trafficPi shield pin 12 is a buzzer switched on by Hi (via a npn transistor).
This method returns the binary on/off state of the pin in question. When actuated via PWM 0..21 is considered as OFF (low, false) and 22..255 as ON (hi, true).

Specified by:

getLeBuz in interface BlinkOnPiMBean

Returns:

true when active (Hi)

See Also:

BlinkOnPiMBean.setLeBuz(Boolean), BlinkOnPiMBean.setLeBuzPWM(Integer), BlinkOnPiMBean.getLeBuzPWM()

setLeBuz

public void setLeBuz(Boolean on)

Description copied from interface: BlinkOnPiMBean

The state of the buzzer.

Specified by:

setLeBuz in interface BlinkOnPiMBean

setLeBuzPWM

public void setLeBuzPWM(Integer pwm)

Description copied from interface: BlinkOnPiMBean

Set buzzer output by PMM.

Specified by:

setLeBuzPWM in interface BlinkOnPiMBean

Parameters:

pwm - 0..255 is 0..100% PWM

See Also:

BlinkOnPiMBean.getLeBuzPWM(), BlinkOnPiMBean.getLeBuz()

getLeBuzPWM

public Integer getLeBuzPWM()

Description copied from interface: BlinkOnPiMBean

The PWM state of the buzzer.

The buzzer is an extra output. Default is pin 12.

Specified by:

getLeBuzPWM in interface BlinkOnPiMBean

Returns:

0..255 which is 0..100% PWM

See Also:

BlinkOnPiMBean.getLeBuz()

getPiType

public Integer getPiType()

Description copied from interface: BlinkOnPiMBean

Get the Pi type.

Specified by:

getPiType in interface BlinkOnPiMBean

main

public static void main(String[] args)

The application start.

Will blink with three LEDs in an endless loop (in doIt()). Can be stopped by signal (cntlC), kill command and the like, as well as by an MBean client, like e.g. JConsole, by operation App.stop(). Run by java BlinkOnPi [host [port]] [-option [-option ....
LEDs rd,ye,gn Options are: -north 29 31 33; -east 36 38 40; -south 11 13 15; -west 16 18 22;
-LEDefault 11 22 13
Pi type options are: -pi0 -pi1 -pi3 -pi4 (0, 1, 3 and 4 map to 3, the default)

Parameters:

args - start parameters.

doIt

public int doIt()

The application's work.

When the startup succeeds this will run in an endless loop until killed by signal or stopped by MBean/JConsole command.

Specified by:

doIt in class App

Returns:

0: application ended OK; no errors, no results

See Also:

Prop, App.go(String[]), App.go(String[], String, CharSequence), App.mainThread