Summary of the content on the page No. 1
Data Capture
for Workforce
in Motion
ToughRunners / ScanWear
Communication Protocol
TM
©Baracoda – May 2009
Summary of the content on the page No. 2
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. SETTING MODE .............................................
Summary of the content on the page No. 3
Data Capture for Workforce in Motion 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 ToughRunners / ScanWear – Communication Protocol v1.2 - 3 -
Summary of the content on the page No. 4
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 B ) 1 Byte : STX a B ) 1 Byte : Frame number b B ) 1 Byte : Number of commands (or number of commands responses) c B ) 3..n Bytes : Command 1 d … B ) 3
Summary of the content on the page No. 5
Data Capture for Workforce in Motion 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 0x07 Get wrist motion detection level 0x08 Set wrist motion detection level 0x0E firmware presence flag // RESERVED 0x0F R
Summary of the content on the page No. 6
Data Capture for Workforce in Motion 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 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
Summary of the content on the page No. 7
Data Capture for Workforce in Motion 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 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
Summary of the content on the page No. 8
Data Capture for Workforce in Motion 3. Command details 3.1. Setting mode Command ID 0x01 Description Enter Setting mode Length 0 payload none Response 0 (1 = ERROR) 0x02 Command ID Description Exit Setting mode Length 0 payload none Response 0 (1 = ERROR) A radio disconnection leads to an exit from this setting mode. 3.2. Operational statistics 0x05 Command ID Description Retrieve operational statistics Length 0 payload none Response 10 bytes : AAAABBBBCC wher
Summary of the content on the page No. 9
Data Capture for Workforce in Motion Command ID 0x06 Description Reset operational statistics Length 10 10 bytes : AAAABBBBCC payload where : AAAA = Number of scans done BBBB = Operating time (minutes) CC = Number of charge cycles done (MSB first) Response 0 (1 = ERROR) 3.3. Wrist motion detection level (for BSW only) Command ID 0x07 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
Summary of the content on the page No. 10
Data Capture for Workforce in Motion 3.4. Restore default settings Command ID 0x0F Description Restore factory default settings (reboots scanner) Length 1 A = 0 payload Response none 3.5. MMI settings Command ID 0x40 Description Get vibrator Length 0 payload none ABC 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 0x
Summary of the content on the page No. 11
Data Capture for Workforce in Motion B = Vibration duration on BARCODE LOST event C = Vibration duration on NACK event Durations in 1/10 sec Response 0 (1 = ERROR) Command ID 0x42 (Since version 3.01.00) Description Get beeps Length 0 payload none Response 1 byte: Bit A.0 = 0 enable barcode decoded beep, 1 disable barcode decoded beep Bit A.1 = 0 enable barcode acknowledgement beep, 1 disable barcode acknowledgement beep Default settings: 0x00 Command ID 0x43 (
Summary of the content on the page No. 12
Data Capture for Workforce in Motion 3.6. Bluetooth commands Command ID 0x5E Description Bluetooth Commands Length Variable (1-255) payload {Code ID} {length} “Parameters” Response If the device responds: {Code ID} {length} “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
Summary of the content on the page No. 13
Data Capture for Workforce in Motion 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 B ) 0x31 : CheckSum e x = ( B ) mod 256 ∑ i i=b = 0x01+0x5E+x007+0x07+0x04+0x00 +0x30+0x30+0x30+0x30 mod 0x100 = 0x131 mod 0x100 = 0x31 B ) 0x03 : ETX f 3.7. Reading and triggering commands Command ID 0x60 Description Get reading mode Length 0 payload none Response ABCDEFGHI whe
Summary of the content on the page No. 14
Data Capture for Workforce in Motion ------01 : Simple scan ------10 : Start Multiscan Session ---1---- : Stop Multiscan Session D = long press duration x 100ms E = maximum scans in session: -0000000 : unlimited -XXXXXXX : number of scans in the session 1------- : Anti-doubloon in the session F = Inter-scan interval x100ms G = 0 H = 0 I = 0 Default settings : ScanWear : 0x00 0x01 0x01 0x0A 0x00 0x0A 0x00 0x00 0x00 ToughRunners :0x01 0x01 0x01 0x0A 0x0
Summary of the content on the page No. 15
Data Capture for Workforce in Motion 0x61 Command ID Description Set reading mode Length 9 payload ABCDEFGHI 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 : Dis
Summary of the content on the page No. 16
Data Capture for Workforce in Motion G = 0 H = 0 I = 0 Response 0 (1 = ERROR) Command ID 0x62 Description Get remote triggering settings Length 0 payload none ABCDEFG Response where : A = character to trigger a Good Read signal B = character to trigger a Good Read signal C = character to trigger a Simple Scan D = character to start an Multiscan Session E = character to stop an Multiscan Session F = character to lock the scan engine G = character to unlock the scan engi
Summary of the content on the page No. 17
Data Capture for Workforce in Motion 0x63 Command ID Description Set remote triggering settings Length 7 payload ABCDEFG where : A = character to trigger a Good Read signal B = character to trigger a Good Read signal C = character to trigger a Simple Scan D = character to start an Multiscan Session E = character to stop an Multiscan Session F = character to lock the scan engine G = character to unlock the scan engine Response 0 (1 = ERROR) 3.8. Decoder commands Command
Summary of the content on the page No. 18
Data Capture for Workforce in Motion Command ID 0x81 Description Set symbology settings Length 20 (since version 3.02.03) payload cf. Appendix B for details Response 0 (1 = ERROR) Command ID 0x82 Description Get voting value Length 0 payload none V = number of decodes to validate a good scan Response Default value = 1 Command ID 0x83 Description Set voting value Length 1 payload V = number of decodes to validate a good scan Response 0 (1 = ERROR) Command ID 0x84
Summary of the content on the page No. 19
Data Capture for Workforce in Motion Length 1 payload T = timeout in seconds (255 = Autoscan mode) Response 0 (1 = ERROR) 3.9. Data format commands 0xA2 Command ID Description Get symbology prefix Length 0 or 1 payload None Response 22 or 28 bytes (since version 3.02.03) (if length = 0 then 22 bytes, if length = 1 then 28 bytes): AABBCCDDEEFFGGHHIIJJKKLLMMNN Where: AA = Code39 BB = Interleaved 2 of 5 CC = Standard 2 of 5 DD = Codabar EE = EAN/UPC FF = Code128 GG = MS
Summary of the content on the page No. 20
Data Capture for Workforce in Motion Default settings : 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 Command ID 0xA3 Description Set symbology prefix Length 28 (since version 3.02.03) payload AABBCCDDEEFFGGHHIIJJKKLLMMNN Where: AA = Code39 BB = Interleaved 2 of 5 CC = Standard 2 of 5 DD = Codabar EE = EAN/UPC FF = Code128 GG = MSI HH = PLESSEY II = Code93 JJ = EAN128 KK = Codablock F LL = RSS 14 (GS1
