public interface

CradleJoyaTouch

implements Cradle
com.datalogic.extension.selfshopping.cradle.joyatouch.CradleJoyaTouch

Class Overview

Interface for the Joya Touch Cradle API.

Summary

Nested Classes
enum CradleJoyaTouch.Type Enumerative representing a Joya Touch Cradle type. 
Public Methods
abstract boolean controlLed(LedAction action)
Execute a specific action on the current LED.
abstract boolean controlLock(LockAction action)
Execute a specific lock action.
abstract boolean getCradleState(StateInfo state)
Read the current state from the Joya Touch Cradle.
abstract CradleJoyaTouch.Type getCurrentlyInsertedCradleType()
Returns the type of Cradle the device is currently inserted into (or UNKNOWN in case the device is not currently inside a Cradle).
abstract FailureState getFailureState()
Return current slot's failure state.
abstract FavoriteFirmware getFavoriteFirmware()
Gets the favorite firmware value currently in use.
abstract boolean isFastChargeEnabled()
Checks if the device is currently in fast charge.
abstract boolean readConfigArea(ConfigArea area)
Read the configuration area from the Cradle.
abstract boolean readCustomArea(CustomArea area, int size)
Read the custom area from the Cradle.
abstract boolean reset()
Method used to reset the Joya Touch Cradle.
abstract void setFavoriteFirmware(FavoriteFirmware favoriteFirmware)
Sets the favorite firmware between the list of allowed values.
abstract boolean writeConfigArea(ConfigArea area)
Write the configuration area into the Cradle.
abstract boolean writeCustomArea(CustomArea area, int size)
Write the custom area into the Cradle.
[Expand]
Inherited Methods
From interface com.datalogic.extension.selfshopping.cradle.Cradle

Public Methods

public abstract boolean controlLed (LedAction action)

Added in revision 1

Execute a specific action on the current LED. This method is used to control the Cradle LED of the slot in which the device is inserted.

Parameters
action Specifies which LedAction to execute.
Returns
  • boolean true in case of success, false otherwise.

public abstract boolean controlLock (LockAction action)

Added in revision 1

Execute a specific lock action. This method is used to lock or unlock the device from the Cradle, optionally controlling the LED associated with the current Cradle slot.

Parameters
action Specifies which LockAction to execute.
Returns
  • boolean true in case of success, false otherwise.

public abstract boolean getCradleState (StateInfo state)

Added in revision 1

Read the current state from the Joya Touch Cradle.

Parameters
state The StateInfo that will be filled by the method with the current information read from the Cradle if the operation is successful, otherwise the input object will not be modified from its previous values.
Returns
  • boolean true in case of success, false otherwise.

public abstract CradleJoyaTouch.Type getCurrentlyInsertedCradleType ()

Added in revision 3

Returns the type of Cradle the device is currently inserted into (or UNKNOWN in case the device is not currently inside a Cradle).

Returns

public abstract FailureState getFailureState ()

Added in revision 5

Return current slot's failure state.

Returns
  • A FailureState enum representing the current failure state.

public abstract FavoriteFirmware getFavoriteFirmware ()

Added in revision 4

Gets the favorite firmware value currently in use.

Returns
  • A FavoriteFirmware enum representing the firmware to favor during Cradle detection.

public abstract boolean isFastChargeEnabled ()

Added in revision 1

Checks if the device is currently in fast charge.

Returns
  • boolean true in case the device is in fast charge, false otherwise.

public abstract boolean readConfigArea (ConfigArea area)

Added in revision 1

Read the configuration area from the Cradle.

Parameters
area The ConfigArea to be filled with the result read from the Cradle.
Returns
  • boolean true in case of success, false otherwise.

public abstract boolean readCustomArea (CustomArea area, int size)

Added in revision 1

Read the custom area from the Cradle.

Parameters
area The CustomArea to be filled with the result read from the Cradle.
size The required size for the custom area. This parameter has a maximum value of SIZE.
Returns
  • boolean true in case of success, false otherwise.

public abstract boolean reset ()

Added in revision 1

Method used to reset the Joya Touch Cradle.

Returns
  • boolean true in case of success, false otherwise.

public abstract void setFavoriteFirmware (FavoriteFirmware favoriteFirmware)

Added in revision 4

Sets the favorite firmware between the list of allowed values.

Parameters
favoriteFirmware A FavoriteFirmware enum representing the firmware to favor during Cradle detection.

public abstract boolean writeConfigArea (ConfigArea area)

Added in revision 1

Write the configuration area into the Cradle.

Parameters
area The ConfigArea to write into the Cradle.
Returns
  • boolean true in case of success, false otherwise.

public abstract boolean writeCustomArea (CustomArea area, int size)

Added in revision 1

Write the custom area into the Cradle.

Parameters
area The CustomArea to write into the Cradle.
size The number of bytes to write in the custom area. This parameter has a maximum value of SIZE.
Returns
  • boolean true in case of success, false otherwise.