Baracoda All in One Printer User Manual

Data Capture
ToughRunners / ScanWear
for Workforce
in Motion
©Baracoda TM – May 2009
Data Capture
for Workforce
in Motion
SUMMARY
SUMMARY ................................................................... 2
REVISION HISTORY .......................................................... 3
1.
INTRODUCTION: GENERIC PACKET FORMAT ................................. 4
2.
COMMAND ID SUMMARY .................................................. 5
3.
COMMAND DETAILS ..................................................... 8
3.1.
S
3.2.
3.3.
3.4.
3.5.
3.6.
3.7.
3.8.
3.9.
3.10. C
3.11. P
ETTING MODE
O
PERATIONAL STATISTICS
W
RIST MOTION DETECTION LEVEL (FOR
R
ESTORE DEFAULT SETTINGS
MMI
SETTINGS
B
LUETOOTH COMMANDS
R
EADING AND TRIGGERING COMMANDS
D
ECODER COMMANDS
D
ATA FORMAT COMMANDS OMMUNICATION COMMANDS OWER SAVING COMMANDS
......................................................... 8
................................................. 8
BSW
ONLY
) ............................... 9
.............................................. 10
....................................................... 10
................................................... 12
........................................ 13
.................................................... 17
................................................. 19
................................................ 24
................................................ 25
4.
4.1.
4.2.
4.3.
4.4.
5.
5.1.
5.2.
6.
SPECIAL PACKETS .................................................... 27
D
EPRECATED PACKETS
A
CKNOWLEDGMENT PACKETS
S
PECIAL SCANNER TO HOST MESSAGES
S
PECIAL HOST TO SCANNER MESSAGES
APPENDIX A: BLUETOOTH PROTOCOL. .................................... 29
T
HE CONFIGURATION FRAMES ARE AS FOLLOWS
C
OMMANDS
APPENDIX B: DECODER PROTOCOL. ...................................... 38
: .......................................................... 29
................................................... 27
................................................ 27
........................................ 28
........................................ 28
: ................................. 29
ToughRunners / ScanWear – Communication Protocol v1.2 - 2 -
Data Capture
Revision History
Changes to the original manual are listed below.
Document Date Description
1.0 25th Sep. 07 Initial release
1.1 16th Dec. 08 Graphic Presentation updated
1.2 15th May 09 Updated for firmware version 4.00.6
for Workforce
in Motion
ToughRunners / ScanWear – Communication Protocol v1.2 - 3 -
Data Capture
for Workforce
in Motion
1.
Introduction: generic packet format
All the frames described in this document are formatted as shown (*):
STX Frame # Nbr of cmds Command 1 Command x Checksum ETX
1 byte 1 byte 1 byte 3 n bytes 3 n bytes 1 byte 1 byte
Command ID Data length data
1 byte 1 byte x bytes
Ba) 1 Byte : STX Bb) 1 Byte : Frame number Bc) 1 Byte : Number of commands (or number of commands responses) Bd) 3..n Bytes : Command 1 … Bx) 3..n Bytes : Command x …
By) 1 Byte : CheckSum = (
Bz) 1 Byte : ETX
Each command is formatted as follows: Ca) 1 Byte : Command ID Cb) 1 Byte : Data length Cc) 0..n Bytes : Data
(*): a limited number of frames do not follow this format. They are described in the section 2/.
=xbi
) mod 256
B
i
ToughRunners / ScanWear – Communication Protocol v1.2 - 4 -
Data Capture
2.
Command ID summary
The commands are sorted by category (4 MSB of Command ID):
0x0? Scanner control commands
0x01 Enter "Setting Mode"
0x02 Exit "Setting Mode"
0x03 Launch autotest // RESERVED
0x04 Endurance (AutoScan) test setting // RESERVED
0x05 Retrieve operational statistics
0x06 Reset operational statistics
for Workforce
in Motion
0x07 Get wrist motion detection level
0x08 Set wrist motion detection level
0x0E firmware presence flag // RESERVED
0x0F Restore default settings
0x1? RESERVED
0x2? Firmware upgrade commands // RESERVED
0x27 Start programming (application AT89C51ED2)
0x28 End programming
0x29 Clear firmware
0x2A Read 128Byte bloc
0x2B Write 128Byte bloc
0x2C Verify checksum
0x2D Read Boot cartouche
0x2E Read Application cartouche
0x2F Switch to download mode
ToughRunners / ScanWear – Communication Protocol v1.2 - 5 -
Data Capture
0x3? RESERVED
0x4? MMI commands
0x40 Get vibrator
0x41 Set vibrator
0x42 Get beeps (since version 3.01.00)
0x43 Set beeps (since version 3.01.00)
0x5? Bluetooth commands
0x5E Bluetooth module commands
for Workforce
in Motion
0x6? Reading and triggering commands
0x60 Get reading mode
0x61 Set reading mode
0x62 Get remote triggering settings
0x63 Set remote triggering settings
0x7? RESERVED
0x8? Decoder commands
0x80 Get symbology settings
0x81 Set symbology settings
0x82 Get voting value
0x83 Set voting value
0x84 Get scan beam timeout
0x85 Set scan beam timeout
0x9? RESERVED
ToughRunners / ScanWear – Communication Protocol v1.2 - 6 -
Data Capture
0xA? Data format commands
0xA2 Get symbology prefix
0xA3 Set symbology prefix
0xA4 Get data suffix
0xA5 Set data suffix
0xA6 Get data prefix
0xA7 Set data prefix
0xA8 Get AIM symbology ID transmission
0xA9 Set AIM symbology ID transmission
for Workforce
in Motion
0xAA Get symbology suffix
0xAB Set symbology suffix
0xB? RESERVED
0xC? RESERVED
0xD? Communication commands
0xD5 Get Radio behavior when in charge
0xD6 Set Radio behavior when in charge
0xE? RESERVED
0xF? Power saving commands
0xF0 Get shutdown timers
0xF1 Set shutdown timers
0xF2 Get battery status
ToughRunners / ScanWear – Communication Protocol v1.2 - 7 -
Data Capture
0x01
0x02
0x05
AAAABBBBCC
3.
Command details
3.1. Setting mode
Command ID
Description Enter Setting mode
Length 0
payload none
Response 0 (1 = ERROR)
Command ID
Description Exit Setting mode
Length 0
for Workforce
in Motion
payload none
Response 0 (1 = ERROR)
A radio disconnection leads to an exit from this setting mode.
3.2. Operational statistics
Command ID
Description Retrieve operational statistics
Length 0
payload none
Response
10 bytes :
where :
AAAA = Number of scans done
BBBB = Operating time (minutes)
CC = Number of charge cycles done (MSB first)
ToughRunners / ScanWear – Communication Protocol v1.2 - 8 -
Data Capture
0x06
AAAABBBBCC
0x07
0x08
A
Command ID
Description Reset operational statistics
Length 10
payload
Response 0 (1 = ERROR)
10 bytes :
where :
AAAA = Number of scans done
BBBB = Operating time (minutes)
CC = Number of charge cycles done (MSB first)
for Workforce
in Motion
3.3. Wrist motion detection level
Command ID
Description Get wrist motion detection level
Length 0
payload none
Response 1 byte :
A = 0, 1 or 2
0 = medium, 1 = easy, 2 = hard
Default setting = 1 (easy)
Command ID
Description Set wrist motion detection level
Length 1
(for BSW only)
payload
Response 0 (1 = ERROR)
ToughRunners / ScanWear – Communication Protocol v1.2 - 9 -
= 0, 1 or 2
0 = medium, 1 = easy, 2 = hard
Data Capture
0x0F
A
0x40
ABC
0x41
ABC
for Workforce
3.4. Restore default settings
Command ID
Description Restore factory default settings (reboots scanner)
Length 1
payload
Response none
= 0
3.5. MMI settings
Command ID
Description Get vibrator
Length 0
in Motion
payload none
Response
where :
A = Vibration duration on BAD READ event
B = Vibration duration on BARCODE LOST event
C = Vibration duration on NACK event
Durations in 1/10 sec
Default settings:
0x0A 0x0A 0x0A
Command ID
Description Set vibrator
Length 3
payload
where :
A = Vibration duration on BAD READ event
ToughRunners / ScanWear – Communication Protocol v1.2 - 10 -
Data Capture
B
0x42
(Since version 3.01.00)
1
0x43
(Since version 3.01.00)
1
= Vibration duration on BARCODE LOST event
C = Vibration duration on NACK event
Durations in 1/10 sec
Response 0 (1 = ERROR)
Command ID
Description Get beeps
Length 0
payload none
Response 1 byte:
for Workforce
in Motion
Bit A.0 = 0 enable barcode decoded beep, 1 disable barcode decoded beep
Bit A.1 = 0 enable barcode acknowledgement beep, disable barcode acknowledgement beep
Default settings:
0x00
Command ID
Description Set beeps
Length 1
payload 1 byte:
Bit A.0 = 0 enable barcode decoded beep, 1 disable barcode decoded beep
Response 0 (1 = ERROR)
ToughRunners / ScanWear – Communication Protocol v1.2 - 11 -
Bit A.1 = 0 enable barcode acknowledgement beep, disable barcode acknowledgement beep
Data Capture
0x5E
{Code ID} {length}
for Workforce
in Motion
3.6. Bluetooth commands
Command ID
Description Bluetooth Commands
Length Variable (1-255)
payload {Code ID} {length} “Parameters”
Response If the device responds:
“Response”
Else: {0}
Bluetooth specific commands from the Bluetooth communication protocol are to be framed within the payload of this message. See Appendix A for more details.
The default Bluetooth settings are the BT module’s default settings, excepted the BT name which default value must be handled by the firmware:
ToughRunners : “ToughRunners xx xx” Scanwear : “ScanWear xx xx”
xx xx being the 4 last readable characters of the BDA written in hexadecimal (two last bytes of BDA).
Example : “Get PIN Code”
Command :
Ba) 0x02 : STX Bb) 0x00 : Frame number Bc) 0x01 : Number of commands (or number of commands responses) Bd) : Command
Bd1) 0x5E : Command ID Bd2) 0x03 : Data length Bd3) : Data
B
) 0x07 : Get PIN Code
d31
B
) 0x00 : Length MSB
d32
B
) 0x00 : Length LSB
d33
Be) 0x69 : CheckSum = (
Bf) 0x03 : ETX
Response:
Ba) 0x02 : STX Bb) 0x00 : Frame number Bc) 0x01 : Number of commands (or number of commands responses) Bd) : Command
ToughRunners / ScanWear – Communication Protocol v1.2 - 12 -
B
i
=ebi
Bd1) 0x5E : Command ID Bd2) 0x07 : Data length
) : Data
B
d3
B
) 0x07 : Get PIN Code
d31
) mod 256
Data Capture
0x60
ABCDEFGHI
B
) 0x00 : Length MSB
d32
B
) 0x04 : Length LSB
d33
B
) 0x30 : PIN Code 0
d34
B
) 0x30 : PIN Code 1
d35
B
) 0x30 : PIN Code 2
d36
B
) 0x30 : PIN Code 3
d37
Be) 0x31 : CheckSum
= (
= 0x01+0x5E+x007+0x07+0x04+0x00
= 0x131 mod 0x100 = 0x31
Bf) 0x03 : ETX
) mod 256
B
i
=xbi
+0x30+0x30+0x30+0x30 mod 0x100
3.7. Reading and triggering commands
Command ID
for Workforce
in Motion
Description Get reading mode
Length 0
payload none
Response
where :
A = long press action (1 sec.):
------00 : Disabled
------01 : Hold laser beam
------10 : Shut down scanner
------11 : Start Multiscan Session
B = simple press action :
------00 : Disabled
------01 : Simple scan
------10 : Start Multiscan Session
---1---- : Stop Multiscan Session
C = wrist motion action :
------00 : Disabled
ToughRunners / ScanWear – Communication Protocol v1.2 - 13 -
Loading...
+ 29 hidden pages