Baracoda TagRunners Manual

Data Capture
for Workforce
in Motion
TagRunners
Communication Protocol
©Baracoda
TM
– December 2008

TagRunners – Communication Protocol v1.4 - 2 -
Data Capture
for Workforce
in Motion
SUMMARY
SUMMARYSUMMARY
SUMMARY
SUMMARY................................................................... 2
REVISION HISTORY.......................................................... 3
1.
1.1.
1. INTRODUCTION ........................................................ 4
1.1. G ENERALITIES .......................................................... 4
1.2. G ENERIC PACKET ........................................................ 4
2.
2.2.
2. COMMUNICATION PROTOCOL .............................................. 5
2.1. B IDIRECTIONAL PACKETS ................................................... 5
2.1.1. C ONTROL MESSAGES .............................................. 5
2.2. S CANNER TO HOST MESSAGES ................................................ 6
2.2.1. E NCAPSULATION SCHEME ........................................... 6
2.2.2. D ATA STRING FORMAT ............................................ 6
2.3. H OST TO SCANNER MESSAGES ................................................ 7
2.3.1. C OMMUNICATION MESSAGES ......................................... 7
2.3.2. S CANNER MESSAGES ............................................. 10
2.3.3. U SER I NTERFACE MESSAGES ....................................... 12
2.3.4. M ISCELLANEOUS MESSAGES ........................................ 15
2.3.5. C APTURE MESSAGES ............................................. 19
APPENDIX 1: BLUETOOTH PROTOCOL...........................................21
APPENDIX 2: RFID COMMUNICATION PROTOCOL.................................. 30

TagRunners – Communication Protocol v1.4 - 3 -
Data Capture
for Workforce
in Motion
Revision History
Revision HistoryRevision History
Revision History
Changes to the original manual are listed below.
Document Date Description
1.0 23 ec. 08 Initial release
1.2 23 ec. 08 Modified §2.2.1, 2.2.2.
Updated command 0x76 and 0xE0
Added command 0x E
1.3 23 ec. 08 Added Annex RFI protocol
1.4 23 ec. 08 Remove ProxRunner info

TagRunners – Communication Protocol v1.4 - 4 -
Data Capture
for Workforce
in Motion
1.
1.1.
1. Introduction
1.1.
1.1.1.1.
1.1. Generalities
GeneralitiesGeneralities
Generalities
TagRunners is a wireless RFI data capture product (13.56MHz).
This document is detailing the protocol of communication between the Baracoda TagRunners and its
foreign environment through Radio Frequency link (ie: Bluetooth).
Wireless communication is based on the Bluetooth protocol, thanks to the embedded Baracoda
Equinox Bluetooth Stack.
HF Tag reading / encoding capabilities are enabled thanks to a RFI antenna & decoder.
The messages described in this document can be:
-Host to scanner messages: the packet is sent only by the host to the scanner
-Scanner to host messages: the packet is sent only by the scanner to the host
-Bidirectional messages: the packet format is the same whether it is sent by the host or
the scanner
http://www.baracoda.com
1.2.
1.2.1.2.
1.2. Generic packet
Generic packetGeneric packet
Generic packet
All the frames described in this document are formatted as shown:
Code I
Length
Payload
1 Byte
2
Bytes
N Bytes
- 1 byte for code I
Bits 7:5 is the logical device
Bits 4:1 is the command
Bit 0: when set, the message must be acknowledged
- 2 bytes for the size of the payload (big-endian), including the sequence number byte which is
considered as part of the payload
- Payload (including 1 byte for sequence number when applicable).
The response will have the same code I as the command.

TagRunners – Communication Protocol v1.4 - 5 -
Data Capture
for Workforce
in Motion
2.
2.2.
2. Communication protocol
2.1.
2.1.2.1.
2.1. Bidirectional
Bidirectional Bidirectional
Bidirectional packets
packetspackets
packets
2.1.1. Control messages
2.1.1.1. Specific packets
Code I
escription
Frame
0x01
Legacy
0x01 0x01 0x01
Or
0x01 0x02 0x01
These two (2) sequences will be recognized and purged for backward compatibility with older
Baracoda products.
2.1.1.2. Acknowledgment packets
Code I
escription
Frame
0x06
ACK
0x06 0x01 0xYY
0x15
NACK
0x15 0x01 0xYY
These messages acknowledge the reception of a valid message with the expected sequence number
0xYY, before processing it.
For captured data from the scanner, ACK and NAK have the same meaning but will trigger a different
event on the scanner.
2.1.1.3. Synchronization packet
Code I
escription
Frame
0x16
SYN
0x16 0x01 0xYY
This message acknowledges the reception of a message to acknowledge with an unexpected
sequence number. 0xYY is the expected sequence number.
The device will resynchronize its remote sequence number when receiving this message.

TagRunners – Communication Protocol v1.4 - 6 -
Data Capture
for Workforce
in Motion
2.2.
2.2.2.2.
2.2. Scanner to hos
Scanner to hosScanner to hos
Scanner to host
tt
t messages
messagesmessages
messages
2.2.1. Encapsulation scheme
Code I
escription
Payload
0x34
–
0x3
5
FID
data
(TagID)
ATA
string
2.2.2. Data string format
Timestamp ata
Prefix
Capture
Prefix
Protocol
Identifier RFI data Capture suffix
ata
suffix
12 bytes
0
-
32
bytes 0-32 bytes 0-3 bytes -
0
-
32
bytes
0
-
32
bytes

TagRunners – Communication Protocol v1.4 - 7 -
Data Capture
for Workforce
in Motion
2. .
2. .2. .
2. . Host to
Host to Host to
Host to scanner
scannerscanner
scanner messages
messagesmessages
messages
2.3.1. Communication messages
Code I
0x40
-
0x41
escription
Get Communication Descriptor
Payload
None
Response
2 bytes:
{Wireless link: (Bit 0: Bluetooth)}
{Wired link: (Bit 0: Serial ock)}
Code I
0x42
-
0x43
escription
Get etransmission Parameters
Payload
None
Response
2 bytes:
{Max number of retransmission, 1 to 0xFE, 0xFF = infinity}
{ elay between transmission, 1 to 0xFF, in tenth of seconds}
Code I
0x44
-
0x45
escription
Set etransmission Parameters
Payload
2 bytes:
{Max number of retransmissions, 1 to 0xFE, 0xFF = infinity}
{ elay between transmissions, 1 to 0xFF, in tenth of seconds}
Response
1 byte:
{(Bit 0: Success)}
Code I
0x46
-
0x47
escription
Get Capture Frame Format
Payload
None
Response
1 byte
{0 = Baracoda, 1 = Baracoda + ACK, 2 = Raw}
Code I
0x48
-
0x49
escription
Set Capture Frame Format
Payload
1 byte
{0 = Baracoda, 1 = Baracoda + ACK, 2 = Raw}
Response
1 byte:
{Bit0: Success}

TagRunners – Communication Protocol v1.4 - 8 -
Data Capture
for Workforce
in Motion
Code I
0x50
-
0x51
escription
Lock/Unlock Scan engine
Payload
1 byte :
{0 = Unlock, 1 = Lock}
Response
1 byte : {Bit 0 : Success}
Code I
0x54
-
0x55
escription
Get/Set dock use
Payload
Get : None
Set : 1 byte :
{0 = isable communication via RS232 dock
1 = Enable}
Response
Get : 1 byte :
{0 = isable communication via RS232 dock
1 = Enable}
Set : 1 byte :
{Bit 0 : Success}
Code I
0x56
-
0x57
escription
Get/Set In charge behavior
Payload
Get : None
Set : 1 byte :
{shutdown timeout (0 = leave current timeouts (default), 255 = infinity)}
Response
Get : 1 byte :
{shutdown timeout (0 = leave current timeouts (default), 255 = infinity)}
Set : 1 byte :
{Bit 0 : Success}
Remarks
When
scanner in charge, the shutdown timers can be modified

TagRunners – Communication Protocol v1.4 - 9 -
Data Capture
for Workforce
in Motion
Code I
0x5A
-
0x5B
escription
Get/Set master mode
Payload
Get : None
Set : 1-2 byte(s) :
{1 : enable, 0 : disable}
[OPTIONAL]{1 : disconnect the scanner if connected}
Response
Get : 1 byte :
{1 : enabled
0 : disabled}
Set : 1 byte :
{Bit 0 : Success}
Code I
0x5E
-
0x5F
escription
Bluetooth Commands
Payload
{Code I } “Parameters”
Response
If the device responds: {Code I } “Response”
Else: {0}
Bluetooth specific commands from the Platform2 Bluetooth communication protocol are to be
framed within the payload of this message.

TagRunners – Communication Protocol v1.4 - 10 -
Data Capture
for Workforce
in Motion
2.3.2. Scanner messages
Code I
0x60
-
0x61
escription
Get Scanner Status
Payload
None
Response
2 bytes:
{(Bit 7: Upgrading) (Bit 1: ocked) (Bit 0: Charging)}
{Battery level, 0 to 100}
Code I
0x62
-
0x63
escription
Get Operating Mode
Payload
None
Response
1 byte:
{Bit 0 = 0:real time, Bit 0 = 1: batch}
{(Bit 7: limited)}
Remarks
“limited” means barcode buffer = 0 when in real time, no data loss mode and
disconnected
Code I
0x64
-
0x65
escription
Set Operating Mode
Payload
1 byte:
{Bit 0 = 0: real time, Bit 0 = 1: batch}
If real time mode is set :
{(Bit 7: limited)(Bit 6: ACK beep) (Bit 5: no ACK beep)}
NOTE : the ACK beep enable / disable is only effective when Capture Frame Format is
“Baracoda + ACK”
Response
1 byte:
{Bit 0: Success}
Remarks
Batch mode is not available for
-
Fly scanner
Code I
0x66
-
0x67
escription
Get Shutdown Timers
Payload
None
Response
2 bytes:
{Number of minutes before shutdown when connected, 1 to 0xFE,
0xFF = infinity}
{Number of minutes before shutdown when disconnected, 1 to 0xFE,
0xFF = infinity}
Code I
0x68
-
0x69
escription
Set Shutdown Timers
Payload
2 bytes:
{Number of minutes before shutdown when connected, 1 to 0xFE,
0xFF = infinity}

TagRunners – Communication Protocol v1.4 - 11 -
Data Capture
for Workforce
in Motion
{Number of minutes before shutdown when disconnected, 1 to 0xFE,
0xFF = infinity}
Response
1 byte:
{Bit 0: Success}
Code I
0x6A
-
0x6B
escription
Get TC time
Payload
None
Response
6 bytes:
{YY}{MM}{ }{HH}{MM}{SS}
Code I
0x6C
-
0x6
escription
Set TC time
Payload
6 bytes:
{YY}{MM}{ }{HH}{MM}{SS}
Response
1 byte:
{Bit 0: Success}
Code I
0x74
-
0x75
escription
estore defaults settings
Payload
None
Response
1 byte:
{Bit 0: Success}
Remarks
External Flash memory is also erased
Code I
0x76
-
0x77
escription
Get Product Version
Payload
None
Response
x bytes :
«Baracoda RRT…»
Code I
0x78
-
0x79
escription
Get Switching On Delay
Payload
None
Response
1 byte :
{1 = 0 second, 2 = 1 second, 3 = 2 seconds}
Code I
0x7A
-
0x7B
escription
Set Switching On Delay
Payload
1 byte :
{1 = 0 second, 2 = 1 second, 3 = 2 seconds}
Response
1 byte :
{Bit 0 :Success}

TagRunners – Communication Protocol v1.4 - 12 -
Data Capture
for Workforce
in Motion
2.3.3. User Interface messages
LE 1 : left LE
LE 0 : right LE
Code I
0x80
-
0x81
escription
Get MMI Descriptor
Payload
None
Response
2 bytes:
{(Bit 6: Blue LE 1)
(Bit 5: Red LE 1)
(Bit 4: Green LE 1)
(Bit 2: Blue LE 0)
(Bit 1: Red LE 0)
(Bit 0: Green LE 0)}
{(Bit 0: Buzzer)}
Code I
0x82
-
0x83
escription
Get
MMI Mode
Payload
None
Response
1 byte:
{(Bit 1: Buzzer Enabled) (Bit 0: LE s enabled)}
Code I
0x84
-
0x85
escription
Set MMI Mode
Payload
1 byte:
{(Bit 1: Buzzer Enabled) (Bit 0: LE s enabled)
(Bit 7 = 0:Buzzer config select, =1: Buzzer config deselect)(Bit 6 = 0:leds config select, =1:
leds config deselect)}
Response
1 byte: {(Bit 0: Success)}
Code I
0x86
-
0x87
escription
Get MMI Signal (User interface)
Payload
1 byte:
{Signal number, 0 - 3}
Response
(1 + 3n) bytes:
{Number of steps, 0 - 4}
For each step:
{(Bit 6: Blue LE 1) (Bit 5: Red LE 1) (Bit 4: Green LE 1) (Bit 2: Blue LE 0) (Bit 1: Red
LE 0) (Bit 0: Green LE 0)}
{Buzzer frequency, 0 – 0xFF * 50Hz = 0 – 12750Hz}
{ elay until next step, in tenth of seconds}

TagRunners – Communication Protocol v1.4 - 13 -
Data Capture
for Workforce
in Motion
Code I
0x88
-
0x89
escription
Set MMI Signal
Payload
(2 + 3n) bytes
{Signal number, 0 - 3}
{Number of steps, 0 - 4}
For each step:
{(Bit 6: Blue LE 1) (Bit 5: Red LE 1) (Bit 4: Green LE 1) (Bit 2: Blue LE 0) (Bit 1: Red
LE 0) (Bit 0: Green LE 0)}
{Buzzer frequency, 0 – 0xFF * 50Hz = 0 – 12750Hz}
{ elay until next step, in tenth of seconds}
Response
1 byte: {(Bit 0: Success)}
Code I
0x8A
-
0x8B
escription
Play Signal
Payload
2 bytes:
{Signal number, 0 - 3}
{Number of loops, 0 – 0xFE, 0xFF = infinity}
Response
1 byte: {(Bit 0: Success)}
Code I
0x8C
-
0x8
escription
Stop Signal
Payload
1 byte:
{Signal number, 0 – 3}
Response
1 byte:
{(Bit 0: Success)}
The list of MMI signals is:
IHM_SIGNAL_CAPTURE_REA : 0
IHM_SIGNAL_CAPTURE_ACK : 1
IHM_SIGNAL_CAPTURE_NAK : 2
IHM_SIGNAL_CAPTURE_LOST : 3
IHM_SIGNAL_USER_ EFINE : 13
Code I
0x92
-
0x93
escription
Get Beeps mode
Payload
Response
1 byte:
{(Bit 0: Beep level 0=low, 1=high)
(Bit 1: Read beep)
(Bit 2: ACK beep)}

TagRunners – Communication Protocol v1.4 - 14 -
Data Capture
for Workforce
in Motion
Code I
0x94
-
0x95
escription
Set Beeps mode
Payload
1 byte:
{(Bit 0: Beep level; 0=low, 1=high)
(Bit 1: Read beep)
(Bit 2: ACK beep)
(Bit 7 = 0: ACK beep config select, =1: ACK beep config deselect)
(Bit 6 = 0: Read beep config select, =1: Read beep config deselect)
(Bit 5 = 0: Beep level config select, =1: Beep level config deselect)}}
Response
1 byte:
{(Bit 0: Success)}

TagRunners – Communication Protocol v1.4 - 15 -
Data Capture
for Workforce
in Motion
2.3.4. Miscellaneous messages
Code I
0xC2
-
0xC3
escription
Get/Set DataPrefix
Payload
Get : None
Set : 1-33 bytes:
{ ataPrefix length}
“ ataPrefix String”
Response
Get : 1
-
33 bytes:
{ ataPrefix length}
“ ataPrefix String”
Set : 1 byte:
{Success?}
Code I
0xC4
-
0xC5
escription
Get/Set DataSuffix
Payload
Get : None
Set : 1-33 bytes:
{ ataSuffix length}
“ ataSuffix String”
Response
Get : 1
-
33
bytes:
{ ataSuffix length}
“ ataSuffix String”
Set : 1 byte:
{Success?}
Code I
0xC6
-
0xC7
escription
Get/Set Data Format 2
Payload
Get : None
Set : 1 byte:
{(Bit 5 = 0: ataPrefix config select, =1: ataPrefix config deselect)
(Bit 4 = 0: ataSuffix config select, =1: ataSuffix config deselect)
(Bit 1: ataPrefix)
(Bit 0: ataSuffix)
Response
Get : 1 byte:
{(Bit 1: ataPrefix)
(Bit 0: ataSuffix)}
Set : 1 byte:
{(Bit 0:Success)}
Code I
0xC8
-
0xC9
escription
Get / Set
FID
data
length
Payload
Get : None

TagRunners – Communication Protocol v1.4 - 16 -
Data Capture
for Workforce
in Motion
Set : 2 bytes
{authorized RFI data length. 0 = disabled}
Response
Get : 2 bytes
{authorized RFI data length. 0 = disabled}
Set : 1 byte
{(Bit 0:Success)}
Code I
0xCA
-
0xCB
escription
Get and erase stored
data
with no data loss mode
Payload
None
Response
1 byte
{(Bit 0:Success)}
Code I
0xCC
-
0xC
escription
es
et modes
Payload
None = restore defaults, keep link keys, reboot scanner
1byte :
0 = restore defaults, keep link keys, reboot scanner
1 = switch off scanner (no restoring defaults)
2 = reboot scanner (no restoring defaults)
Response
1 byte
{(Bit 0:Success)}
Code I
0xCE
-
0xCF
escription
Batch upload commands
Payload
{Code I } “Parameters” (cf. below)
Response
{Code
I } “Response”
The UPLOA Code I s are:
Code I
0
escription
Launch upload process (typically used only for the upload barcode)
Payload
1 byte:
{0 mandatory}
Response
1 byte:
{Bit 0: Success}
Code I
1
escription
Ready to start upload (Scanner
to host message)
Payload
3 bytes :
{0 mandatory}
{ number of elements to be uploaded MSB }
{ number of elements to be uploaded LSB }
Response
None

TagRunners – Communication Protocol v1.4 - 17 -
Data Capture
for Workforce
in Motion
Code I
2
escription
Start uploading
data
Payload
1 byte:
{0 mandatory}
Response
1 byte:
{Bit 0: Success}
Code I
3
escription
RESERVE
Payload
N/A
Response
N/A
Code I
4
escription
Set upload status and end process
Payload
2 bytes :
{0 mandatory}
{1 : upload successful, data can be erased from the scanner
0 : upload failed, do not erase data}
Response
1 byte:
{Bit 0: Success}
Code I
0x 2
-
0x 3
escription
Get/Set Anti duplicate scans
Payload
Get : None
Set : 1 byte
{0 = disabled
1 = no consecutive duplicate scans + error signal
2 = no consecutive duplicate scans + no decoding}
Response
Get : 1 byte
{0 = disabled
1 = no consecutive duplicate scans + error signal
2 = no consecutive duplicate scans + no decoding }
Set : 1 byte
{(Bit 0:Success)}
Comments
The comparison
will be made over the 32 first characters of the barcodes only.
Code I
0x 4
-
0x 5
escription
estore last batch
Payload
None
or 1 byte (optional):
{1 = upload data after retrieving}
Response
1 byte:
{(Bit 0:Success)}
Comments
This is only
available if no new scan has been made.

TagRunners – Communication Protocol v1.4 - 18 -
Data Capture
for Workforce
in Motion
Code I
0x 8
-
0x 9
escription
Enable remote trigger
Payload
None : use default 5s timeout
1 byte : {timeout (s)}
Response
1 byte
{(Bit 0:Success)}
Code I
0x E
-
0x F
escription
FID commands
Payload
{Code
I } “Parameters
”
Response
{Code I } “Response”
RFI specific commands from the Platform2 RFI communication protocol are to be framed within
the payload of this message.

TagRunners – Communication Protocol v1.4 - 19 -
Data Capture
for Workforce
in Motion
2.3.5. Capture messages
Code I
0xE2
-
0xE3
escription
Get Mode
Payload
None
Response
1 byte:
{0 = trigger, 1 = smart autoscan, 2 = disabled, 3= autoscan }
Code I
0xE4
-
0xE5
escription
Set Mode
Payload
1 byte OR
2 bytes if aiming trigger scan mode
{0 = trigger, 1 = smart autoscan, 2 = disabled, 3= autoscan, 4=aiming trigger scan}
{aiming trigger scan mode timeout value in second}
Response
1 byte:
{(Bit 0: Success)}
Code I
0xE6
-
0xE7
escription
Get Data Format
Payload
None
Response
1 byte:
{(Bit 2:Timestamp)
(Bit 1: Capture Prefix)
(Bit 0: Capture Suffix)}
Code I
0xE8
-
0xE9
escription
Set Data Format
Payload
1 byte:
{(Bit 7 = 0: Timestamp config select, =1: Timestamp config deselect)
(Bit 6 = 0: Capture Prefix config select, =1: Capture Prefix config deselect)
(Bit 5 = 0: Capture Suffix config select, =1: Capture Suffix config deselect)
(Bit 2:Timestamp)
(Bit 1: Capture Prefix)
(Bit 0: Capture Suffix) }
Response
1 byte:
{(Bit 0:Success)}
Code I
0xEA
-
0xEB
escription
Get
Capture
Prefix
Payload
None
Response
1
-
33 bytes:
{ Capture Prefix length}
“Capture Prefix String”

TagRunners – Communication Protocol v1.4 - 20 -
Data Capture
for Workforce
in Motion
Code I
0xEC
-
0xE
escription
Set
Capture
Prefix
Payload
1
-
33 bytes:
{ Capture Prefix length}
“Capture Prefix String”
Response
1 byte:
{(Bit 0:Success)}
Code I
0xEE
-
0xEF
escription
Get
Capture
Suffix
Payload
None
Response
1
-
33
bytes:
{ Capture Suffix length}
“Capture Suffix String”
Code I
0xF0
-
0xF1
escription
Set
Capture
Suffix
Payload
1
-
33 bytes:
{ Capture Suffix length}
“Capture Suffix String”
Response
1 byte:
{(Bit 0:Success)}
Code I
0xF4
-
0xF5
escription
Set
Timestamp
Payload
6 bytes:
{YY}{MM}{ }{HH}{MM}{SS}
Response
1 byte:
{Bit 0: Success}
Code I
0xF8
-
0xF9
escription
Get stored
data
count
Payload
None
Response
2 bytes:
{Stored barcodes count [15:8]}
{Stored barcodes count [7:0]}
Code I
0xFC
-
0xF
escription
Erase stored
data
Payload
None
Response
1 byte:
{(Bit 0:Success)}