Package org.ka2ddo.yaac.io

Class SerialTNCConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.TNCConnector

org.ka2ddo.yaac.io.SerialTNCConnector

All Implemented Interfaces:

jssc.SerialPortEventListener, TransmittingConnector

public class SerialTNCConnector
extends TNCConnector
implements jssc.SerialPortEventListener, TransmittingConnector

This class implements a port to a TNC connected by a serial port using KISS over asynchronous serial data via RS-232C or USB. Note this can only handle one TNC per serial port; it does not support the multiplexing with port numbers in the high nibble of the KISS command byte, but only expects port#0, although it does support other device numbers in the KISS packets to support the Byonics TinyTrak 4's GPS feed-through multiplexing (which ensures the GPS data doesn't get mixed with the AX.25 packet data).

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.io.PortConnector

PortConnector.PortStatsType

Nested classes/interfaces inherited from class org.ka2ddo.ax25.Connector

Connector.ConnectorType, Connector.PortStats

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<PortConfig.Fields>	BLANK_FIELDS	Set of PortConfig field identifiers for fields that should not be copied from another system and should therefore be blanked out when copying configuration files.
static final String	CONFIG_GUI	The fully-qualified platform-wildcarded class name for the configuration editor for SerialTNCConnector.
static final Map<PortConfig.Fields,PortConfig.RequireHints>	REQ_FIELDS	List of PortConfig field identifiers that are mandated for this port type to work, and the ResourceBundle key to prompt for a value if missing.
static final String	TYPE_NAME	The PortConnector type name for SerialTNCConnector.

Fields inherited from class org.ka2ddo.yaac.io.TNCConnector

RF_SEND_TIME_PER_BYTE_1200, RF_SEND_TIME_PER_BYTE_300, RF_SEND_TIME_PER_BYTE_9600, timeslotTimer

Fields inherited from class org.ka2ddo.yaac.io.PortConnector

currentCfg, portConfig

Fields inherited from class org.ka2ddo.ax25.Connector

CAP_ADSB, CAP_FAST_RF_9600, CAP_FULL_DUPLEX, CAP_GPS_DATA, CAP_HF, CAP_IGATE, CAP_KENWOOD_CMD, CAP_OPENTRAC, CAP_RAW_AX25, CAP_RCV_PACKET_DATA, CAP_RF, CAP_SUBCLIENT, CAP_WAYPOINT_SENDER, CAP_WEATHER, CAP_XMT_PACKET_DATA, stats

Constructor Summary

Constructors

Constructor	Description
SerialTNCConnector()	Create an uninitialized SerialTNCConnector instance, to be configured with a later call to configure().

Method Summary

Modifier and Type	Method	Description
void	close()	Shut down this port connection.
void	configure(PortConfig portConfig)	Update the configuration of the connector to match the updated setup.
static void	fillinConfigDefaults(PortConfig.Cfg cfg)	Set the correct defaults for a port in process of being created.
int	getCapabilities()	Specify what capabilities a port of this type has.
boolean	isOpen()	Reports whether this PortConnector has an open connection to its port.
void	sendFrame(AX25Frame frame)	Transmit an AX.25 frame through this port.
void	serialEvent(jssc.SerialPortEvent event)	Process incoming serial port event.
String	toString()	Returns a string representation of the object.

Methods inherited from class org.ka2ddo.yaac.io.TNCConnector

convertTNC2FormatToAX25Frame, getAcceptableProtocolsMask, getBitRate, getCallsign, getPortAddress, getRFSendTimePerByte, setPortAddress

Methods inherited from class org.ka2ddo.yaac.io.PortConnector

addPortEventListener, createPort, fillinConfigDefaultsForType, fireFailed, fireReceiving, fireTransmitting, getCollectedStatsTypes, getPortConfig, getPortConnectorClass, getPortConnectorInactivityTimer, getStats, portConnectorClasses, portTypeNames, registerPortConnectorType, removePortEventListener, setPortConfig

Methods inherited from class org.ka2ddo.ax25.Connector

addFrameListener, finalize, fireConsumeFrame, fireConsumeFrame, getStats, getType, hasCapability, removeFrameListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ka2ddo.ax25.TransmittingConnector

getAcceptableProtocolsMask, getCallsign, getStats, hasCapability

Field Details

TYPE_NAME

public static final String TYPE_NAME

The PortConnector type name for SerialTNCConnector.

See Also:

• Constant Field Values

CONFIG_GUI

public static final String CONFIG_GUI

The fully-qualified platform-wildcarded class name for the configuration editor for SerialTNCConnector.

See Also:

• Constant Field Values

BLANK_FIELDS

public static final Set<PortConfig.Fields> BLANK_FIELDS

Set of PortConfig field identifiers for fields that should not be copied from another system and should therefore be blanked out when copying configuration files.

REQ_FIELDS

public static final Map<PortConfig.Fields,PortConfig.RequireHints> REQ_FIELDS

List of PortConfig field identifiers that are mandated for this port type to work, and the ResourceBundle key to prompt for a value if missing.

Constructor Details

SerialTNCConnector

public SerialTNCConnector()

Create an uninitialized SerialTNCConnector instance, to be configured with a later call to configure().

See Also:

• configure(PortConfig)

Method Details

fillinConfigDefaults

public static void fillinConfigDefaults(PortConfig.Cfg cfg)

Set the correct defaults for a port in process of being created.

Parameters:

cfg - PortConfig.Cfg whose defaults should be adjusted

configure

public void configure(PortConfig portConfig)
               throws IOException,
IllegalArgumentException

Update the configuration of the connector to match the updated setup.

Specified by:

configure in class PortConnector

Parameters:

portConfig - PortConfig defining new port settings

Throws:

IOException - if interface changes could not be applied

IllegalArgumentException - if type information is invalid for changing the settings of this PortConnector

isOpen

public boolean isOpen()

Reports whether this PortConnector has an open connection to its port.

Specified by:

isOpen in interface TransmittingConnector

Specified by:

isOpen in class Connector

Returns:

boolean true if PortConnector is open

sendFrame

public void sendFrame(AX25Frame frame)
               throws IOException

Transmit an AX.25 frame through this port. May delay packet if using timeslotting or still transmitting another packet.

Specified by:

sendFrame in interface TransmittingConnector

Parameters:

frame - AX25Frame object to transmit

Throws:

IOException - if transmit failed for any reason other than a receive-only port

serialEvent

public void serialEvent(jssc.SerialPortEvent event)

Process incoming serial port event.

Specified by:

serialEvent in interface jssc.SerialPortEventListener

Parameters:

event - SerialPortEvent describing the handling needed

close

public void close()

Shut down this port connection.

Overrides:

close in class Connector

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object.

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Specified by:

getCapabilities in interface TransmittingConnector

Overrides:

getCapabilities in class Connector

Returns:

bitmask of capability flags

See Also:

• Connector.CAP_RCV_PACKET_DATA
• Connector.CAP_XMT_PACKET_DATA
• Connector.CAP_FAST_RF_9600
• Connector.CAP_FULL_DUPLEX
• Connector.CAP_GPS_DATA
• Connector.CAP_HF
• Connector.CAP_IGATE
• Connector.CAP_KENWOOD_CMD
• Connector.CAP_OPENTRAC
• Connector.CAP_ADSB
• Connector.CAP_RAW_AX25
• Connector.CAP_RF
• Connector.CAP_WAYPOINT_SENDER
• Connector.CAP_WEATHER
• Connector.CAP_SUBCLIENT