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

java.lang.Object
- de.weAut.demos.RdGnPiGpioDBlink

All Implemented Interfaces:

ComVar, RdGnPiGpioDBlinkMBean, PiUtil, PiVals
```
public class RdGnPiGpioDBlink
extends Object
implements PiUtil, RdGnPiGpioDBlinkMBean
```
RdGnPiGpioDBlink – a Java pigpiod test and demo program.

This program is based on a port of pigpiod test and demo program rdGnPiGpioDBlink from C to Java. It 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.

Comment excerpt of the original/ported C source file:
```
  A fifth program for Raspberry's GPIO pins

  Rev. 61  20.07.2021
  Copyright  (c)  2019   Albrecht Weinert 

  weinert-automation.de      a-weinert.de

  It uses two/three pins as output assuming two LEDs connected to as H=on
  Pi 1  / Pi 3       Pin
  GPIO17/ 17 : red    11
  GPIO21/ 27 : green  13
  GPIO25     : yellow 22  (since Revision 45)
  This program forces application singleton and may be used as service.  
```
Its functions are the same as rdGnBlinkBlink (even sharing the lockFile) except for using the pigpioD library. Our makefiles define MCU and PLATFORM as make variables and macros. So we could make the GPIO pin and address assignment automatically in the C programmes.
(--- End of original C comment excerpt ---)

In Java, for good reasons, we do not have the "make plus macros and all can be wildly changed" mechanism. In a Java program, by playing with inheritance and polymorphism, we can postpone the Pi type decision – in a better way – to program's run time. Here this is done by making (by the factory method) ThePi.make(...) a ThePi object either as Pi3 (for Pi0, 3 and 4) or as a Pi1 or Pi2 (interface's inner class) object.

Hint: Contrary to the other Java IO on Pi programs, like BlinkOnPi and TestOnPi etc., this Java was written to be as similar as possible to its (rasProject) C counterpart for sake of C programmers. Hence, it is "Frame4J free" and deliberately waives its (as well as Java's) comfort and features.

Copyright © 2019 Albrecht Weinert
Version:

61 (20.07.2021)

Author:

Albrecht Weinert a-weinert.de

See Also:

BlinkOnPi, TestOnPi, Raspi4testPins, RdGnPiGpioDBlink.java

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 ledGNpin
The LEDs to blink.

int ledRDpin
The LEDs to blink.

int ledYEpin
The LEDs to blink.

PrintWriter out
- 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
Modifier and Type	Field and Description
`int`	`ledGNpin` The LEDs to blink.
`int`	`ledRDpin` The LEDs to blink.
`int`	`ledYEpin` The LEDs to blink.
`PrintWriter`	`out`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RdGnPiGpioDBlink(String[] args)
Make the application object.

Constructors
Modifier	Constructor and Description
`protected`	`RdGnPiGpioDBlink(String[] args)` Make the application object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`doIt()` The application's work.
`Integer`	`getCycCount()` See the number of cycles.
`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`	`stop()` Stop the cycle loop.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

- Field Detail
  - ledRDpin
```
public int ledRDpin
```
    The LEDs to blink.
    
    The default pins for rd/ye/gn 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
```
    The LEDs to blink.
    
    The default pins for rd/ye/gn 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
```
    The LEDs to blink.
    
    The default pins for rd/ye/gn 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.
  - out
```
public PrintWriter out
```
- Constructor Detail
  - RdGnPiGpioDBlink
```
protected RdGnPiGpioDBlink(String[] args)
```
    Make the application object.
- Method Detail
  - getCycCount
```
public Integer getCycCount()
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    See the number of cycles.
    
    As the duration of one cycle is 600ms it would take more than 40 years to overflow to negative.
    Note: Java has no unsigned number type. int is int32_t there is no uint32_t.
    
    Specified by:
    
    getCycCount in interface RdGnPiGpioDBlinkMBean
    
    Returns:
    
    the loop count
    
    See Also:
    
    RdGnPiGpioDBlinkMBean.setCycCount(Integer)
  - setCycCount
```
public void setCycCount(Integer cycCount)
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    Set the number of cycles.
    
    Specified by:
    
    setCycCount in interface RdGnPiGpioDBlinkMBean
  - getLEDye
```
public Boolean getLEDye()
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    The state of the yellow LED(s).
    
    The yellow LED(s) are inverted only once in a cycle.
    
    Specified by:
    
    getLEDye in interface RdGnPiGpioDBlinkMBean
    
    Returns:
    
    true when ON
  - getLEDgn
```
public Boolean getLEDgn()
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    The state of the green LED(s).
    
    The green LED(s) are inverted twice in a cycle.
    
    Specified by:
    
    getLEDgn in interface RdGnPiGpioDBlinkMBean
    
    Returns:
    
    true when ON
  - getLEDrd
```
public Boolean getLEDrd()
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    The state of the red LED(s).
    
    The red LED(s) are inverted twice in a cycle.
    
    Specified by:
    
    getLEDrd in interface RdGnPiGpioDBlinkMBean
    
    Returns:
    
    true when ON
  - stop
```
public void stop()
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    Stop the cycle loop.
    
    Invoked by JConsole e.g. this ends the otherwise endless loop and the program in a civilised manner. The forcible alternative of stopping the application by cntl-C would be, by the way, by grace of a shut down hook civilised, too.
    
    Specified by:
    
    stop in interface RdGnPiGpioDBlinkMBean
  - getPiType
```
public Integer getPiType()
```
    Description copied from interface: RdGnPiGpioDBlinkMBean
    
    Get the Pi type.
    
    Specified by:
    
    getPiType in interface RdGnPiGpioDBlinkMBean
  - 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 stop().
    
    Run by java RdGnPiGpioDBlink [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 void 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.

Class RdGnPiGpioDBlink

Nested Class Summary

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

Field Summary

Fields inherited from interface de.weAut.PiUtil

Fields inherited from interface de.weAut.PiVals

Fields inherited from interface de.frame4j.util.ComVar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.weAut.PiUtil

Field Detail

ledRDpin

ledYEpin

ledGNpin

out

Constructor Detail

RdGnPiGpioDBlink

Method Detail

getCycCount

setCycCount

getLEDye

getLEDgn

getLEDrd

stop

getPiType

main

doIt