com.cloudpos.usb

Interface USBExtSwitchDevice

All Superinterfaces:

Device

public interface USBExtSwitchDevice
extends Device

The USBExtSwitchDevice interface provides control over the power state of USB host ports.

This interface allows applications to manage the power on/off state of USB hosts. The USBExtSwitchDevice object is obtained from the POSTerminal:

 USBExtSwitchDevice USBExtSwitchDevice =
         (USBExtSwitchDevice) POSTerminal.getInstance().getDevice(POSTerminal.DEVICE_NAME_USBEXTSWITCHDEVICE);
 

The identifier USBExtSwitchDevice is used to specify the device, as defined by the implementation.

Applications require the following permission to access the device:

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

The USB host ports can be configured in various modes, affecting how USB1 and USB2 operate:

USB1	USB2	Work Mode
disable	disable	USB1 works only in SLAVE mode, USB2 does not work.
enable	disable	USB1 works in Host or SLAVE mode, USB2 does not work.
enable	enable	Both USB1 and USB2 work only in Host mode.
disable	enable	USB1 does not work, USB2 works only in Host mode.

Note: By default, if no API is called, the firmware will enable USB1 and disable USB2.

Method Summary

Modifier and Type	Method and Description
void	disablePower(int usbID) Powers off the specified USB host.
void	enablePower(int usbID) Powers on the specified USB host.
boolean	isPowerEnabled(int usbID) Checks whether the specified USB host is powered on.

Methods inherited from interface com.cloudpos.Device

cancelRequest, close, getFailCount, getUsageCount, open

Method Detail

enablePower

void enablePower(int usbID)
          throws DeviceException

Powers on the specified USB host.

Parameters:

usbID - The index of the USB host to power on.

Throws:

DeviceException - for standard errors as documented in DeviceException.

disablePower

void disablePower(int usbID)
           throws DeviceException

Powers off the specified USB host.

Parameters:

usbID - The index of the USB host to power off.

Throws:

DeviceException - for standard errors as documented in DeviceException.

isPowerEnabled

boolean isPowerEnabled(int usbID)
                throws DeviceException

Checks whether the specified USB host is powered on.

Parameters:

usbID - The index of the USB host.

Returns:

true if the specified USB host is powered on, false otherwise.

Throws:

DeviceException - for standard errors as documented in DeviceException.