Package org.ka2ddo.yaac.io

Class YaesuConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.TNCConnector

org.ka2ddo.yaac.io.YaesuConnector

All Implemented Interfaces:

jssc.SerialPortEventListener

public class YaesuConnector
extends TNCConnector
implements jssc.SerialPortEventListener

This class implements a receive-only port for listening to the non-standard command-mode style APRS packet output of the Yaesu FTM-400DR and related radios, and to Kantronics TNCs in command mode.

The expected packet format is in two lines. Line 1 contains the AX.25 frame header information in the format:

src>dest,digi [MM/dd/yy HH:mm:ss] <UI>:

where the ",digi" part is optional (if the packet wasn't specified for digipeating). The Kantronics variation is the format:

src>dest,digi: <UI>:

where no date is provided, and an extra colon character is immediately after the last digipeater (much like the APRS-IS/TNC2 format, if there wasn't an encoding of the frame type and a line break stuck in between the header and the body).

The second line is the body of the packet in plain text (should be ASCII, but this class supports UTF-8 just in case). For APRS packets, this should just be a printable packet.

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 YaesuConnector.
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 YaesuConnector.

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
YaesuConnector()

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	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

Field Details

TYPE_NAME

public static final String TYPE_NAME

The PortConnector type name for YaesuConnector.

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 YaesuConnector.

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

YaesuConnector

public YaesuConnector()

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 class Connector

Returns:

boolean true if PortConnector is open

close

public void close()

Shut down this port connection. Expected to be overridden by sub-classes.

Overrides:

close in class Connector

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Overrides:

getCapabilities in class Connector

Returns:

bitmask of capability flags

See Also:

• Connector.CAP_RCV_PACKET_DATA
• Connector.CAP_XMT_PACKET_DATA
• Connector.CAP_FULL_DUPLEX
• Connector.CAP_GPS_DATA
• Connector.CAP_HF
• Connector.CAP_IGATE
• Connector.CAP_OPENTRAC
• Connector.CAP_RF
• Connector.CAP_WAYPOINT_SENDER
• Connector.CAP_WEATHER

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

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object.