Property¶
-
public final class
Property
implements JsonObject¶
Fields¶
CONFIGURATION¶
-
public static final int
CONFIGURATION
¶ property to set or get the Capture configuration.
DATA_CONFIRMATION_ACTION¶
-
public static final int
DATA_CONFIRMATION_ACTION
¶ Gets or sets the data confirmation action.
Data confirmation action determines how good or bad data is acknowledged.
This is only used when
Property.DATA_CONFIRMATION_MODE
is set toConfirmation.MODE_SERVICE
.
DATA_CONFIRMATION_MODE¶
-
public static final int
DATA_CONFIRMATION_MODE
¶ Gets or sets the data confirmation mode.
Data confirmation mode determines who acknowledges whether the data received was good or bad.
Can be one of
Confirmation.MODE_OFF
,Confirmation.MODE_DEVICE
,Confirmation.MODE_SERVICE
orConfirmation.MODE_CLIENT
DEVICE_APPLY_CONFIG¶
-
public static final int
DEVICE_APPLY_CONFIG
¶ property to apply a config to a Capture Device (not yet enabled)
DEVICE_APP_MODE_STARTUP_ROLE¶
-
public static final int
DEVICE_APP_MODE_STARTUP_ROLE
¶ Gets or sets the reconnect behavior of the device when it is powered on in application mode.
By default, the device will attempt to reconnect to the last host, but this feature can be turned off using this property.
DEVICE_BATTERY_LEVEL¶
-
public static final int
DEVICE_BATTERY_LEVEL
¶ Gets the current battery level of the device.
Consider using
Property.DEVICE_NOTIFICATIONS
to subscribe to battery level change events instead.
DEVICE_BLUETOOTH_ADDRESS¶
-
public static final int
DEVICE_BLUETOOTH_ADDRESS
¶ Gets the Bluetooth address of the device.
DEVICE_BUTTON_STATUS¶
-
public static final int
DEVICE_BUTTON_STATUS
¶ Gets the current state of each button on the device.
Consider using
Property.DEVICE_NOTIFICATIONS
to subscribe to button events instead.
DEVICE_CAPABILITIES¶
-
public static final int
DEVICE_CAPABILITIES
¶ property to get the Capture Device capabilities
DEVICE_CHANGE_ID¶
-
public static final int
DEVICE_CHANGE_ID
¶ Gets the change id of the device.
The change id is a checksum of all the engine settings - e.g. data source settings, preamble, postamble, etc - and can be used to determine if the device configuration has been altered by another application or using a command barcode.
DEVICE_CONNECTION_BEEP¶
-
public static final int
DEVICE_CONNECTION_BEEP
¶ property to get or set the Capture Device Connection Beep Configuration.
DEVICE_CONNECT_REASON¶
-
public static final int
DEVICE_CONNECT_REASON
¶ property to get the Capture Device Connect reason
DEVICE_DATA_CONFIRMATION¶
-
public static final int
DEVICE_DATA_CONFIRMATION
¶ Sends an acknowledgement to the device.
Acknowledgement can either be positive or negative - a.k.a. good scan or bad scan.
DEVICE_DATA_FORMAT¶
-
public static final int
DEVICE_DATA_FORMAT
¶ property to get or set the Decoded Data Format of a Capture Device
DEVICE_DATA_SOURCE¶
-
public static final int
DEVICE_DATA_SOURCE
¶ Gets or sets the settings of a data source - includes enabling or disabling a data source.
DEVICE_DATA_STORE¶
-
public static final int
DEVICE_DATA_STORE
¶ Gets or sets arbitrary bytes to store on the device.
The device has 16 storage locations which can hold up to 64 bytes each.
DEVICE_DELETE_BOND¶
-
public static final int
DEVICE_DELETE_BOND
¶ Set deletes pairing and bonding information off the device.
Recommended when preparing to pair the Capture device to a different host.
DEVICE_DISCONNECT¶
-
public static final int
DEVICE_DISCONNECT
¶ Instructs the device to drop its connection
Note: After sending this command, the host will be unable to send any subsequent commands to this device.
DEVICE_FACTORY_RESET¶
-
public static final int
DEVICE_FACTORY_RESET
¶ Set resets all the settings on the device to their default values.
DEVICE_FIRMWARE_VERSION¶
-
public static final int
DEVICE_FIRMWARE_VERSION
¶ Gets the firmware version of the device.
DEVICE_FRIENDLY_NAME¶
-
public static final int
DEVICE_FRIENDLY_NAME
¶ Gets or sets the friendly name of the device.
The friendly name is the name that appears in Bluetooth settings.
DEVICE_LOCAL_ACKNOWLEDGEMENT¶
-
public static final int
DEVICE_LOCAL_ACKNOWLEDGEMENT
¶ Gets or sets local device acknowledgement.
When enabled, the device acknowledges decoded data as soon as it is decoded. When disabled the device waits for the host to acknowledge decoded data and the trigger will be locked until acknowledgement is received or the trigger lock timeout has elapsed.
DEVICE_LOCAL_DECODE_ACTION¶
-
public static final int
DEVICE_LOCAL_DECODE_ACTION
¶ Gets or sets the local decode action of the device.
Determines how decoded data is acknowledged when
Property.DATA_CONFIRMATION_MODE
isConfirmation.MODE_DEVICE
- i.e. with a beep, rumble, flash or some combination of all three.
DEVICE_NOTIFICATIONS¶
-
public static final int
DEVICE_NOTIFICATIONS
¶ Gets or sets subscriptions to various events from the device.
Events that can be subscribed to include, trigger press/release power button press/release, power state and battery level change.
DEVICE_PIN_CODE¶
-
public static final int
DEVICE_PIN_CODE
¶ property to get or set the Capture Device PIN code
DEVICE_POSTAMBLE¶
-
public static final int
DEVICE_POSTAMBLE
¶ Gets or sets a postamble for data decoded by the device.
When set the postamble is added to the end of the decoded data.
DEVICE_POWER_STATE¶
-
public static final int
DEVICE_POWER_STATE
¶ Gets the current power state of the device.
Consider using
Property.DEVICE_NOTIFICATIONS
to subscribe to power state events instead.
DEVICE_PREAMBLE¶
-
public static final int
DEVICE_PREAMBLE
¶ Gets or sets a preamble for data decoded by the device.
When set the preamble is added in front of the decoded data.
DEVICE_PROFILE_CONFIG¶
-
public static final int
DEVICE_PROFILE_CONFIG
¶ property to get or set the Capture Device Profile Configuration
DEVICE_RUMBLE_CONFIG¶
-
public static final int
DEVICE_RUMBLE_CONFIG
¶ Gets or sets the rumble configuration of the device.
There are separate rumble configurations for when a good scan is acknowledged locally (by the Capture device) and when it is acknowledged by the host. The same applies to the bad scan rumble configuration.
DEVICE_SECURITY_MODE¶
-
public static final int
DEVICE_SECURITY_MODE
¶ property to get or set the Capture Device Security Mode
DEVICE_SOUND_CONFIG¶
-
public static final int
DEVICE_SOUND_CONFIG
¶ Gets or sets the sound configuration of the device.
There are separate sound configurations for when a good scan is acknowledged locally (by the Capture device) and when it is acknowledged by the host. The same applies to the bad scan sound configuration.
DEVICE_SPECIFIC¶
-
public static final int
DEVICE_SPECIFIC
¶ Sends an arbitrary get or set command to the device.
DEVICE_STAND_MODE¶
-
public static final int
DEVICE_STAND_MODE
¶ Gets or sets the status of stand mode.
When in stand mode, the device is automatically triggered when something is put in front of it.
DEVICE_STATS_COUNTERS¶
-
public static final int
DEVICE_STATS_COUNTERS
¶ Gets the statistics counters of the device.
Counters record the absolute number of times a particular event has occurred.
DEVICE_TIMERS¶
-
public static final int
DEVICE_TIMERS
¶ Gets or sets the trigger lock and auto-off timers.
The trigger lock determines how long the trigger remains locked after decoding data without receiving confirmation. There are two auto-off timers, one for when the device is connected to a host and one for when it is not.
DEVICE_TRIGGER¶
-
public static final int
DEVICE_TRIGGER
¶ Sets the trigger of the device
Can start or stop a read and enable or disable the physical trigger button on the device.
FAVORITE¶
-
public static final int
FAVORITE
¶ Gets or sets favorite for ble.
When set to * ble scanning will be triggered
INTERFACE_VERSION¶
-
public static final int
INTERFACE_VERSION
¶ Gets the version of the firmware interface that Capture service supports.
This can be useful for determining if the service supports a particular hardware feature.
MONITOR_MODE¶
-
public static final int
MONITOR_MODE
¶ Gets or sets the log level of various Capture service components.
Only works on debug builds
START_DISCOVERY¶
-
public static final int
START_DISCOVERY
¶ Gets or sets favorite for ble.
When set to * ble scanning will be triggered
UNIQUE_DEVICE_IDENTIFIER¶
-
public static final int
UNIQUE_DEVICE_IDENTIFIER
¶ Gets Unique Device Identifier for BLE device.
Unique Device Identifier can be used to set the favorite to a specific ble device
dataSource¶
-
public final DataSource
dataSource
¶
Methods¶
create¶
-
public static Property
create
(int id, DataSource value)¶
getDataSource¶
-
public DataSource
getDataSource
()¶
toJsonObject¶
-
public JSONObject
toJsonObject
()¶
valueOf¶
-
public static Property
valueOf
(JSONObject json)¶