de.weAut

Interface TestOnPiMBean

All Superinterfaces:

AppMBean

All Known Implementing Classes:

TestOnPi

public interface TestOnPiMBean
extends AppMBean

IO/device on Pi test and demo program TestOnPi as MBean.

Copyright © 2021 Albrecht Weinert

Version:

56 (28.06.2021)

See Also:

TestOnPi, PiUtil, BlinkOnPi, TestOnPi.properties, Raspi4testPins

Method Summary

Modifier and Type	Method and Description
void	blink() Blink the LEDs.
Integer	getCycCount() The number of cycles.
Integer	getCycLim() The limit for the number of cycles.
Integer	getCycOvr() Get the number of spoiled delays.
String	getInPort() Get the port for input actions.
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).
String	getOutPort() Get the output for (non LED) actions.
String	getOutput() The state of the output.
Integer	getPiType() Get the Pi type.
Integer	getStepDelay() Get delay / ms between two operations.
Integer	getStepVal() Get step between two PMW or servo values.
Integer	getVal() Get PMW or servo current value.
Integer	getValLo() Get PMW or servo value lower limit.
Integer	getValUp() Get PMW or servo value upper limit.
Boolean	input() Just input.
Boolean	inToInvOut() Input and set the output with the inverted result.
void	setCycCount(Integer cycCount) Set the number of cycles.
void	setCycLim(Integer cycLim) Set the limit for number of cycles.
void	setInPort(String inPort) Set the port for input actions.
void	setOutPort(String outPort) Set the output for (non LED) actions.
void	setOutput(String out) Set the output.
void	setStepDelay(Integer delay) Set delay / ms between two operations.
void	setStepVal(Integer step) Set step between two PMW or servo values.
void	setVal(Integer val) Set PMW or servo current value.
void	setValLo(Integer valLo) Set PMW or servo value lower limit.
void	setValUp(Integer valUp) Set PMW or servo value upper limit.
void	stopTask() Stop the task.
void	wink() Servo wink respectively PWM up/down.
void	winkPWM() PWM continuously up and down over almost full range.
void	winkServo() Wink servo over almost full range.

Methods inherited from interface de.frame4j.util.AppMBean

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

Method Detail

getLEDye

Boolean getLEDye()

The state of the yellow LED(s).

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

Returns:

true when ON

getLEDrd

Boolean getLEDrd()

The state of the red LED(s).

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

Returns:

true when ON

getLEDgn

Boolean getLEDgn()

The state of the green LED(s).

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

Returns:

true when ON

getCycCount

Integer getCycCount()

The number of cycles.

As the duration of one cycle is typically 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. Note 2: Here for greater values, the required (ill) return type Integer would abandon the cache guarantee for small values. Requesting this value regularly would lead to heavy object creation and garbage collection detrimental to real time applications. Hence, this method might be deprecated or removed in future.

Returns:

the loop / cycle or delay count

See Also:

setCycCount(Integer), getCycOvr()

setCycCount

void setCycCount(Integer cycCount)

Set the number of cycles.

getCycLim

Integer getCycLim()

The limit for the number of cycles.

When this limit is hit when incrementing the number of cycles the current task will be stopped. The next task will be started (with setCycCount(0), if any, or the application will stop.

Returns:

the limit for the loop or cyclecount

See Also:

setCycLim(Integer), getCycCount()

setCycLim

void setCycLim(Integer cycLim)

Set the limit for number of cycles.

This method sets the limit for number of cycles by the parameter cycLim and, also, resets the number of cycles to 0.

Parameters:

cycLim - the limit; 0 effectively means endless

getCycOvr

Integer getCycOvr()

Get the number of spoiled delays.

Returns:

the number of spoiled thread delays

See Also:

PiUtil.thrDelay(int), getCycCount()

getPiType

Integer getPiType()

Get the Pi type.

setOutPort

void setOutPort(String outPort)

Set the output for (non LED) actions.

This method sets the output port either as pin number or as GPIO with a prefix G.
An optional postfix U, D or N will set the pull resistor as up, down or none. Without postfix the pull resistor setting will be kept untouched.

Parameters:

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

See Also:

getOutPort(), getInPort(), setInPort(String)

getOutPort

String getOutPort()

Get the output for (non LED) actions.

If all informations are available the text will show pin number, pull resistor setting and GPIO; example: "07UG04".
The numbers will always be given as two digit decimal. The format will be understood (parsed) by setOutPort(String); for the example setOutPort("7U") would be sufficient.

See Also:

setOutPort(String), getInPort(), setInPort(String)

setInPort

void setInPort(String inPort)

Set the port for input actions.

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

Parameters:

inPort - input pin (7, e.g.) or gpio (with leading G; G4U, e.g.)

See Also:

getInPort(), setOutPort(String), getOutPort()

getInPort

String getInPort()

Get the port for input actions.

See Also:

setInPort(String), setOutPort(String), getOutPort()

setStepDelay

void setStepDelay(Integer delay)

Set delay / ms between two operations.

Parameters:

delay - 2 .. 29999 ms; default 10 ms

getStepDelay

Integer getStepDelay()

Get delay / ms between two operations.

Returns:

the actual value

setStepVal

void setStepVal(Integer step)

Set step between two PMW or servo values.

Parameters:

step - the value will be adjusted at use if not fitting

getStepVal

Integer getStepVal()

Get step between two PMW or servo values.

Returns:

the actual value; default 10

setVal

void setVal(Integer val)

Set PMW or servo current value.

Parameters:

val - the value will be adjusted at use if not fitting

getVal

Integer getVal()

Get PMW or servo current value.

Returns:

the actual value; default 100

setValUp

void setValUp(Integer valUp)

Set PMW or servo value upper limit.

Parameters:

valUp - the limit will be adjusted at use if not fitting

getValUp

Integer getValUp()

Get PMW or servo value upper limit.

Returns:

the actual value; default 255

setValLo

void setValLo(Integer valLo)

Set PMW or servo value lower limit.

Parameters:

valLo - the limit will be adjusted at use if not fitting

getValLo

Integer getValLo()

Get PMW or servo value lower limit.

Returns:

the actual value; default 0

blink

void blink()

Blink the LEDs.

wink

void wink()

Servo wink respectively PWM up/down.

The choice of action (servo or PWM) depends on the start and other values set.

winkServo

void winkServo()

Wink servo over almost full range.

winkPWM

void winkPWM()

PWM continuously up and down over almost full range.

setOutput

void setOutput(String out)

Set the output.

This method will interpret the String out as does ClientPigpiod.setOutput(gpio, out) usually by implementing it so.

Parameters:

out - the output value

See Also:

ClientPigpiod.setOutput(int, String)

inToInvOut

Boolean inToInvOut()

Input and set the output with the inverted result.

If no input port is defined this method does nothing and returns FALSE. If an operable output port is defined (also) the inverted input value will be output to it.

Returns:

the state of the input port

See Also:

input(), setOutput(String)

input

Boolean input()

Just input.

If no input port is defined this method does nothing and returns FALSE. Otherwise the input is read and if that returns 1/Hi TRUE will be returned.
Note, that a returned false is a bit ambiguous. Besides signal Lo it might mean no input port defined or error while reading.

Returns:

the state of the input port

See Also:

inToInvOut()

getOutput

String getOutput()

The state of the output.

This method returns the last state, i.e. setting by setOutput(out), of the output. This method returns the binary on/off state as well as the numerical PMW or servo state as text.

stopTask

void stopTask()

Stop the task.

This method will stop a periodic task (like blink() or wink() etc.) if any is running. This will start the next task pending. Otherwise it will act like App.stop().