java.lang.Object | |
↳ | com.datalogic.cradle.DLCradleManager |
This class provides access to Cradle related methods of the device.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DLCradleManager.Properties | This class contains all the cradle properties identifiers. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add a Failure listener used to be notify about failure events occurred on the Cradle.
| |||||||||||
Add an Insertion listener used to be notify about insertion and extraction events from the Cradle.
| |||||||||||
Add a Unlock listener used to be notify about Lever status changed events occurred on the Cradle.
| |||||||||||
Add an Unlock Key Event listener used to be notify about Unlock Key events occurred on the Cradle.
| |||||||||||
Blinks a specific LED on the cradle.
| |||||||||||
Performs Cradle Firmware update procedure.
| |||||||||||
Abort Cradle Firmware update procedure
| |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and AVAILABLE_SOURCE_POWER_LEVEL . | |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and INSERTIONS_COUNT . | |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and INSERTION_STATE . | |||||||||||
This method was deprecated
in revision 46.
use the public constructor
| |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and LEVER_STATUS . | |||||||||||
Retrieves the value of the specified property.
| |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and SLOT_INDEX . | |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and CRADLE_TYPE . | |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and UNLOCK_KEY_STATUS . | |||||||||||
This method was deprecated
in revision 46.
use
getProperty(int, T) and FAST_CHARGE_STATUS .
| |||||||||||
Checks if a specific LED is supported by the cradle.
| |||||||||||
Checks if the specified property is read-only.
| |||||||||||
Checks if the specified property is supported by the cradle.
| |||||||||||
Lock or unlock the device into the cradle
| |||||||||||
Reboot the Cradle.
| |||||||||||
Remove a Failure listener previously added with the
addFailureEventListener(CradleFailureEventListener) method. | |||||||||||
Remove an Insertion listener previously added with the
addInsertionEventListener(CradleInsertionEventListener) method. | |||||||||||
Remove an Unlock listener previously added with the
addUnlockEventListener(CradleUnlockEventListener) method. | |||||||||||
Remove an Unlock Key Event listener previously added with the
addUnlockKeyEventListener(CradleUnlockKeyEventListener) method. | |||||||||||
Sets the state of a specific LED on the cradle.
| |||||||||||
This method was deprecated
in revision 46.
use
lockDevice(boolean) | |||||||||||
Sets the value of the specified property.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Add a Failure listener used to be notify about failure events occurred on the Cradle.
If property ACTIVE_FAILURES
is not supported, this listener cannot be added.
listener | The CradleFailureEventListener to be added. |
---|
boolean
true in case of success, false otherwise.
Add an Insertion listener used to be notify about insertion and extraction events from the Cradle.
If property INSERTION_STATE
is not supported, this listener cannot be added.
listener | The CradleInsertionEventListener to be added. |
---|
boolean
true in case of success, false otherwise.
Add a Unlock listener used to be notify about Lever status changed events occurred on the Cradle.
If property LEVER_STATUS
is not supported, this listener cannot be added.
listener | The CradleUnlockEventListener to be added. |
---|
boolean
true in case of success, false otherwise.
Add an Unlock Key Event listener used to be notify about Unlock Key events occurred on the Cradle.
If property UNLOCK_KEY_STATUS
is not supported, this listener cannot be added.
listener | The CradleUnlockKeyEventListener to be added. |
---|
boolean
true in case of success, false otherwise.
Blinks a specific LED on the cradle. This method allows blinking a specific LED identified by its ID. The blink count, duration of the ON state, and duration of the OFF state can be configured.
id | The CradleLed representing the LED to be blinked. |
---|---|
colorArgb | The ARGB color value to set for the LED during blinking. |
blinkCount | The number of times the LED should blink. Range: [0 : 65535]. If set to 0, the LED will blink indefinitely. |
onDurationMs | The duration (in milliseconds) the LED stays ON during each blink. Range: [0 : 65535]. |
offDurationMs | The duration (in milliseconds) the LED stays OFF during each blink. Range: [0 : 65535]. |
true
if the operation was successful, false
otherwise.
Performs Cradle Firmware update procedure.
binaryPath | the String path where the binary file is stored. |
---|---|
size | the String dimension of the binary file. |
boolean
true in case of success, false otherwise.in case of error. |
Abort Cradle Firmware update procedure
Integer
true in case of success, false otherwise.
This method was deprecated
in revision 46.
use getProperty(int, T)
and AVAILABLE_SOURCE_POWER_LEVEL
.
Returns the available source power to charge the Device into the Cradle as instance of AvailableSourcePower
.
AvailableSourcePower
configured to charge the Device.
This method was deprecated
in revision 46.
use getProperty(int, T)
and INSERTIONS_COUNT
.
Returns the current insertion count for this Cradle slot
Integer
of the current insertion count for this Cradle slot.
This method was deprecated
in revision 46.
use getProperty(int, T)
and INSERTION_STATE
.
Returns the position of the Device related to the Cradle as instance of InsertionState
.
InsertionState
of the Device.
This method was deprecated
in revision 46.
use the public constructor
Returns an instance of the DLCradleManager
.
This method was deprecated
in revision 46.
use getProperty(int, T)
and LEVER_STATUS
.
Returns the current position related to the Cradle lever.
LeverStatus
of the Cradle.
Retrieves the value of the specified property.
This method fetches the value of the property identified by the given property ID, as defined in
the DLCradleManager.Properties
class. If the property is not found or an error occurs, the default value
provided is returned.
propertyId | The identifier of the property to retrieve, as defined in DLCradleManager.Properties . |
---|---|
defaultValue | The default value to return if the property is not found. |
This method was deprecated
in revision 46.
use getProperty(int, T)
and SLOT_INDEX
.
Returns the Cradle slot index where the device is inserted in. This value is persistent in the cradle memory and it couldn't be changed.
Integer
of the Cradle slot index where the device is inserted in.
This method was deprecated
in revision 46.
use getProperty(int, T)
and CRADLE_TYPE
.
Returns the Cradle type.
Type
of the Cradle where the device is inserted in.
This method was deprecated
in revision 46.
use getProperty(int, T)
and UNLOCK_KEY_STATUS
.
Returns the current position related to the unlock key.
UnlockKeyStatus
of the unlock key.
This method was deprecated
in revision 46.
use getProperty(int, T)
and FAST_CHARGE_STATUS
.
return if fast charge is supported by the Cradle.
Checks if a specific LED is supported by the cradle. This method verifies whether the cradle supports a specific LED identified by its ID.
id | The CradleLed representing the LED to be checked. |
---|
true
if the LED is supported, false
otherwise.
Checks if the specified property is read-only.
This method determines whether the given property identifier, defined in the DLCradleManager.Properties
class,
is read-only. Read-only properties can only be accessed but not modified.
propertyId | The identifier of the property to check, as defined in DLCradleManager.Properties . |
---|
true
if the property is read-only, false
otherwise.
Checks if the specified property is supported by the cradle.
This method verifies whether the given property identifier, defined in the DLCradleManager.Properties
class,
is supported by the cradle. If the property is supported, it can be accessed or modified depending
on its read-only status.
propertyId | The identifier of the property to check, as defined in DLCradleManager.Properties . |
---|
true
if the property is supported, false
otherwise.
Lock or unlock the device into the cradle
lock | true to lock the device, false to unlock the device.
|
---|
Reboot the Cradle.
in case of error. |
Remove a Failure listener previously added with the addFailureEventListener(CradleFailureEventListener)
method.
If property ACTIVE_FAILURES
is not supported, this listener cannot be removed.
listener | The CradleFailureEventListener to be removed. |
---|
boolean
true in case of success, false otherwise.
Remove an Insertion listener previously added with the addInsertionEventListener(CradleInsertionEventListener)
method.
If property INSERTION_STATE
is not supported, this listener cannot be removed.
listener | The CradleInsertionEventListener to be removed. |
---|
boolean
true in case of success, false otherwise.
Remove an Unlock listener previously added with the addUnlockEventListener(CradleUnlockEventListener)
method.
If property LEVER_STATUS
is not supported, this listener cannot be removed.
listener | The CradleUnlockEventListener to be removed. |
---|
boolean
true in case of success, false otherwise.
Remove an Unlock Key Event listener previously added with the addUnlockKeyEventListener(CradleUnlockKeyEventListener)
method.
If property UNLOCK_KEY_STATUS
is not supported, this listener cannot be removed.
listener | The CradleUnlockKeyEventListener to be removed. |
---|
boolean
true in case of success, false otherwise.
Sets the state of a specific LED on the cradle. This method allows enabling or disabling a specific LED identified by its ID. The LED color can also be set using an ARGB value.
ledId | The CradleLed representing the LED to be controlled. |
---|---|
colorARGB | The ARGB color value to set for the LED. |
enable | true to enable the LED, false to disable it. |
true
if the operation was successful, false
otherwise.
This method was deprecated
in revision 46.
use lockDevice(boolean)
Sets the new position related to the Cradle lever.
levelStatus | The required LeverStatus of the Cradle lever. |
---|
boolean
true in case of success, false otherwise.
Sets the value of the specified property.
This method updates the value of the property identified by the given property ID, as defined in
the DLCradleManager.Properties
class. If the property is read-only or unsupported, the operation will fail.
propertyId | The identifier of the property to set, as defined in DLCradleManager.Properties . |
---|---|
value | The new value to assign to the property. |