Response Field Headers

AC: Authentication Chip test

This field header indicates the result of the test on the authentication chip .

Format

AC: Passed/Failed/NotPresent

Examples

AC: Passed

Used in

AE: Autorun file End

This field header indicates the end of the Autorun file .

Format

AE: optional text

Examples

AE: **** End of Autorun file ****

Used in

.ar Autorun Command

AS: Antenna Serial number

This field header precedes the antenna serial number .

Format

AS: “Antenna serial number”

Examples

AS: 1128-S1-EU-000001

Used in

BA: Bluetooth® Address

This field header precedes the Bluetooth® address .

Format

BA: “Bluetooth® Address”

Examples

BA: 00:07:80:41:a4:c6

Used in

BC: Barcode data

This field header precedes the barcode value when escape characters are enabled (default) . Since some barcodes can contain the termination characters the use of an escape character, (0x1B), is used to distinguish between a Cr Lf sequence contained in the Barcode and the real termination characters. Should the escape character be read as part of the barcode it will be escaped as well.

Format

BC: “Barcode Value”

Examples

Example using escape character to read the following barcode data
“abc<ESC>123456789<CR><LF>abcdef”
BC: abc<ESC><ESC>123456789<ESC><CR><ESC><LF>abcdef

Used in

BH: Battery Health

This field header precedes the powerhandle battery health information. (2128 only, where fitted)

Format

BH: PH vo=voltage dc=designcap fc=fullcap rc=remcap cc=chargecycles sh=stateofhealth

Examples

BH: PH vo=4179 dc=6500 fc=6530 rc=6530 cc=4 sh=100

Used in

BP: Battery Percentage level

This field header precedes the battery level value .

Format

BP: “Battery level Value”

Examples

BP:100%
BP:78%
BP:4%

Used in

BR: Barcode Raw

This field header precedes the barcode value when escape characters are disabled. Care must be taken since some barcodes can contain the termination characters .

Format

BR: “Barcode Value”

Examples

BR: ISBN:5884688-6686

Used in

BV: Bluetooth® Version

This field header precedes the Bluetooth® firmware version .

Format

BV: “Bluetooth® Version”

Examples

BV: 560

Used in

CF: Channel Frequency

This field header precedes channel frequency (Hz) used.

Format

CF: “frequency”

Examples

CF: 924750

Used in

CH: Charge Status

This field header precedes charge status.

Format

CH: Off/Charging/Complete/Error

Examples

CH: Complete

Used in

CR: Transponder EPC CRC value

This field header precedes Transponder EPC CRC value (in hex) .

Format

CR: “CRC Value”

Examples

CR: 3E4F

Used in

CS: Command Started

This field header is sent to indicate that a command has started. It precedes the command that initiated it .

Format

CS: “Command”

Examples

CS: bc -t 6

Used in

.hd HID configuration for double press switch action

.hs HID configuration for single press switch action

DA: Date

This field header precedes the Date, in ISO 8601 extended format .

Format

DA: “Date”

Examples

DA: 2013-01-24

Used in

DP: Double press user defined switch action

This field header precedes the action that will be executed when “.sa -d usr” is configured.

Format

DP: Switch command

Examples

DP: .bc -t4
DP: .iv

Used in

DT: Date/Time Stamp

This field header precedes the Time Stamp, in ISO 8601 extended format .

Format

DT: “Date/Time Stamp”

Examples

DT: 2013-01-24T13:12:16

Used in

EA: Transponder Access Error Code

This field header precedes the Transponder access error code . Access errors are generated by the reader while trying to access a transponder and apply to the transponder with the preceding EPC value.

Format

EA:nnn		nnn = 000 to 255

Error Codes

001 Handle mismatch.
002 CRC error on transponder response.
003 No transponder reply.
004 Invalid password.
005 Zero kill password.
006 Transponder lost.
007 Command format error.
008 Read count invalid.
009 Out of retries.
010 Access error.
255 Operation failed.

Examples

EA:004
EA:006

Used in

EB: Transponder Backscatter Error Code

This field header precedes the Transponder backscatter error code. Backscatter errors are generated by the transponder and apply to the transponder with the preceding EPC value.

Format

EB:nnn		nnn = 000 to 255

Error Codes

000 General error.
003 Memory does not exist or the PC value is not supported.
004 Memory is lock or permalocked.
011 Transponder has insufficient power.
015 Transponder does not support error specific codes.

Examples

EB:003
EB:011

Used in

EP: Transponder EPC value

This field header precedes Transponder EPC value (in hex) .

Format

EP: “EPC Value”

Examples

EP: 0000000000000000000010E6

Used in

ER: Error

This field header is used to terminate the response to an unsuccessful command. It is always followed by a three digit error code then two Carriage return Linefeed pairs .

Format

ER:nnn		nnn = 000 to 255

Error Codes

001 Syntax Error.
002 Parameter not supported.
003 Action not enabled.
004 Command not supported by hardware
005 No transponder found
006 No Barcode found
007 Parameter configuration invalid
008 Antenna/Radio Error (Wrong region or Antenna/Radio Not Fitted)
009 Battery level too low
010 Scanner not ready
011 Command not supported on interface
012 Command not supported from Autorun file
013 Write Failure
014 Switch already in use
015 Command Aborted
016 Lock Failure
017 Bluetooth® Error
018 Licence Key is not blank
255 System Error.

Examples

ER:001
ER:004

Used in

.hd HID configuration for double press switch action

.hs HID configuration for single press switch action

FN: Bluetooth® Friendly Name

This field header precedes the Bluetooth® friendly name .

Format

FN: “Bluetooth® Friendly Name”

Examples

FN: 1128-EU-000001

Used in

IA: UHF API Version

This field header precedes the UHF API version number used for identifying the API in use.

Format

IA: “UHF API version number”

Examples

IA: 1.5.0.10

Used in

HB: Power Handle Bootloader version number

This field header precedes the powerhandle bootloader version number. (2128 only, when fitted)

Format

HB: “Powerhandle bootloader version number”

Examples

HB: 1.0.0

Used in

HF: Power Handle Firmware version number

This field header precedes the powerhandle firmware version number. (2128 only, when fitted)

Format

HF: “Powerhandle firmware version number”

Examples

HF: 1.0.0

Used in

HS: Powerhandle Serial number

This field header precedes the powerhandle serial number. (2128 only, when fitted)

Format

HS: “Powerhandle serial number”

Examples

HS: 2102-000001

Used in

IX: Index Number

This field header precedes an index number used for referencing multiple responses to a command .

Format

IX: 4 digit ASCII hex Index number

Examples

IX: 004A

Used in

KS: Kill Success

This field header indicates the kill command has succeeded .

Format

KS: Kill Success

Examples

KS: Kill Success

Used in

LB: Log Begin

This field header indicates the beginning of the log .

Format

LB: optional text

Examples

LB: **** Beginning of Log ****

Used in

LE: Log End

This field header indicates the end of the log .

Format

LE: optional text

Examples

LE: **** End of Log ****
LE: **** End of Block ****

Used in

LL: Log Length

This field header precedes the length of the log file in bytes .

Format

LL: 8 digit ASCII hex Index number

Examples

LL: 0000004A

Used in

LK: Licence Key

This field header precedes the licence key string. Any printable ASCII characters are allowed.

Format

LK: licence Key

Examples

LK: IamAlicenceKey

Used in

LS: Lock Success

This field header indicates the lock command has succeeded.

Format

LS: Lock Success

Examples

LS: Lock Success

Used in

ME: Message

This field header precedes message text. It usually precedes the ER: field header to provide additional error information.

Format

ME: “Message text”

Examples

ME: “Vibration not supported”

Used in

.hd HID configuration for double press switch action

.hs HID configuration for single press switch action

MF: Manufacturer name

This field header precedes the manufacturers name .

Format

MF: “Manufacturer name”

Examples

MF: Technology Solutions UK ltd.

Used in

OK: OK response

This field header is used to terminate the response to a successful command. It is always followed by two Carriage return Linefeed pairs .

Format

OK:

Examples

OK:

Used in

.hd HID configuration for double press switch action

.hs HID configuration for single press switch action

QT: QT Control Word

This field header precedes the 16 bit QT control word (in hex) .

Format

QT: “QT Value”

Examples

QT: 4000

Used in

PC: Transponder EPC PC value

This field header precedes Transponder EPC PC value (in hex) .

Format

PC: “PC Value”

Examples

PC: 3000

Used in

PH: Phase

This field header precedes tag phase (degrees) used.

Format

PH: “phase”

Examples

PH: 135

Used in

PR: Parameters

This field header precedes parameter values .

Format

PR: “Parameter Values”

Examples

PR: -v on -b off

Used in

.al Alert Command

.hd HID configuration for double press switch action

.hs HID configuration for single press switch action

PV: Protocol Version number

This field header precedes the protocol version number .

Format

PV: “Protocol version number”

Examples

PV: 2.5.0

Used in

RB: Radio Bootloader version number

This field header precedes the radio bootloader version number .

Format

RB: “Radio bootloader version number”

Examples

RB: 1.2.0

Used in

RD: Transponder Read Data

This field header precedes data read from a Transponder (in hex) .

Format

RD: “Read Data”

Examples

RD: 0F078010

Used in

RF: Radio Firmware version number

This field header precedes the radio firmware version number .

Format

RF: “Radio firmware version number”

Examples

RF: 2.6.0

Used in

RI: Transponder RSSI value

This field header precedes Transponder RSSI value in dBm .

Format

RI: “RSSI Value”

Examples

RI: -63

Used in

RS: Radio Serial number

This field header precedes the radio serial number which .

Format

RS: “Radio serial number”

Examples

RS: 1116-ET-000001

Used in

RP: RSSI Percentage

Format

RP: “percentage”

Examples

RP: 58

Used in

SP: Single press user defined switch action

This field header precedes the action that will be executed when “.sa -s usr” is configured .

Format

SP: Switch command

Examples

SP: .bc -t4
SP: .iv

Used in

SR: Set Region

This field header precedes the currently selected region. Format: SR: region Code

Format

Examples

SR: us
SR: eu

Used in

SW: Switch status

This field header precedes the switch state value.

Format

SW: “off/single/double”

Examples

SW: single
SW: off

Used in

TD: Transponder TID value

This field header precedes the Transponder TID value (in hex) .

Format

Examples

TD: 1C2B3A495867768594A3B2C1

Used in

TM: Time

This field header precedes the Time, in ISO 1601 extended format.

Format

TM: “Time”

Examples

TM: 13:12:16

Used in

UB: Unit Bootloader version number

This field header precedes the unit bootloader version number.

Format

UB: “Unit bootloader version number”

Examples

UB: 1.2.0

Used in

UF: Unit Firmware version number

This field header precedes the unit firmware version number.

Format

UF: “Unit firmware version number”

Examples

UF: 2.6.0

Used in

US: Unit Serial number

This field header precedes the unit serial number.

Format

US: “Unit serial number”

Examples

US: 1128-EU-000001

Used in

WW: Number of Words Written

This field header precedes the number of words successfully written by a transponder write command.

Format

WW: nn

Examples

Used in