com.cloudpos.led

Interface LEDGroupDevice

All Superinterfaces:

Device

public interface LEDGroupDevice
extends Device

The LEDGroupDevice interface defines the API for interacting with LED devices. This interface allows applications to control and manipulate the operation of LED hardware.

To obtain an instance of LEDGroupDevice, use the following code:

 LEDGroupDevice ledGroupDevice = (LEDGroupDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.ledgroup");
 

Here, "com.cloudpos.device.ledgroup" is a string identifier for the LED device, as defined by the specific implementation.

Applications must request permission to access this device as shown:

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

See Also:

Device

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_OFF Light off
static int	STATUS_ON Light on

Method Summary

Modifier and Type	Method and Description
void	cancelBlink(int logicalID) Cancels the ongoing blinking operation of the LED with the specified logical ID.
int	getStatus(int logicalID) Retrieves the current status of the LED with the specified logical ID.
void	startBlink(int logicalID, long delayTurnOn, long delayTurnOff) Initiates a continuous blinking pattern for the LED with the specified logical ID.
void	startBlink(int logicalID, long delayTurnOn, long delayTurnOff, int counts) Initiates a continuous blinking pattern for the LED with the specified logical ID.
void	turnOff(int logicalID) Turns off the LED with the specified logical ID.
void	turnOn(int logicalID) Turns on the LED with the specified logical ID.

Methods inherited from interface com.cloudpos.Device

cancelRequest, close, getFailCount, getUsageCount, open

Field Detail

STATUS_OFF

static final int STATUS_OFF

Light off

See Also:

Constant Field Values

STATUS_ON

static final int STATUS_ON

Light on

See Also:

Constant Field Values

Method Detail

cancelBlink

void cancelBlink(int logicalID)
          throws DeviceException

Cancels the ongoing blinking operation of the LED with the specified logical ID.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

getStatus

int getStatus(int logicalID)
       throws DeviceException

Retrieves the current status of the LED with the specified logical ID.

Returns:

The status of the LED, either STATUS_OFF or STATUS_ON.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

startBlink

void startBlink(int logicalID,
                long delayTurnOn,
                long delayTurnOff)
         throws DeviceException

Initiates a continuous blinking pattern for the LED with the specified logical ID. Blinking starts with the LED turned on. This method is asynchronous; the device must be capable of responding to cancelBlink(int) to abort blinking.

Parameters:

logicalID - the LED logicalID

delayTurnOn - Time in milliseconds for the LED to remain on during each blink.

delayTurnOff - Time in milliseconds for the LED to remain off between blinks.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

startBlink

void startBlink(int logicalID,
                long delayTurnOn,
                long delayTurnOff,
                int counts)
         throws DeviceException

Initiates a continuous blinking pattern for the LED with the specified logical ID. Blinking starts with the LED turned on. This method is asynchronous; the device must be capable of responding to cancelBlink(int) to abort blinking.

Parameters:

logicalID - the LED logicalID

delayTurnOn - Time in milliseconds for the LED to remain on during each blink.

delayTurnOff - Time in milliseconds for the LED to remain off between blinks.

counts - Number of blinking cycles to perform.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

turnOff

void turnOff(int logicalID)
      throws DeviceException

Turns off the LED with the specified logical ID.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

turnOn

void turnOn(int logicalID)
     throws DeviceException

Turns on the LED with the specified logical ID.

Throws:

DeviceException - for standard reasons as documented in DeviceException.