com.symbol.emdk.personalshopper

Class Cradle

java.lang.Object

com.symbol.emdk.personalshopper.Cradle

public class Cradle
extends Object

Class to communicate with the MC18 cradle.

Field Summary

Fields

Modifier and Type	Field and Description
CradleConfig	config The field to access Cradle configuration.

Method Summary

Modifier and Type	Method and Description
void	disable() This disables communication to interact with the cradle.
void	enable() This method enables the communication to interact with the cradle.
CradleResults	flashLed(int ledFlashCount, CradleLedFlashInfo ledFlashInfo) The LED can be flashed to identify device location without unlocking the cradle.
CradleInfo	getCradleInfo() This method gets the information of cradle.
boolean	isEnabled() Check if cradle has already been enabled
CradleResults	unlock(int unlockDuration, CradleLedFlashInfo ledFlashInfo) This unlocks terminal from cradle and flashes the LED.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

config

public CradleConfig config

The field to access Cradle configuration.

Method Detail

enable

public void enable()
            throws CradleException

This method enables the communication to interact with the cradle.

Parameters:

none -

Throws:

CradleException

disable

public void disable()
             throws CradleException

This disables communication to interact with the cradle.

Parameters:

none -

Throws:

CradleException

isEnabled

public boolean isEnabled()
                  throws CradleException

Check if cradle has already been enabled

Parameters:

none -

Returns:

true, if enabled;false, if disabled.

Throws:

CradleException

getCradleInfo

public CradleInfo getCradleInfo()
                         throws CradleException

This method gets the information of cradle.

Parameters:

none -

Returns:

CradleInfo : serial number, part number, firmware version, hardware id etc

Throws:

CradleException

unlock

public CradleResults unlock(int unlockDuration,
                            CradleLedFlashInfo ledFlashInfo)
                     throws CradleException

This unlocks terminal from cradle and flashes the LED. The timeout represents the duration in which the terminal remains unlocked in the cradle before becoming locked again. This is in seconds and the range is from 10 (minimum) to 30 (maximum) seconds. Continuous unlock may lead to heating up of hardware which may lead to unlock failure . This failure will be indicated through blinking of cradle Red Led's .Unlock will fail until hardware gets cool down .

Parameters:

unlockDuration: - The value that specifies how long the lock remains open in seconds.

ledFlashInfo: - The LED blink pattern definition

Returns:

CradleResults

Throws:

CradleException

flashLed

public CradleResults flashLed(int ledFlashCount,
                              CradleLedFlashInfo ledFlashInfo)
                       throws CradleException

The LED can be flashed to identify device location without unlocking the cradle.

Parameters:

ledFlashCount: - Defines the number of times the led should blink (on/off).

ledFlashInfo: - Defines the LED blink pattern (onDuration, offDuration, smoothness)

Returns:

CradleResults

Throws:

CradleException