Baracoda Barcode Reader User Manual

Communication Protocol

©Baracoda TM – March. 2010

DualRunners

Data Capture for Workforce

in Motion

SUMMARY

SUMMARYSUMMARY

Data Capture

for Workforce

in Motion

SUMMARY ................................................................... 2

REVISION HISTORY .......................................................... 4

1.

1.1.

1.1. G

1.2. G

2.

2.2.

2.1. B

2.1.1. C

2.2. S

2.2.1. E

2.2.2. D

2.3. H

2.3.1. C

2.3.2. S

2.3.3. U

2.3.4. M

2.3.5. C

2.3.6. A

2.4. D

2.4.1.

2.4.2. H

2.4.3. T

2.4.4. S

2.4.5. C

2.4.6. E E E E E E

INTRODUCTION ........................................................ 5

ENERALITIES ENERIC PACKET

COMMUNICATION PROTOCOL .............................................. 6

IDIRECTIONAL PACKETS

ONTROL MESSAGES

CANNER TO HOST MESSAGES

NCAPSULATION SCHEMA ATA STRING SCHEMA

OST TO SCANNER MESSAGES

OMMUNICATION MESSAGES CANNER MESSAGES SER INTERFACE MESSAGES ISCELLANEOUS MESSAGES APTURE MESSAGES DVANCED CAPTURE MESSAGES

ECODER COMMUNICATION PROTOCOL

FRAME FORMAT

EADER YPE IZE OMMAND

XAMPLES XAMPLE XAMPLE XAMPLE XAMPLE XAMPLE

1.1 – G

2.1 – S

2.2 – S

3.1 – M

4.1 – S

.......................................................... 5

........................................................ 5

................................................... 6

.............................................. 6

................................................ 7

........................................... 7

............................................ 7

................................................ 8

......................................... 8

............................................. 10

....................................... 12

........................................ 15

............................................. 19

..................................... 22

.......................................... 24

................................................ 24

..................................................... 24

....................................................... 25

.................................................... 25

................................................... 33

ETTING CONFIGURATION OF CODE 39 SYMBOLOGY ETTING A CONFIGURATION OF CODABAR SYMBOLOGY ETTING A CONFIGURATION OF ALL SYMBOLOGIES ODIFYING A CONFIGURATION OF ALL SYMBOLOGIES ENDING A SPECIAL COMMAND TO CODE39 SYMBOLOGY

. ................. 33

. ................ 34

. .................. 35

. ................ 35

. ............... 36

APPENDIX 1: BLUETOOTH PROTOCOL ........................................... 37

APPENDIX 2: RFID COMMUNICATION PROTOCOL .................................. 46

APPENDIX 3: RFID TAG DATA READ/WRITE EXAMPLES ............................ 54

(FOR BLACKBERRY, SYMBIAN & JAVA PLATFORMS) ............................... 54

1. INTRODUCTION .......................................................... 54

1.1 G

2.

2.2.

ENERALITIES

MIFARE ULTRALIGHT TAGS ............................................. 55

........................................................... 54

DualRunners – Communication Protocol v1.3 - 2 -

2.1 T

AG MEMORY STRUCTURE

2.2 R

EADING TAG DATA

2.3 W

RITING TAG DATA

Data Capture

for Workforce

in Motion

..................................................... 55

........................................................ 55

........................................................ 57

3. MIFARE 1K TAGS ........................................................ 59

3.1 T

AG MEMORY STRUCTURE

3.2 R

EADING TAG DATA

3.3 W

RITING TAG DATA

4.

4.4.

4.1 T

4.2 R

4.3 W

5.

5.5.

5.1 T

5.2 R

5.3 W

6.

6.6.

6.1 T

6.2 R

6.3 W

MIFARE 4K TAGS ..................................................... 63

AG MEMORY STRUCTURE EADING TAG DATA RITING TAG DATA

TAG-IT HF-I PLUS INLAY TAGS ........................................ 68

AG MEMORY STRUCTURE EADING TAG DATA RITING TAG DATA

TAG-IT HF-I PLUS CHIP TAGS ......................................... 72

AG MEMORY STRUCTURE EADING TAG DATA RITING TAG DATA

..................................................... 59

........................................................ 59

........................................................ 61

..................................................... 63

........................................................ 63

........................................................ 66

..................................................... 68

........................................................ 68

........................................................ 70

..................................................... 72

........................................................ 72

........................................................ 74

7.

7.7.

7.1 T

7.2 R

7.3 W

8.

8.8.

8.1 T

8.2 R

8.3 W

I-CODE SLI TAGS .................................................... 76

AG MEMORY STRUCTURE EADING TAG DATA RITING TAG DATA

I-CODE SLI-S TAGS .................................................. 80

AG MEMORY STRUCTURE EADING TAG DATA RITING TAG DATA

..................................................... 76

........................................................ 76

........................................................ 78

..................................................... 80

........................................................ 80

........................................................ 82

DualRunners – Communication Protocol v1.3 - 3 -

Revision History

Revision HistoryRevision History

Changes to the original manual are listed below.

Document Date Description

Data Capture

for Workforce

in Motion

1.0 20 March 09

1.1 27 march 09 Add comments on 0xDA command

1.2 18 sept. 09 Add Appendix 3 “RFID tag data read/write examples’

1.3 15 March. 10

Initial release

Changed 2.2.1 : add 0x36-0x37 cmd Add 2.3.6 “Advanced Capture messages”

DualRunners – Communication Protocol v1.3 - 4 -

Data Capture

Code ID

Length

Payload

1

Byte

2 Bytes

N Bytes

for Workforce

1.

1.1.

DualRunners is a wireless data capture product. This document is detailing the protocol of communication between the Baracoda scanner 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. Data capture capabilities are :

The messages described in this document can be:

Introduction

1.1.

1.1. Generalities

1.1.1.1.

- Barcode reading capabilities are enabled thanks to a CMOS technology (1D & 2D) or laser

(1D).

- HF Tag reading / encoding capabilities are enabled thanks to a RFID antenna & decoder.

- 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

Generalities

GeneralitiesGeneralities

http://www.baracoda.com

in Motion

1.2.

1.2. Generic packet

1.2.1.2.

All the frames described in this document are formatted as shown:

- 1 byte for code ID 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 ID as the command.

Generic packet

Generic packetGeneric packet

DualRunners – Communication Protocol v1.3 - 5 -

Data Capture

Code ID

Descriptio

n Frame

0x01

Legacy

0x01 0x01 0x01

Code ID

Description

Frame

0x06

ACK 0x06 0x01 0xYY

0x15

NACK

0x15

0x01 0xYY

Code ID

Description

Frame

0x16

SYN 0x16 0x01 0xYY

for Workforce

2.

2.2.

Communication protocol

2.1.

2.1. Bidirectional

2.1.2.1.

Bidirectional packets

Bidirectional Bidirectional

packets

packetspackets

2.1.1. Control messages

2.1.1.1. Specific packets

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

in Motion

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

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.

DualRunners – Communication Protocol v1.3 - 6 -

Code ID

Description

Payload

0x32

–

0x33

Barcode dat a

DATA

string

Code ID

Description

Payload

0x34

–

0x35

RFID

TagID

data

DATA

string

Code ID

Description

Payload

0x36-

0x37

Image(o r Si g nature)

data

n bytes :

2.2.

2.2. Scanner to hos

2.2.2.2.

Scanner to hostttt messages

Scanner to hosScanner to hos

2.2.1. Encapsulation schema

messages

messagesmessages

1st byte : packet type flag

- 0 = start : fragmented packet

- 1 = start: non fragmented

- 2 = continued packet

- 3 = last packet (End Of Body)

(n-1) bytes : packet data

remark : packet max size = 3000 bytes

Data Capture

for Workforce

in Motion

packet

2.2.2. Data string schema

Symbology /Protocol *** Prefix

AIM/Protocol** Identifier

Nature of data*

1 byte

Timestamp Data Prefix

12 bytes 0-32 bytes 0-32 bytes 0-4 bytes 0, 2 or 3 bytes - 0-4 bytes

Capture Prefix

Nota :

* Nature Of Data byte is available only for DualRunners scanner (to identify if data is RFID TagID or Barcode), by default this field is disabled. If enabled, Nature of data value is: 0x30 for Barcode and 0x31 for RFID TagID.

** These fields can be Symbology AIM if captured data is Barcode and RFID Protocol identifier if captured data is RFID TagID.

*** These fields can be Symbology prefix/suffix if captured data is Barcode and RFID Protocol prefix/suffix if captured data is RFID TagID.

Barcode / RFID TagID data

Symbology /Protocol*** suffix

Capture suffix

0-32 bytes

Data suffix

0-32 bytes

DualRunners – Communication Protocol v1.3 - 7 -

Code ID

0x40

-

0x41

Description

Get Comm un i ca t ion Desc r i pt or

Payload

None

Response

2 bytes:

Code ID

0x42

-

0x43

Description

Get Retr a ns m i ssion Pa r a me t ers

Payload

None

Response

2 bytes:

Code ID

0x44

-

0x45

Description

Set Ret r a ns m ission P a ra m e ters

Payload

2 bytes:

Response

1 byte:

Code ID

0x46

-

0x47

Description

Get Ca p t u re F ra m e Fo rm a t

Payload

None

Response

1 byte

Code ID

0x48

-

0x49

Description

Set Capt u re Fr am e Format

Payload

1 byte

Response

1 byte:

2.3.

2.3. Host to

2.3.2.3.

Host to scanner

Host to Host to

2.3.1. Communication messages

{Wireless link: (Bit 0: Bluetooth)} {Wired link: (Bit 0: Serial Dock)}

{Max number of retransmission, 1 to 0xFE, 0xFF = infinity} {Delay between transmission, 1 to 0xFF, in tenth of seconds}

scanner messages

scannerscanner

messages

messagesmessages

Data Capture

for Workforce

in Motion

{Max number of retransmissions, 1 to 0xFE, 0xFF = infinity} {Delay between transmissions, 1 to 0xFF, in tenth of seconds}

{(Bit 0: Success)}

{0 = Baracoda, 1 = Baracoda + ACK, 2 = Raw}

{Bit0: Success}

DualRunners – Communication Protocol v1.3 - 8 -

Data Capture

Code ID

0x50

-

0x51

Description

Lock/Unl o c k Data c a pt ur e m odule

(ie : S can e ng i n e, RFIDde co d e r board)

Payload

1 byte :

Response

1 byte :

{Bit 0 : Success}

Code ID

0x52

-

0x53

Description

Disable B a rc ode Prog r am m in g Functional i ty

Payload

1 byte :

Response

1 byte : {Bit 0 : Success}

Code ID

0x56

-

0x57

Description

Get/Set I n

charge be ha v i or

Payload

Get : None

Response

Get : 1 byte :

Remarks

When scanner in charge, the shutdown timers can be modified

Code ID

0x5A

-

0x5B

Description

Get/Set m ast er mode

Payload

Get : None

Response

Get : 1 byte :

Code ID

0x5E

-

0x5F

Description

Bluetoot h Command s

Payload

{Code ID} “Parameters”

Response

If the device responds: {Code ID} “Response”

for Workforce

{0 = Unlock, 1 = Lock}

{1 = Disable barcode programming functionality, 0 = Enable}

in Motion

Set : 1 byte :

{shutdown timeout (0 = leave current timeouts (default), 255 = infinity)}

Set : 1 byte :

{Bit 0 : Success}

Set : 1-2 byte(s) :

{1 : enable, 0 : disable} [OPTIONAL]{1 : disconnect the scanner if connected}

{1 : enabled 0 : disabled}

Set : 1 byte :

{Bit 0 : Success}

Else: {0}

Bluetooth specific commands from the Platform2 Bluetooth communication protocol are to be framed within the payload of this message.

DualRunners – Communication Protocol v1.3 - 9 -

Code ID

0x60

-

0x61

Description

Get Sca n n er S t at us

Payload

None

Response

2 bytes:

Code ID

0x62

-

0x63

Description

Get Ope r a t ing Mode

Payload

None

Response

1 byte:

Remarks

“limited” means barcode buffer = 0 when in real time, no data

loss mode and

Code ID

0x64

-

0x65

Description

Set Oper a ti n g Mode

Payload

1 byte:

Response

1 byte:

Remarks

Batch mode is not available for D

-

Fly scanner

Code ID

0x66

-

0x67

Description

Get Shut d ow n T i mers

Payload

None

Response

2 bytes:

Code ID

0x68

-

0x69

Description

Set Shut d ow n T im ers

Payload

2 bytes:

2.3.2. Scanner messages

{(Bit 7: Upgrading) (Bit 1: Docked) (Bit 0: Charging)} {Battery level, 0 to 100}

{Bit 0 = 0:real time, Bit 0 = 1: batch} {(Bit 7: limited)}

Data Capture

for Workforce

in Motion

disconnected

{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”

{Bit 0: Success}

{Number of minutes before shutdown when connected, 1 to 0xFE, 0xFF = infinity} {Number of minutes before shutdown when disconnected, 1 to 0xFE, 0xFF = infinity}

{Number of minutes before shutdown when connected, 1 to 0xFE, 0xFF = infinity}

DualRunners – Communication Protocol v1.3 - 10 -

Data Capture

{Number of minutes before shutdown when disconnected, 1 to 0xFE,

Response

1 byte:

Code ID

0x6A

-

0x6B

Description

Get RTC t im e

Payload

None

Response

6 bytes:

Code ID

0x6C

-

0x6D

Description

Set RTC t i me

Payload

6 bytes:

Response

1 byte:

Code ID

0x74

-

0x75

Description

Restore de f au l ts se tt i ngs

Payload

None

Response

1 byte:

Remarks

External Flash memory is also erased

Code ID

0x76

-

0x77

Description

Get Pro d uc t Ve rsi on

Payload

None

Response

x bytes :

Code ID

0x78

-

0x79

Description

Get Swit c hi ng On Delay

Payload

None

Response

1

byte :

Code ID

0x7A

-

0x7B

Description

Set Switc hi ng On D e la y

Payload

1 byte :

Response

1 byte :

for Workforce

0xFF = infinity}

{Bit 0: Success}

{YY}{MM}{DD}{HH}{MM}{SS}

in Motion

{Bit 0: Success}

«Baracoda RRD…» for DualRunners product

{1 = 0 second, 2 = 1 second, 3 = 2 seconds}

{Bit 0 :Success}

DualRunners – Communication Protocol v1.3 - 11 -

Code ID

0x80

-

0x81

Description

Get MMI D e sc ri pt or

Payload

None

Response

2 bytes:

Code ID

0x82

-

0x83

Description

Get MMI M ode

Payload

None

Response

1 byte:

Code ID

0x84

-

0x85

Description

Set MMI Mo d e

Payload

1 byte:

Response

1 byte: {(Bit 0: Success)}

Code ID

0x86

-

0x87

Description

Get MMI S ig na l (User i n t e rf ac e)

Payload

1 byte:

Response

(1 + 3n)

bytes:

Code ID

0x88

-

0x89

Description

Set MMI S i gn al

Payload

(2 + 3n) bytes

2.3.3. User Interface messages

LED 1 : left LED LED 0 : right LED

{(Bit 6: Blue LED 1) (Bit 5: Red LED 1) (Bit 4: Green LED 1) (Bit 2: Blue LED 0) (Bit 1: Red LED 0) (Bit 0: Green LED 0)} {(Bit 0: Buzzer)}

Data Capture

for Workforce

in Motion

{(Bit 1: Buzzer Enabled) (Bit 0: LEDs enabled)}

{(Bit 1: Buzzer Enabled) (Bit 0: LEDs enabled) (Bit 7 = 0:Buzzer config select, =1: Buzzer config deselect)(Bit 6 = 0:leds config select, =1: leds config deselect)}

{Signal number, 0 - 3}

{Number of steps, 0 - 4} For each step: {(Bit 6: Blue LED 1) (Bit 5: Red LED 1) (Bit 4: Green LED 1) (Bit 2: Blue LED 0) (Bit 1: Red LED 0) (Bit 0: Green LED 0)} {Buzzer frequency, 0 – 0xFF * 50Hz = 0 – 12750Hz} {Delay until next step, in tenth of seconds}

DualRunners – Communication Protocol v1.3 - 12 -

Data Capture

{Signal number, 0

- 3}

Response

1 byte: {(Bit 0: Success)}

Code ID

0x8A

-

0x8B

Description

Play Sig n al

Payload

2 bytes:

Response

1 byte: {(Bit 0: Success)}

Code ID

0x8C

-

0x8D

Description

Stop Si g n al

Payload

1 byte:

Response

1 byte:

for Workforce

{Number of steps, 0 - 4} For each step: {(Bit 6: Blue LED 1) (Bit 5: Red LED 1) (Bit 4: Green LED 1) (Bit 2: Blue LED 0) (Bit 1: Red LED 0) (Bit 0: Green LED 0)} {Buzzer frequency, 0 – 0xFF * 50Hz = 0 – 12750Hz} {Delay until next step, in tenth of seconds}

{Signal number, 0 - 3} {Number of loops, 0 – 0xFE, 0xFF = infinity}

in Motion

{Signal number, 0 – 3}

{(Bit 0: Success)}

The list of MMI signals is: IHM_SIGNAL_CAPTURE_READ : 0 IHM_SIGNAL_CAPTURE_ACK : 1 IHM_SIGNAL_CAPTURE_NAK : 2 IHM_SIGNAL_CAPTURE_LOST : 3 IHM_SIGNAL_USER_DEFINED : 13

DualRunners – Communication Protocol v1.3 - 13 -

Data Capture

Code ID

0x92

-

0x93

Description

Get Beep s m od e

Payload

Response

1 byte:

Code ID

0x94

-

0x95

Description

Set Bee p s m ode

Payload

1 byte:

Response

1 byte:

for Workforce

{(Bit 0: Beep level 0=low, 1=high) (Bit 1: Read beep) (Bit 2: ACK beep)}

{(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)}}

in Motion

{(Bit 0: Success)}

DualRunners – Communication Protocol v1.3 - 14 -

Code ID

0xC2

-

0xC3

Description

Get/Set D at a Prefix

Payload

Get : None

Response

Get : 1

-

33 bytes:

Remarks

Configure value of ‘DataPrefix’

Code ID

0xC4

-

0xC5

Description

Get/Set D at a Suffix

Payload

Get : None

Response

Get : 1

-

33 bytes:

Remarks

Configure value of ‘Data

Suf

fix’

Code ID

0xC6

-

0xC7

Description

Get/Set D at a F ormat 2

Payload

Get :

None

Response

Get : 1 byte:

Remarks

Enable, disable the adding of ‘Data Prefix’ and ‘Data Suffix’

2.3.4. Miscellaneous messages

Set : 1-33 bytes:

{ DataPrefix length} “DataPrefix String”

Set : 1 byte:

{Success?}

Data Capture

for Workforce

in Motion

Set : 1-33 bytes:

{ DataSuffix length} “DataSuffix String”

Set : 1 byte:

{Success?}

Set : 1 byte: {(Bit 5 = 0: DataPrefix config select, =1: DataPrefix config deselect) (Bit 4 = 0: DataSuffix config select, =1: DataSuffix config deselect) (Bit 1: DataPrefix) (Bit 0: DataSuffix)

{(Bit 1: DataPrefix) (Bit 0: DataSuffix)}

Set : 1 byte:

{(Bit 0:Success)}

DualRunners – Communication Protocol v1.3 - 15 -

Data Capture

Code ID

0xC8

-

0xC9

Description

Get / Se t

Captured da ta

(barco d e or T agID)

length

Payload

Get : None

Response

Get : 2 bytes

Code ID

0xCA

-

0xCB

Description

Get and e ra s e st or ed

Captured da t a

with n o d a t a loss m o d e

Payload

None

Response

1 byte

Code ID

0xCC

-

0xCD

Description

Res

et mode s

Payload

None = restore defaults, keep link keys, reboot scanner

Response

1 byte

Code ID

0xCE

-

0xCF

Description

Batch u p l o ad comm a n ds

Payload

{Code ID} “Parameters” (cf. below)

Response

{Code ID} “Response”

Code ID

0

Description

Launch upload process (typically used only for the upload barcode)

Payload

1 byte:

Response

1 byte:

Code ID

1

Description

Ready to start upload (Scanner to host message)

Payload

3 bytes :

for Workforce

Set : 2 bytes {authorized barcode length. 0 = disabled}

{authorized barcode length. 0 = disabled} Set : 1 byte {(Bit 0:Success)}

{(Bit 0:Success)}

in Motion

1byte : 0 = restore defaults, keep link keys, reboot scanner 1 = switch off scanner (no restoring defaults) 2 = reboot scanner (no restoring defaults)

{(Bit 0:Success)}

The UPLOAD Code IDs are:

{0 mandatory}

{Bit 0: Success}

{0 mandatory} { number of elements to be uploaded MSB }

DualRunners – Communication Protocol v1.3 - 16 -

Data Capture

{ number of elements to be uploaded LSB }

Response

None

Code ID

2

Description

Start uploading barcodes

Payload

1 byte:

Response

1 byte:

Code

ID 3

Description

RESERVED

Payload

N/A

Response

N/A

Code ID

4

Description

Set upload status and end process

Payload

2 bytes :

Response

1 byte:

Code ID

0xD0

-

0xD1

Description

Get Seri a l N um be r

Payload

Get: None

Response

Get : 2

-

15 bytes:

Code ID

0xD2

-

0xD3

Description

Get/Set A nt i duplicat e s c an s

Payload

Get : None

Response

Get : 1 byte

for Workforce

{0 mandatory}

{Bit 0: Success}

in Motion

{0 mandatory} {1 : upload successful, data can be erased from the scanner 0 : upload failed, do not erase data}

{Bit 0: Success}

{ Serial Number string length } [S/N (1-14 bytes)]

Set : 1 byte {0 = disabled 1 = no consecutive duplicate scans + error signal 2 = no consecutive duplicate scans + no decoding}

{0 = disabled 1 = no consecutive duplicate scans + error signal 2 = no consecutive duplicate scans + no decoding } Set : 1 byte {(Bit 0:Success)}

DualRunners – Communication Protocol v1.3 - 17 -

Data Capture

Comments

The comparison will be made over the 32 first characters of the barcodes only.

Code ID

0xD4

-

0xD5

Description

Restore l a st batch

Payload

None

Response

1 byte:

Comments

This is only available if no new

data capture

has been made.

Code ID

0xD8

-

0xD9

Description

Enable r e m ote trig g e r

Payload

None : use default 5s timeout

Response

1 byte

Code ID

0xDA

-

0xDB

(DualRunner Specific)

Description

Set/Get D ua l Runner

s Mode

Payload

None to get mode

Response

If Get, 2 bytes Mode, Status (1 if success, 0 if failed)

Remarks

Nature of Data Byte is equal to :

-

Code ID

0xDE

-

0xDF

Description

RFID co m m ands

Payload

{Code ID} “Parameters

”

Response

{Code ID} “Response”

for Workforce

or 1 byte (optional): {1 = upload data after retrieving}

{(Bit 0:Success)}

in Motion

1 byte : {timeout (s)}

{(Bit 0:Success)}

1 Byte to set mode Bits 6-0 : 00 switch DualRunners to Both data capture (Barcode and RFID TagID) 01 switch DualRunners to Barcode reader (RFID TagID can’t be read) 02 switch DualRunners to TagID reader (Barcode can’t be read) Bit 7: 0 Desactivate Nature Of Data byte (Default value) 1Activate Nature Of Data byte

If Set, 1 byte (1 if success, 0 if failed)

- 0x30 if data is a barcode 0x31 if data is a RFID HF TagID

RFID specific commands from the Platform2 RFID communication protocol are to be framed within the payload of this message (cf APPENDIX)

DualRunners – Communication Protocol v1.3 - 18 -

Code ID

0xE0

-

0xE1

Description

Get

Capture

Versio n

Payload

None

Response

“Capture Version String” or {0} if not applicable

Remarks

Capture Version Strings can be :

Code ID

0xE2

-

0xE3

Description

Get Mod e

Payloa

d None

Response

1 byte:

Code ID

0xE4

-

0xE5

Description

Set Mode

Payload

1 byte OR

Response

1 byte:

Code ID

0xE6

-

0xE7

Description

Get Dat a For mat

Payload

None

Response

1 byte:

Code ID

0xE8

-

0xE9

Description

Set Data F ormat

Payload

1 byte:

Response

1 byte:

2.3.5. Capture messages

"DUAL_1D"  the scanner is a DualRunners with a 1D non decoded scan engine + an RFID external daughter board "DUAL_2D"  the scanner is a DualRunners with a 2D decoded HHP scan engine + an RFID external daughter board

Data Capture

for Workforce

in Motion

{0 = trigger, 1 = smart autoscan, 2 = disabled, 3= autoscan, 4=aiming trigger scan}

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}

{(Bit 0: Success)}

{(Bit 2:Timestamp) (Bit 1: Capture Prefix) (Bit 0: Capture Suffix)}

{(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) }

DualRunners – Communication Protocol v1.3 - 19 -

Data Capture

{(Bit 0:Succe

ss)}

Code ID

0xEA

-

0xEB

Description

Get

Capture

Prefix

Payload

None

Response

1-

33 bytes:

Code ID

0xEC

-

0xED

Description

Set

Capture

Prefix

Payload

1-

33 bytes:

Response

1 byte:

Code ID

0xEE

-

0xEF

Description

Get

Capture

Suffix

Payload

None

Response

1-

33 bytes:

Code ID

0xF0

-

0xF1

Description

Set

Capture

Suffix

Payload

1-

33 bytes:

Response

1 byte:

Code ID

0xF4

-

0xF5

Description

Set Tim e s ta m p

Payload

6 bytes:

Response

1 byte:

Code ID

0xF6

-

0xF7

Description

Set AI M

Barcode

Symbol o g y I de nt if i er trans m is si o n

Payload

1 byte:

Response

1 byte:

for Workforce

{ Capture Prefix length} “Capture Prefix String”

in Motion

{(Bit 0:Success)}

{ Capture Suffix length} “Capture Suffix String”

{(Bit 0:Success)}

{YY}{MM}{DD}{HH}{MM}{SS}

{Bit 0: Success}

{0 : disabled, 1 : enabled}

DualRunners – Communication Protocol v1.3 - 20 -

Data Capture

{Bit 0: Success}

Code ID

0xF8

-

0xF9

Description

Get stor e d

capt ure d data

count

Payload

None

Response

2 bytes:

Code ID

0xFC

-

0xFD

Description

Erase st o re d c aptured d a t a

(ie: b a r co de s o r T agID)

Payload

None

Response

1 byte:

Code ID

0xFE

-

0xFF

Description

Barcode

decoder C om ma nd s

Payload

{header} {type} {size} “Parameters”

Response

If the device responds:

Remarks

Only available if Scan engine is 1D version

for Workforce

{Stored captured data (barcodes or TagID) count [15:8]} {Stored captured data (barcodes or TagID) count [7:0]}

{(Bit 0:Success)}

in Motion

{Code ID}{length}{header}{type} {response size} “Response” Else: {0}

Barcode decoder specific commands from the Platform2 Decoder communication protocol are to be framed within the payload of this message.

DualRunners – Communication Protocol v1.3 - 21 -

Code

ID 0xA2

-0xA3

Description

Intellige n t Image P a r ameters

(for app l i cations s u c h as sign a t ur e c ap t ur e)

Payload

17 bytes:

Bytes

0 – 1 2 – 3 4 – 7 8 - 11

12 –

14 15 16

parameters

Width

Height

X

Aspect

Resolution

Bits /

Image

Response

1 byte:

2.3.6. Advanced capture messages

Data Capture

for Workforce

in Motion

13

offset Y offset

Width is the width of signature capture area (LSB First). (in inch) Height is the hight of signature capture area (LSB First). (in inch)

X offset : Horizontal Bar Code Offset, The horizontal ratio offset of the center of the signature capture area, in multiples of the minimum bar width (LSB First). (in inch)

Y offset: Vertical Bar Code Offset, The vertical offset of the center of the signature

capture area, in multiples of the minimum bar width. Negative numbers indicate that the signature capture is above the bar code, and positive numbers indicate that the area is below the bar code (LSB First). (in inch)

Aspect Ratio: Bar Code Aspect Ratio, The ratio of the bar code height to the narrow element width (LSB First).

Resolution: Resolution of Signature Capture Area, The number of pixels that the scanner outputs per each minimum bar width. The higher the value for Resolution, the higher the quality of the image, but also the larger the file size.

Bits/Pixel: Indicates the number of bits per pixel in the transmitted image (possible values : 1 or 8)

Image Format:

0: KIM format 1: TIFF binary 2: TIFF binary group 4, compressed 3: TIFF grayscale 4: Uncompressed Binary 5: Uncompressed grayscale 6: JPEG image (default) 7: Outlined image 8: BMP format

Ratio

Pixel

format

{Bit 0: 1 if Success}

DualRunners – Communication Protocol v1.3 - 22 -

Data Capture

Code ID

0xA4

-

0xA5

Description

Intellige n t Image R e fe re nc e

Payload

Byte 1 : reference barcode length

Remarks

Reference barcode can of one of these symbologies: PDF417, Code 39, Code 128, Aztec,

Response

1 byte:

Code ID

0xA6

-0xA7

Description

Intellige n t Image E n abled

Payload

1 byte:

Response

1 byte:

for Workforce

Byte 2 to …. Up to byte 21: reference barcode data

Reference barcode data are the content of barcode serving as reference to the signature area. When a configured reader read a barcode that much witch this reference barcode, its try to get a signature/image defined by its area (see 0xA2 command)

Codabar, and Interleaved 2 of 5

{(Bit 0: 1 if Success)}

in Motion

1 enabled 0 disabled Enable or disable the intelligent image capture capability

{(Bit 0: 1 if Success)}

Special case:

As the pictures can be several Kilo bytes of data, Baracoda has implemented a specific transmission protocol to get image in the best conditions.

We assume that Reader is correctly configured.

1 Scan reference Barcode

a. Switch OFF beam indicates reference barcode read. b. Scanner checks if it’s a reference barcode.

i. If yes, barcode is not sent to the host

ii. If no, barcode is sent to the host (normal behavior) and go to step 3.

c. Scanner send INCOMING_IMAGE event (value is 0x40 00 00) and set User interface

(depending on operating mode):

i. Left Led orange fix

ii. Buzzer ticks

d. Wait for ACK/NACK about INCOMING_IMAGE event (value is 0xA0 00 01 XX) or

TimeOut (Capture Trigger TimeOut (5 second default)).

i. XX = 1 => ACK: host is ready to receive image

ii. XX != 1 => NACK: host not able to receive image

e. Release Left Led and stop buzzer (depending on operating mode)

i. If ACK received : start processing of image

ii. If NACK or TimeOut, stop capture and play Capture Lost signal

2 Scanner returns to normal operating mode (trigger, autoscann …)

DualRunners – Communication Protocol v1.3 - 23 -

1Byte

Header

Selected Symbology

A SELECT ALL

B Code 93

C Code 128 / EAN 128

D EAN 13 / UPC

A

E Code 39

F Codabar

G Interleaved 2 of 5

H Standard 2 of 5

(industrial 2 of 5)

I Matrix 2 of 5 (symbology disabled)

J Code 11

K MSI

L UPC E

M EAN 8

N RSS14 (not available on RoadRunners product)

O RSSLTD

(not available on RoadRunners product)

2.4.

2.4. Decoder Communication

2.4.2.4.

Decoder Communication Protocol

Decoder CommunicationDecoder Communication

Protocol

ProtocolProtocol

2.4.1. frame format

Header Type Size (Bytes) Command

2.4.2. Header

The Header field defines the type of symbology to select; it is 1 byte long (ACSII code):

Data Capture

for Workforce

in Motion

Note: The "A" header (SELECT ALL) allows the selection of all the symbologies available. Thus, only general commands will be allowed.

DualRunners – Communication Protocol v1.3 - 24 -

Type

Description

D

E

2.4.3. Type

The Type field defines the type of command to be sent to the reader, it is 1 byte long.

Data Capture

for Workforce

in Motion

A

B

C

(*): This Type of command is not available with "A" header. (1): This command concerns the whole set of options available for one symbology. Its description will be given in the section "Command field". (2): This type is used for commands requiring non Boolean information. Their length will be at least 2 bytes, the first one defining the type of command, the other(s) being the parameter(s) to use. More details will be given in the section "Command field".

All the commands will answer “0” if the frame is wrong. Commands with type B, C, D or E will answer “1” as an acknowledgment of good reception of the command. The “Get config” command (type A) will answer 2 or 4 bytes : the two firsts follow the format described below (see “set config” command field). The third and fourth bytes correspond to minimum and maximum lengths if the selected symbology supports this option.

Get config: asks the reader to give the configuration options for the selected symbology. (1) (*)

Set config : sets an options configuration for the selected symbology. (1)

Set Default: sets the default options configuration for the selected symbology(ies).

Usual Command.

Special Command (with parameters). (2)

2.4.4. Size

This field specifies the length (bytes) of the following field (commands). It will be set to "0" if the type was "A" (Get Config) or "C" (Set Defaults),

2.4.5. Command

This field contains the commands, its length must be the one specified in the Size field.

There are five types of commands:

2.4.5.1.

2.4.5.1. Set Config (

2.4.5.1.2.4.5.1.

This command is made up of 1 or 2 bytes. The first one contains information for configuration of general options (common to all the symbologies). The second one, optional, relates to specific options to each symbology.

DualRunners – Communication Protocol v1.3 - 25 -

Set Config (Type

Set Config (Set Config (

Type """"BBBB")

Type Type

")

")")

Baracoda Barcode Reader User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual