public static class

DLCradleManager.Properties

extends Object
java.lang.Object
   ↳ com.datalogic.cradle.DLCradleManager.Properties

Class Overview

This class contains all the cradle properties identifiers. The properties defined in this class represent various attributes and states of the cradle. These identifiers are used to interact with the cradle's properties through the methods:

Summary

Constants
int ACTIVE_FAILURES Property that represents the failures currently active in the cradle.
int AVAILABLE_SOURCE_POWER_LEVEL Property that represents the available source power level in the cradle.
int BOOTLOADER_VERSION Property that represents the cradle bootloader version.
int CRADLE_TYPE Property that represents cradle type.
int CUSTOM_AREA_BASE Represents a customizable area of cradle memory that can be read and written by the user.
int DAISY_CHAIN_CONNECTED Property that represents if the cradle is connected in daisy chain.
int ENABLED_FAILURES Property that represents the enabled cradle failures.
int FAILURE_COUNTERS Property that represents the number of occurrence for a certain failure.
int FAST_CHARGE_DISABLE Property that represents whether fast charge is disabled or not.
int FAST_CHARGE_STATUS Property that represents the fast charge status when device is charged by cradle Fast charge status depends by FAST_CHARGE_DISABLE and DAISY_CHAIN_CONNECTED.
int FIRMWARE_VERSION Property that represents the cradle firmware version.
int HARDWARE_REVISION Property that represents the cradle hardware revision.
int INSERTIONS_COUNT Property that represents the number of times device has been inserted in the current slot.
int INSERTION_STATE Property that represents the device insertion state.
int LAST_OCCURRED_FAILURES Property that represents the last failures occurred in the cradle.
int LED_ON_UNLOCK Property that represents if cradle led is enabled when cradle is unlocking the device.
int LED_SMOOTHNESS Property that represents the smoothness level of the LED transitions in the cradle.
int LEVER_STATUS Property that represents the state of cradle lever.
int MANUFACTURE_DATE Property that represents the cradle manufacture date.
int PART_NUMBER Property that represents the cradle part number.
int RELOCK_TIMEOUT Property that represents the timeout after which the cradle locks the device following an unlock.
int SERIAL_NUMBER Property that represents the cradle serial number.
int SLOT_ID Property that represents the slot id of the cradle.
int SLOT_INDEX Property that represents the slot index.
int UNLOCK_KEY_STATUS Property that represents the state of the unlock key.
int WLC_FIRMWARE_VERSION Property that represents the cradle WLC firmware version.
Public Constructors
Properties()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int ACTIVE_FAILURES

Added in revision 46

Property that represents the failures currently active in the cradle. This property is read-only. Type: List<Failure>

Constant Value: 15 (0x0000000f)

public static final int AVAILABLE_SOURCE_POWER_LEVEL

Added in revision 46

Property that represents the available source power level in the cradle. This property is read-only. Type: AvailableSourcePower

Constant Value: 12 (0x0000000c)

public static final int BOOTLOADER_VERSION

Added in revision 46

Property that represents the cradle bootloader version. This property is read-only. Type: Integer

Constant Value: 3 (0x00000003)

public static final int CRADLE_TYPE

Added in revision 46

Property that represents cradle type. This property is read-only. Type: Type

Constant Value: 0 (0x00000000)

public static final int CUSTOM_AREA_BASE

Added in revision 46

Represents a customizable area of cradle memory that can be read and written by the user. The custom area is structured as a key-value map, where keys are integers and values are objects:

  • Keys start from CUSTOM_AREA_BASE and increment sequentially for each new key.
  • Values can be any primitive type or a class implementing Serializable.

In case of custom class, to ensure clean serialization and avoid hidden dependencies, always define the serializable class as top-level (external) classes in its own files.

Example Usage:

 DLCradleManager dlCradleManager = new DLCradleManager();

 // Set properties:
 dlCradleManager.setProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE, "foo"); // Set a string
 dlCradleManager.setProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 1, 10); // Set an integer
 dlCradleManager.setProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 2, true); // Set a boolean
 dlCradleManager.setProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 3, new int[]{10, 20, 30}); // Set an array
 dlCradleManager.setProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 4, new CustomClass(100, true, "foo")); // Set a custom class

 // Get properties:
 String stringValue = dlCradleManager.getProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE, null);
 int integerValue = dlCradleManager.getProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 1, null);
 boolean booleanValue = dlCradleManager.getProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 2, null);
 int[] arrayValue = dlCradleManager.getProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 3, null);
 CustomClass customValue = dlCradleManager.getProperty(DLCradleManager.Properties.CUSTOM_AREA_BASE + 4, null);

 // Example of a custom class:
 public class CustomClass implements Serializable {
     private int a;
     private boolean b;
     private String c;

     public CustomClass(int a, boolean b, String c) {
         this.a = a;
         this.b = b;
         this.c = c;
     }

     public String toString() {
         return String.format("CustomClass{a=%d, b=%b, c='%s'}", a, b, c);
     }
 }
 

This property is read and write. Type: Object

Constant Value: 1000 (0x000003e8)

public static final int DAISY_CHAIN_CONNECTED

Added in revision 46

Property that represents if the cradle is connected in daisy chain. This affects FAST_CHARGE_STATUS. This property is read-only. Type: Boolean

Constant Value: 14 (0x0000000e)

public static final int ENABLED_FAILURES

Added in revision 46

Property that represents the enabled cradle failures. The cradle signals these failures using its LED indicators. This property is read and write. Type: List<Failure>

Constant Value: 18 (0x00000012)

public static final int FAILURE_COUNTERS

Added in revision 46

Property that represents the number of occurrence for a certain failure. This property is read-only. Type: Map<Failure, Integer>

Constant Value: 17 (0x00000011)

public static final int FAST_CHARGE_DISABLE

Added in revision 46

Property that represents whether fast charge is disabled or not. This affects FAST_CHARGE_STATUS. This property is read and write. Type: Boolean

Constant Value: 21 (0x00000015)

public static final int FAST_CHARGE_STATUS

Added in revision 46

Property that represents the fast charge status when device is charged by cradle Fast charge status depends by FAST_CHARGE_DISABLE and DAISY_CHAIN_CONNECTED. This property is read-only. Type: Boolean

Constant Value: 13 (0x0000000d)

public static final int FIRMWARE_VERSION

Added in revision 46

Property that represents the cradle firmware version. This property is read-only. Type: Integer

Constant Value: 2 (0x00000002)

public static final int HARDWARE_REVISION

Added in revision 46

Property that represents the cradle hardware revision. This property is read-only. Type: Integer

Constant Value: 4 (0x00000004)

public static final int INSERTIONS_COUNT

Added in revision 46

Property that represents the number of times device has been inserted in the current slot. This property is read-only. Type: Integer

Constant Value: 19 (0x00000013)

public static final int INSERTION_STATE

Added in revision 46

Property that represents the device insertion state. This property is read-only. Type: InsertionState

Constant Value: 9 (0x00000009)

public static final int LAST_OCCURRED_FAILURES

Added in revision 46

Property that represents the last failures occurred in the cradle. Only the last occurence for each failure type is shown. This property is read-only. Type: List<FailureOccurrence>

Constant Value: 16 (0x00000010)

public static final int LED_ON_UNLOCK

Added in revision 46

Property that represents if cradle led is enabled when cradle is unlocking the device. This property is read and write. Type: Boolean

Constant Value: 22 (0x00000016)

public static final int LED_SMOOTHNESS

Added in revision 46

Property that represents the smoothness level of the LED transitions in the cradle. The smoothness level determines how gradual or abrupt the LED changes appear. This property is read and write. Type: Integer

Constant Value: 23 (0x00000017)

public static final int LEVER_STATUS

Added in revision 46

Property that represents the state of cradle lever. This property is read-only. Type: LeverStatus

Constant Value: 10 (0x0000000a)

public static final int MANUFACTURE_DATE

Added in revision 46

Property that represents the cradle manufacture date. This property is read-only. Type: String

Constant Value: 7 (0x00000007)

public static final int PART_NUMBER

Added in revision 46

Property that represents the cradle part number. This property is read-only. Type: String

Constant Value: 6 (0x00000006)

public static final int RELOCK_TIMEOUT

Added in revision 46

Property that represents the timeout after which the cradle locks the device following an unlock. Timeout is in seconds. Range: [5, 420]. This property is read and write. Type: Integer

Constant Value: 20 (0x00000014)

public static final int SERIAL_NUMBER

Added in revision 46

Property that represents the cradle serial number. This property is read-only. Type: String

Constant Value: 5 (0x00000005)

public static final int SLOT_ID

Added in revision 46

Property that represents the slot id of the cradle. This property is used to identify arbitrarily the slot in which the device is inserted. Instead of SLOT_INDEX slot ID could be assigned arbitrarily. This property is read and write. Type: Integer

Constant Value: 24 (0x00000018)

public static final int SLOT_INDEX

Added in revision 46

Property that represents the slot index. The slot index is used to identify the cradle slot in which the device is inserted. It is not the same as the SLOT_ID which can be assigned arbitrarily and it cannot be changed. This property is read-only. Type: Integer

Constant Value: 1 (0x00000001)

public static final int UNLOCK_KEY_STATUS

Added in revision 46

Property that represents the state of the unlock key. This property is read-only. Type: UnlockKeyStatus

Constant Value: 11 (0x0000000b)

public static final int WLC_FIRMWARE_VERSION

Added in revision 46

Property that represents the cradle WLC firmware version. This property is read-only. Type: Integer

Constant Value: 8 (0x00000008)

Public Constructors

public Properties ()

Added in revision 46