org.ka2ddo.yaac.io

Class SerialGpsConnector

java.lang.Object

org.ka2ddo.ax25.Connector

org.ka2ddo.yaac.io.PortConnector

org.ka2ddo.yaac.io.AbstractGpsConnector

org.ka2ddo.yaac.io.SerialGpsConnector

All Implemented Interfaces:

java.lang.Thread.UncaughtExceptionHandler, jssc.SerialPortEventListener, AprsMessageListener, ParsedAX25MessageListener

public class SerialGpsConnector
extends AbstractGpsConnector
implements jssc.SerialPortEventListener

This class implements a port to a GPS receiver connected by a serial port over RS-232C (or USB emulating a RS-232C serial port). It optionally can send waypoint sentences back to the GPS (similar to the Kenwood D710 and TH-D72 working with AvMap GPS's) that are derived from the various formats of APRS and OpenTRAC position messages.

Note: For backwards compatibility, we are treating the FLAGS_LOCAL bit inversely (if clear, is a local GPS; if set, is a remote GPS).

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 and Description
static java.util.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 java.lang.String	CONFIG_GUI The fully-qualified platform-wildcarded class name for the configuration editor for SerialGpsConnector.
static java.util.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 java.lang.String	TYPE_NAME The configuration type name for Serial_GPS ports.

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

dispatchThread, gpsDistributor, QUEUE_READER, queuedButNotConsumed, rtQueue

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_OTHER_TRANSPORT, 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 and Description
SerialGpsConnector()

Method Summary

Modifier and Type	Method and 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	getBitRate() Get the bit transmission rate on this port.
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.
java.lang.String	toString() Returns a string representation of the object.
void	write(java.lang.String line) Transmit a line of text containing a waypoint sentence to the GPS device.

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

aprsMessageReceived, parsedAX25MessageReceived, startQueueReader, stopQueueReader, uncaughtException

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, getCallsign, getStats, getType, hasCapability, removeFrameListener

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

The configuration type name for Serial_GPS ports.

See Also:

Constant Field Values

CONFIG_GUI

public static final java.lang.String CONFIG_GUI

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

See Also:

Constant Field Values

BLANK_FIELDS

public static final java.util.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 java.util.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 Detail

SerialGpsConnector

public SerialGpsConnector()

Method Detail

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 java.io.IOException,
                      java.lang.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:

java.io.IOException - if interface changes could not be applied

java.lang.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

getBitRate

public int getBitRate()

Get the bit transmission rate on this port.

Overrides:

getBitRate in class PortConnector

Returns:

bit rate in bits per second (baud)

getCapabilities

public int getCapabilities()

Specify what capabilities a port of this type has.

Overrides:

getCapabilities in class AbstractGpsConnector

Returns:

bitmask of capability flags

See Also:

Connector.CAP_GPS_DATA, Connector.CAP_WAYPOINT_SENDER

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

write

public void write(java.lang.String line)

Transmit a line of text containing a waypoint sentence to the GPS device.

Specified by:

write in class AbstractGpsConnector

Parameters:

line - String text to transmit

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.