Baracoda BDRS01 User manual

RS232 dongle Plug & Scan
Communication Protocol
©
Baracoda
RS232 dongle Plug & Scan
Communication Protocol
Baracoda
TM
– August 2008
Data Capture
for Workforce
in Motion
RS232 dongle Plug & Scan

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 2 -
Data Capture
for Workforce
in Motion
SUMMARY
SUMMARYSUMMARY
SUMMARY
SUMMARY................................................................... 2
REVISION HISTORY.......................................................... 3
1. INTRODUCTION ...................................................... 4
1.1. G ENERALITIES ........................................................ 4
1.2. G ENERIC PACKET ...................................................... 5
1.2.1. RS232 ..................................................... 5
1.2.2. B LUETOOTH ................................................... 5
2. COMMUNICATION PROTOCOL ......................................... 5
2.1. D ONGLE TO HOST MESSAGES ............................................ 5
2.1.1. G ET VERSION ................................................. 6
2.1.2. C OMMAND RESPONSES ............................................ 6
2.1.3. I N MODE 0 (S TANDARD P LUG &S CAN ) ................................ 6
2.1.4. I N MODE 1 (T RANSPARENT P LUG &S CAN ) .............................. 6
2.2. HOST TO D ONGLE MESSAGES ............................................ 7
2.2.1. C OMMUNICATION MESSAGES ........................................ 7

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 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
3.27 6 Aug 8 Initial release
3.27.1 2 Aug 8 updated command xFF details

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 4 -
Data Capture
for Workforce
in Motion
1.
1.1.
1. Introduction
1.1.
1.1.1.1.
1.1. Generalities
The Plug&Scan solution enables a simple, reliable and efficient use of its compatible barcode readers
(the whole Baracoda product range) thanks to Bluetooth. The RS232 version allows the connection
on any RS232 enabled terminal.
The dongle allows a simple and secure Bluetooth connection: just scan the « connect barcode » (on
the dongle) and the scanner gets connected and ready to operate.
The dongle is compatible with the whole product range, and with a certain number of them, is able
to automatically configure them after the connection.
The messages described in this document can be:
Host to dongle messages: the packet is sent only by the host to the dongle
Dongle to host messages: the packet is sent only by the dongle to the host
Scanner
RS232 dongle
Host

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 5 -
Data Capture
for Workforce
in Motion
1.2.
1.2.1.2.
1.2. Generic pac et
The dongle will parse data respecting a specific format.
1.2.1.
1.2.1.1.2.1.
1.2.1. RS232
RS232RS232
RS232
All the frames incoming to the RS232 dongle are formatted as shown:
Header
Code ID
Length
Payload
4 bytes
1 byte
2 bytes
N byte(s)
Frames sent by the dongle via its RS232 link can have other formats.
1.2.1.1.
1.2.1.1.1.2.1.1.
1.2.1.1. Header
HeaderHeader
Header
The 4 bytes for the header are always the same: 3C 3A 3F 3E for “<:?>”
1.2.1.2.
1.2.1.2.1.2.1.2.
1.2.1.2. Code ID
Code IDCode ID
Code ID
The Code ID, encoded on 1 byte, corresponds to the command to send.
Cf. §2 for complete list of code IDs.
1.2.1.3.
1.2.1.3.1.2.1.3.
1.2.1.3. Length
LengthLength
Length
Depending on the selected code ID the payload length may vary (from to 65535 bytes), its length is
specified on the 2 bytes of the « length » field.
1.2.1.4.
1.2.1.4.1.2.1.4.
1.2.1.4. Pay oad
Pay oadPay oad
Pay oad
For the « get » commands, no payload is required since the dongle responds with the requested
data. The specified length in the « length » field is then and no byte constitute the payload. When
the sent command is a « set » command, the dongle parses and treats the command if its format is
correct but does not answer.
1.2.2.
1.2.2.1.2.2.
1.2.2. B uetooth
B uetoothB uetooth
B uetooth
All the commands described in this document can also be sent via Bluetooth thanks to a Baracoda
barcode scanner by scanning configuration barcodes
Commands respecting the above format can be encoded into Code128 barcodes.
2.
2.2.
2. Communication protocol
2.1.
2.1.2.1.
2.1. Dongle to HOST messages
Data coming from the dongle can have different formats depending on the mode it is running.

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 6 -
Data Capture
for Workforce
in Motion
2.1.1.
2.1.1.2.1.1.
2.1.1. Get version
Get versionGet version
Get version
The response to a “Get version” command (CodeID x76) is sent raw via RS232.
2.1.2.
2.1.2.2.1.2.
2.1.2. Command responses
Command responsesCommand responses
Command responses
When applicable (if the dongle is supposed to respond to a command, except the “Get Version”
command), the dongle responds using the frame format described in §1.2.1.
2.1.3.
2.1.3.2.1.3.
2.1.3. In
InIn
In mode 0 (Standard P
mode 0 (Standard Pmode 0 (Standard P
mode 0 (Standard P ug
ugug
ug&S
&S&S
&Scan
cancan
can)
))
)
In mode , all other incoming data is raw barcode data gathered by the barcode scanner.
2.1.4.
2.1.4.2.1.4.
2.1.4. In mode 1 (Transparent
In mode 1 (Transparent In mode 1 (Transparent
In mode 1 (Transparent P ug&Scan
P ug&ScanP ug&Scan
P ug&Scan)
))
)
In mode 1, all other incoming data is directly sent by the scanner, without any intervention from the
dongle.

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 7 -
Data Capture
for Workforce
in Motion
2.2.
2.2.2.2.
2.2. HOST to Dongle messages
2.2.1.
2.2.1.2.2.1.
2.2.1. Communication messages
Communication messagesCommunication messages
Communication messages
Code ID x 2
Command Disconnect
Description Disconnect scanner from dongle and do not auto reconnect to it
Payload None
Response None
Code ID x 8
Command Set prefix
Description Defines (and enable) a prefix
Payload -8 byte(s):
{ prefix (default : none)}
If no payload, prefix is disabled.
Response None
Code ID x a
Command Set suffix
Description Defines (and enable) a suffix
Payload -8 byte(s):
{ suffix (default : none)}
If no payload, prefix is disabled.
Response None
Code ID x1a
Command Reboot
Description Reboots the dongle
Payload None
Response None
Code ID x1b
Command Forward
Description Forward message to connected device
Payload x byte(s):
{ message }
Response None

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 8 -
Data Capture
for Workforce
in Motion
Code ID x29
Command Set UART parameters
Description Sets the UART parameters (BaudRate, parity, stop bits).
Payload 4 bytes:
{ Baud rate (MSB) | Baud rate (LSB) | Stop Bits | Parity Bits }
Response None
Available settings are:
Baud Rate alue
Don’t change x
9 6 (default) x 27
19 2 x 4F
38 4 x 9D
57 6 x EC
115 2 x 1D8
23 4 x 3B
46 8 x 75F
921 6 x EBF
1 382 4 x161E
Parity alue
Same x 3
None (default) x
Odd x 1
Even x 2
Stop bits alue
Same x 2
One (default) x
Two x 1

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 9 -
Data Capture
for Workforce
in Motion
Code ID x31
Command Set Upload messages use
Description Enable/Disable use of upload messages
Payload 1 byte:
{ 1 : Enable
: Disable (default)}
Response None
Code ID x4b
Command Set Ack mode
Description Configure the dongle with the setting to give to the scanners at
auto configuration step.
Payload 1 byte:
{ : Real Time, without no data loss mode
1 : Real Time, with no data loss mode (default)
2 : Batch mode (if supported by scanner)}
Response None
Code ID Exception
Command Reset dongle
Description Resets the default dongle’s settings.
WARNING: this command does not respect the standard frame
format : there is no length field :
“<:?>Rst” should be sent (or in hexa : 3C 3A 3F 3E 52 73 74)
Payload N/A
Response None
Code ID x76
Command Get ersion
Description Get the dongle’s firmware version
Payload None
Response (The response follows the protocol format)
18 bytes : “Baracoda P&S 3.xx” 3.xx being the version

RS232 dongle Plug & Scan – Communication Protocol v3.27.1 - 1 -
Data Capture
for Workforce
in Motion
Code ID xFE
Command Event messages
Description These are dongle to host messages. These inform the host about
some events concerning the dongle’s operation.
Payload 1 to N Bytes :
{Event ID}
{N-1 bytes, depending on the event ID}
Response None
Event IDs:
Event ID x
Event Connection message
Description This event is sent to the host 1,6s after the connection, when the
auto configuration is done.
Payload 6 bytes :
The 6 bytes of the connected scanner’s BDA
Response None
Event ID x 1
Event Disconnection message
Description This event is sent to the host when a disconnection occurs with
the connected scanner (except when it occurs from a hard switch
off of the dongle.
Payload None
Response None
Code ID xFF
Command Get/Set Dongle mode
Description Get or set (depending on the length provided with the command)
the dongle’s mode.
Payload GET : byte
SET : 1 byte:
{ mode :
= standard P&S mode (default)
1 = transparent}
Response GET : 1 byte:
{ mode :
= standard P&S mode (default)
1 = transparent}
SET : None