Package jmri.jmrix.pi

Class RaspberryPiAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.pi.RaspberryPiAdapter

All Implemented Interfaces:

PortAdapter

public class RaspberryPiAdapter
extends AbstractPortController

Provides an Adapter to allow the system connection memo and multiple RaspberryPi managers to be handled.

Uses Pi4J 3.x on real Raspberry Pi hardware, or the JMRI-internal GpioSimulator in simulator mode. Pin addresses are BCM (Broadcom) numbers; e.g. "PS4" → BCM GPIO 4.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractPortController

AbstractPortController.Option

Field Summary

Fields inherited from class jmri.jmrix.AbstractPortController

allowConnectionRecovery, manufacturerName, opened, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval

Constructor Summary

Constructors

Constructor	Description
RaspberryPiAdapter()	No-arg constructor.
RaspberryPiAdapter(boolean isSimulator)

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure all of the other jmrix widgets needed to work with this adapter.
void	connect()	Open the connection.
void	dispose()	Clean up before removal.
String	getCurrentPortName()
DataInputStream	getInputStream()	Get the InputStream from the port.
DataOutputStream	getOutputStream()	Get the outputStream to the port.
com.pi4j.context.Context	getPi4JContext()	Get the Pi4J context associated with this adapter.
(package private) static com.pi4j.context.Context	getSharedContext()	Return the shared Pi4J context, creating it lazily if needed.
RaspberryPiSystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo associated with this object.
static boolean	isSimulator()
void	recover()	This is called when a connection is initially lost.
(package private) static void	setIsSimulator(boolean isSimulator)	Package-private setter so tests in jmri.jmrix.pi can enable simulator mode before constructing sensors or turnouts.

Methods inherited from class jmri.jmrix.AbstractPortController

closeConnection, configureOption1, configureOption2, configureOption3, configureOption4, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, reconnectFromLoop, resetupConnection, safeSleep, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName, status

Methods inherited from class java.lang.Object

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

Constructor Details

RaspberryPiAdapter

public RaspberryPiAdapter()

No-arg constructor. Inherits the current value of the static simulator flag so that tests which call setIsSimulator(boolean) before construction will automatically get a simulator-mode adapter.

RaspberryPiAdapter

public RaspberryPiAdapter(boolean isSimulator)

Method Details

isSimulator

public static boolean isSimulator()

setIsSimulator

static void setIsSimulator(boolean isSimulator)

Package-private setter so tests in jmri.jmrix.pi can enable simulator mode before constructing sensors or turnouts.

getSharedContext

@CheckForNull
static com.pi4j.context.Context getSharedContext()

Return the shared Pi4J context, creating it lazily if needed. Returns null in simulator mode or when Pi4J cannot be initialised (e.g. not running on Raspberry Pi hardware, or the pi4j-core jar is absent from the runtime classpath).

Returns:

the Pi4J context, or null

getCurrentPortName

public String getCurrentPortName()

Specified by:

getCurrentPortName in interface PortAdapter

Specified by:

getCurrentPortName in class AbstractPortController

dispose

public void dispose()

Description copied from class: AbstractPortController

Clean up before removal. Overriding methods must call super.dispose() or document why they are not calling the overridden implementation. In most cases, failure to call the overridden implementation will cause user-visible error.

Specified by:

dispose in interface PortAdapter

Overrides:

dispose in class AbstractPortController

connect

public void connect()

Description copied from interface: PortAdapter

Open the connection.

configure

public void configure()

Description copied from interface: PortAdapter

Configure all of the other jmrix widgets needed to work with this adapter.

getInputStream

public DataInputStream getInputStream()

Description copied from class: AbstractPortController

Get the InputStream from the port.

Specified by:

getInputStream in interface PortAdapter

Specified by:

getInputStream in class AbstractPortController

Returns:

the InputStream from the port

getOutputStream

public DataOutputStream getOutputStream()

Description copied from class: AbstractPortController

Get the outputStream to the port.

Specified by:

getOutputStream in interface PortAdapter

Specified by:

getOutputStream in class AbstractPortController

Returns:

the outputStream to the port

getSystemConnectionMemo

public RaspberryPiSystemConnectionMemo getSystemConnectionMemo()

Description copied from class: AbstractPortController

Get the SystemConnectionMemo associated with this object.

This method should only be overridden to ensure that a specific subclass of SystemConnectionMemo is returned. The recommended pattern is: public MySystemConnectionMemo getSystemConnectionMemo() { return (MySystemConnectionMemo) super.getSystemConnectionMemo(); }

Specified by:

getSystemConnectionMemo in interface PortAdapter

Overrides:

getSystemConnectionMemo in class AbstractPortController

Returns:

the currently associated SystemConnectionMemo

recover

public void recover()

Description copied from class: AbstractPortController

This is called when a connection is initially lost. After checking the allowConnectionRecovery flag, closes the connection, resets the open flag and attempts a reconnection.

Specified by:

recover in interface PortAdapter

Overrides:

recover in class AbstractPortController

getPi4JContext

@CheckForNull
public com.pi4j.context.Context getPi4JContext()

Get the Pi4J context associated with this adapter. Returns null in simulator mode or when not running on a Pi.

Returns:

the Pi4J Context, or null