com.cloudpos.led

Interface LEDDevice

All Superinterfaces:

Device

public interface LEDDevice
extends Device

The LEDDevice 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 LEDDevice, use the following code:

 LEDDevice ledDevice = (LEDDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.led");
 

Here, "com.cloudpos.device.led" 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	ID_BLUE
static int	ID_GREEN
static int	ID_RED
static int	ID_YELLOW
static int	STATUS_OFF Light off
static int	STATUS_ON Light on

Method Summary

Modifier and Type	Method and Description
void	blink(byte color, long delayTurnOn, long delayTurnOff, int counts) Causes the LED to blink a specified number of times with specified durations for ON and OFF states and a specific color.
void	blink(long delayTurnOn, long delayTurnOff, int counts) Causes the LED to blink a specified number of times with specified durations for ON and OFF states.
void	cancelBlink() Cancels any ongoing LED blinking operation.
int	getLogicalID() Retrieves the current logical ID of the LED in use.
int	getStatus() Retrieves the current status of the LED.
void	open(int logicalID) Opens the specified LED for control.
void	startBlink(byte color, long delayTurnOn, long delayTurnOff, int counts) Initiates a continuous blinking pattern for the LED with a specified color.
void	startBlink(long delayTurnOn, long delayTurnOff) Initiates a continuous blinking pattern for the LED.
void	startBlink(long delayTurnOn, long delayTurnOff, int counts) Initiates a continuous blinking pattern for the LED.
void	turnOff() Turns the LED off.
void	turnOn() Turns the LED on.

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

ID_BLUE

static final int ID_BLUE

See Also:

Constant Field Values

ID_YELLOW

static final int ID_YELLOW

See Also:

Constant Field Values

ID_GREEN

static final int ID_GREEN

See Also:

Constant Field Values

ID_RED

static final int ID_RED

See Also:

Constant Field Values

Method Detail

open

void open(int logicalID)
   throws DeviceException

Opens the specified LED for control.

Parameters:

logicalID - The logical ID of the LED to open (ID_BLUE or ID_YELLOW or ID_GREEN or ID_RED).

Throws:

DeviceException - for standard reasons as documented in DeviceException.

getLogicalID

int getLogicalID()
          throws DeviceException

Retrieves the current logical ID of the LED in use.

Returns:

The logical ID of the LED. Returns -1 if no LED is currently open.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

startBlink

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

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

Parameters:

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.

startBlink

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

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

Parameters:

color - The color of the LED.

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.

startBlink

void startBlink(long delayTurnOn,
                long delayTurnOff)
         throws DeviceException

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

Parameters:

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.

cancelBlink

void cancelBlink()
          throws DeviceException

Cancels any ongoing LED blinking operation.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

blink

void blink(long delayTurnOn,
           long delayTurnOff,
           int counts)
    throws DeviceException

Causes the LED to blink a specified number of times with specified durations for ON and OFF states. This method is synchronous and cannot be cancelled.

Parameters:

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.

blink

void blink(byte color,
           long delayTurnOn,
           long delayTurnOff,
           int counts)
    throws DeviceException

Causes the LED to blink a specified number of times with specified durations for ON and OFF states and a specific color. This method is synchronous and cannot be cancelled.

Parameters:

color - The color of the LED.

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.

getStatus

int getStatus()
       throws DeviceException

Retrieves the current status of the LED.

Returns:

The status of the LED, either STATUS_OFF or STATUS_ON.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

turnOn

void turnOn()
     throws DeviceException

Turns the LED on. The LED remains on until turnOff() or Device.close() is called.

Throws:

DeviceException - for standard reasons as documented in DeviceException.

turnOff

void turnOff()
      throws DeviceException

Turns the LED off.

Throws:

DeviceException - for standard reasons as documented in DeviceException.