com.cloudpos.antenna

Interface AntennaDevice

All Superinterfaces:

Device

public interface AntennaDevice
extends Device

The AntennaDevice interface defines the APIs for controlling Antenna devices in applications. Implementations providing Antenna services must supply a concrete class implementing this interface.

To obtain a Antenna device object from the POSTerminal, use the following code:

 AntennaDevice antennaDevice =
         (AntennaDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.antenna");
 

The identifier "com.cloudpos.device.antenna" is used to specify the Antenna device, as defined by the specific implementation.

Applications can control the antenna device using this interface and must request the necessary permissions:

<uses-permission android:name="android.permission.CLOUDPOS_MCUCTL"/>

See Also:

Device

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AntennaDevice.AntennaMode Defines the operational modes of the antenna.

Method Summary

Modifier and Type	Method and Description
AntennaDevice.AntennaMode	getAntennaMode() Retrieves the currently active antenna mode.
void	setAntennaMode(AntennaDevice.AntennaMode antennaMode) Switch to internal antenna or external antenna

Methods inherited from interface com.cloudpos.Device

cancelRequest, close, getFailCount, getUsageCount, open

Method Detail

getAntennaMode

AntennaDevice.AntennaMode getAntennaMode()
                                  throws DeviceException

Retrieves the currently active antenna mode.

Returns:

Current antenna mode, either AntennaDevice.AntennaMode.INTERNAL or AntennaDevice.AntennaMode.EXTERNAL.

Throws:

DeviceException - for standard errors as documented in DeviceException.

setAntennaMode

void setAntennaMode(AntennaDevice.AntennaMode antennaMode)
             throws DeviceException

Switch to internal antenna or external antenna

Parameters:

antennaMode - Target mode, either AntennaDevice.AntennaMode.INTERNAL or AntennaDevice.AntennaMode.EXTERNAL

Throws:

DeviceException - for standard errors as documented in DeviceException.