org.ka2ddo.yaac.io

Interface TuneIfc

public interface TuneIfc

This interface allows a plugin to provide an API to tune a radio based on a repeater frequency PositionMessage, so a TUNE button on the KenwoodRadioViewPane can actually work without having to call up the plugin view.

Since:

PROVIDER_API_VERSION == 36

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TuneIfc.TuneResult These enum values report the results of calling the tuneForRepeater(AX25Message) method.

Method Summary

Modifier and Type	Method and Description
boolean	isMsgForRepeater(AX25Message msg) Report if an AX.25 message contains information describing a repeater station.
boolean	isRadioDual() Report whether the connected radio is capable of receiving two different frequencies at the same time, ex.: Kenwood TM-D710.
boolean	isRadioTunable() Test if this interface provides a tuneable radio.
TuneIfc.TuneResult	restoreOldFrequency() Tune the single-receiver radio back to the APRS frequency.
TuneIfc.TuneResult	tuneForRepeater(AX25Message msg) Tune the associated radio to work with the repeater specified by the message.

Method Detail

isRadioTunable

boolean isRadioTunable()

Test if this interface provides a tuneable radio.

Returns:

boolean true if radio can be tuned

isRadioDual

boolean isRadioDual()

Report whether the connected radio is capable of receiving two different frequencies at the same time, ex.: Kenwood TM-D710. Note that if a single-frequency radio is being used for APRS and repeaters, the APRS beacons should be turned off when switching to the alternate frequency.

Returns:

boolean true if radio supports dual receivers, false if not

isMsgForRepeater

boolean isMsgForRepeater(AX25Message msg)

Report if an AX.25 message contains information describing a repeater station.

Parameters:

msg - AX25Message to analyze

Returns:

boolean true if the message describes a repeater

tuneForRepeater

TuneIfc.TuneResult tuneForRepeater(AX25Message msg)

Tune the associated radio to work with the repeater specified by the message.

Parameters:

msg - AX25Message to analyze

Returns:

the status of the tune attempt

restoreOldFrequency

TuneIfc.TuneResult restoreOldFrequency()

Tune the single-receiver radio back to the APRS frequency.

Returns:

TuneResult indicating how the radio tuned back to APRS