Package jmri.jmrix.ieee802154.serialdriver

Class SerialDriverAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractSerialPortController

jmri.jmrix.ieee802154.IEEE802154PortController

jmri.jmrix.ieee802154.serialdriver.SerialDriverAdapter

All Implemented Interfaces:

PortAdapter, SerialPortAdapter

Direct Known Subclasses:

XBeeAdapter

public class SerialDriverAdapter
extends IEEE802154PortController

Provide access to IEEE802.15.4 devices via a serial com port. Derived from the Oaktree code.

Nested Class Summary

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

AbstractSerialPortController.Blocking, AbstractSerialPortController.FlowControl

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

AbstractPortController.Option

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String[]	stdOption1Values

Fields inherited from class jmri.jmrix.AbstractSerialPortController

currentSerialPort, mBaudRate, mPort

Fields inherited from class jmri.jmrix.AbstractPortController

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	SerialDriverAdapter()
protected	SerialDriverAdapter(IEEE802154SystemConnectionMemo connectionMemo)

Method Summary

Modifier and Type	Method	Description
void	configure()	Set up all of the other objects to operate connected to this port.
int	defaultBaudIndex()	Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.
boolean	okToSend()	Can the port accept additional characters?
String	openPort(String portName, String appName)	Open a specified port.
String	option1Name()	Get a String that says what Option 1 represents.
String	option2Name()	Get a String that says what Option 2 represents.
protected void	setSerialPort()	Local method to do specific port configuration.
boolean	status()	Query the status of this connection.
int[]	validBaudNumbers()	Get an array of valid baud rate numbers; used to store/load adapter speed option.
String[]	validBaudRates()	Get an array of valid baud rate strings; used to display valid options in Connections Preferences.
String[]	validOption1()
String[]	validOption2()	Get an array of valid values for "option 2"; used to display valid options.

Methods inherited from class jmri.jmrix.ieee802154.IEEE802154PortController

getSystemConnectionMemo

Methods inherited from class jmri.jmrix.AbstractSerialPortController

activatePort, activatePort, activatePort, closeConnection, closeSerialPort, configureBaudRate, configureBaudRateFromIndex, configureBaudRateFromNumber, configureLeads, configureLeadsAndFlowControl, configureLeadsAndFlowControl, connect, currentBaudNumber, getActualPortNames, getCurrentBaudIndex, getCurrentBaudNumber, getCurrentBaudRate, getCurrentPortName, getFlowControl, getInputStream, getOutputStream, getPortSettingsString, handlePortBusy, handlePortNotFound, handlePortNotFound, isPortOpen, replacePortWithFakePort, reportPortStatus, resetupConnection, setBaudRate, setComPortTimeouts, setDataListener, setFlowControl, setPort

Methods inherited from class jmri.jmrix.AbstractPortController

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.PortAdapter

dispose, getDisabled, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from interface jmri.jmrix.SerialPortAdapter

configureOption1, configureOption2, configureOption3, configureOption4, getManufacturer, getPortNames, setManufacturer

Field Details

stdOption1Values

String[] stdOption1Values

Constructor Details

SerialDriverAdapter

public SerialDriverAdapter()

SerialDriverAdapter

protected SerialDriverAdapter(IEEE802154SystemConnectionMemo connectionMemo)

Method Details

openPort

public String openPort(String portName,
 String appName)

Description copied from interface: SerialPortAdapter

Open a specified port.

Parameters:

portName - name tu use for this port

appName - provided to the underlying OS during startup so that it can show on status displays, etc.

Returns:

null indicates OK return, else error message.

okToSend

public boolean okToSend()

Can the port accept additional characters? Yes, always

Returns:

always true

configure

public void configure()

Set up all of the other objects to operate connected to this port.

status

public boolean status()

Description copied from class: AbstractPortController

Query the status of this connection. This is a question of configuration, not transient hardware status.

Specified by:

status in interface PortAdapter

Specified by:

status in interface SerialPortAdapter

Specified by:

status in class IEEE802154PortController

Returns:

true if OK, at least as far as known

setSerialPort

protected void setSerialPort()

Local method to do specific port configuration.

validBaudRates

public String[] validBaudRates()

Get an array of valid baud rate strings; used to display valid options in Connections Preferences.

Specified by:

validBaudRates in interface SerialPortAdapter

Overrides:

validBaudRates in class AbstractSerialPortController

Returns:

array of I18N display strings of port speed settings valid for this serial adapter, must match order and values from SerialPortAdapter.validBaudNumbers()

validBaudNumbers

public int[] validBaudNumbers()

Get an array of valid baud rate numbers; used to store/load adapter speed option.

Specified by:

validBaudNumbers in interface SerialPortAdapter

Overrides:

validBaudNumbers in class AbstractSerialPortController

Returns:

integer array of speeds, must match order and values from SerialPortAdapter.validBaudRates()

validOption1

public String[] validOption1()

option1Name

public String option1Name()

Get a String that says what Option 1 represents.

Returns:

fixed string 'Adapter'

defaultBaudIndex

public int defaultBaudIndex()

Description copied from interface: SerialPortAdapter

Get the index of the default port speed for this adapter from the validSpeeds and validRates arrays.

Specified by:

defaultBaudIndex in interface SerialPortAdapter

Overrides:

defaultBaudIndex in class AbstractSerialPortController

Returns:

-1 to indicate not supported, unless overridden in adapter

validOption2

public String[] validOption2()

Get an array of valid values for "option 2"; used to display valid options. May not be null, but may have zero entries.

Returns:

empty string array

option2Name

public String option2Name()

Get a String that says what Option 2 represents. May be an empty string, but will not be null.

Returns:

empty string