Package org.ka2ddo.yaac.io

Class KenwoodConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.TNCConnector

org.ka2ddo.yaac.io.KenwoodConnector

All Implemented Interfaces:

jssc.SerialPortEventListener

public class KenwoodConnector
extends TNCConnector
implements jssc.SerialPortEventListener

This class defines a connector for communicating with a Kenwood TM-D710 (or equivalent) radio through its COM port when the radio is in APRS (not packet TNC) mode. In this mode, GPS and APRS messages are sent to the COM port as alternating (mostly) ASCII text lines.

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

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
KenwoodConnector()	Create an uninitialized instance of KenwoodConnector.

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.
String	queryRadio(String command)	Send a Kenwood command string to the radio and expect a reply.
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 KenwoodConnector.

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

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

KenwoodConnector

public KenwoodConnector()

Create an uninitialized instance of KenwoodConnector.

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

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

queryRadio

public String queryRadio(String command)
                  throws IOException

Send a Kenwood command string to the radio and expect a reply.

Parameters:

command - String of command to send

Returns:

answer String, or null if we never got an answer

Throws:

IOException - if write to serial port failed

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.

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