Summary of the content on the page No. 1
Data Capture
for Workforce
in Motion
BaracodaPencil 2
Communication Protocol
TM
©Baracoda – January 2009
Summary of the content on the page No. 2
Data Capture for Workforce in Motion SSSSUUUUMMMMMMMMAAAARRRRYYYY SUMMARY ................................................................... 2 REVISION HISTORY .......................................................... 3 1. INTRODUCTION ........................................................ 4 1.1. GENERALITIES .......................................................... 4 1.2. GENERIC PACKET ........................................................ 4 2. COMMUNICATION PROTOCOL .....
Summary of the content on the page No. 3
Data Capture for Workforce in Motion RRRReeeevvvviiiissssiiiioooonnnn HHHHiiiissssttttoooorrrryyyy Changes to the original manual are listed below. Document Date Description 1.1 26 Jan. 07 Initial release 1.2 29 Sept. 08 Added new commands : 0x5A-0x5B : Get/Set master mode Changed "barcode prefix/suffix" into "capture prefix/suffix" Changed §2.3.5 "barcode messages" into "capture messages" Changed command 0xE0-0xE1 name to "get capture version" 1.3 02 Jan. 09 Add “Deco
Summary of the content on the page No. 4
Data Capture for Workforce in Motion 11.. IInnttrroodduuccttiioonn 11..IInnttrroodduuccttiioonn 1111....1111.... GGGGeeeennnneeeerrrraaaalllliiiittttiiiieeeessss BaracodaPencil 2 is a wireless data capture product. This document is detailing the protocol of communication between the Baracoda scanner Pencil2 and its foreign environment through Radio Frequency link (ie: Bluetooth). The protocol of communication does not depend on the type of link. Wireless communication is based
Summary of the content on the page No. 5
Data Capture for Workforce in Motion 22.. CCoommmmuunniiccaattiioonn pprroottooccooll 22..CCoommmmuunniiccaattiioonn pprroottooccooll 2222....1111.... BBBBiiiiddddiiiirrrreeeeccccttttiiiioooonnnnaaaallll ppppaaaacccckkkkeeeettttssss 22..11..11.. CCoonnttrrooll mmeessssaaggeess 22..11..11.. CCoonnttrrooll mmeessssaaggeess 2.1.1.1. Specific packets Code ID Description Frame 0x01 Legacy 0x01 0x01 0x01 Or 0x01 0x02 0x01 These two (2) sequences will be recognized and purg
Summary of the content on the page No. 6
Data Capture for Workforce in Motion 22..22.. SSccaannnneerr ttoo hhoosstt mmeessssaaggeess 22..22.. SSccaannnneerr ttoo hhoosstt mmeessssaaggeess 2222....2222....1111.... EEEEnnnnccccaaaappppssssuuuullllaaaattttiiiioooonnnn sssscccchhhheeeemmmmeeee Code ID Description Payload Barcode data 0x32–0x33 DATA string 2222....2222....2222.... DDDDaaaattttaaaa ssssttttrrrriiiinnnngggg ffffoooorrrrmmmmaaaatttt Data Data Capture Symbology Barcode / RFID Symbology Capt
Summary of the content on the page No. 7
Data Capture for Workforce in Motion 22..33.. HHoosstt ttoo ssccaannnneerr mmeessssaaggeess 22..33.. HHoosstt ttoo ssccaannnneerr mmeessssaaggeess 2222....3333....1111.... CCCCoooommmmmmmmuuuunnnniiiiccccaaaattttiiiioooonnnn mmmmeeeessssssssaaaaggggeeeessss Code ID 0x40-0x41 Get Communication Descriptor Description Payload None Response 2 bytes: {Wireless link: (Bit 0: Bluetooth)} {Wired link: (Bit 0: Serial Dock)} Code ID 0x42-0x43 Get Retransmission Parameters
Summary of the content on the page No. 8
Data Capture for Workforce in Motion Code ID 0x50-0x51 Lock/Unlock Scan engine Description Payload 1 byte : {0 = Unlock, 1 = Lock} Response 1 byte : {Bit 0 : Success} Code ID 0x52-0x53 Disable Barcode Programming Functionality Description Payload 1 byte : {1 = Disable barcode programming functionality, 0 = Enable} Response 1 byte : {Bit 0 : Success} Code ID 0x56-0x57 Get/Set In charge behavior Description Payload Get : None Set : 1 byte : {shutdown timeout (0 =
Summary of the content on the page No. 9
Data Capture for Workforce in Motion 2222....3333....2222.... SSSSccccaaaannnnnnnneeeerrrr mmmmeeeessssssssaaaaggggeeeessss Code ID 0x60-0x61 Get Scanner Status Description Payload None Response 2 bytes: {(Bit 7: Upgrading) (Bit 1: Docked) (Bit 0: Charging)} {Battery level, 0 to 100} Code ID 0x62-0x63 Get Operating Mode Description Payload None Response 1 byte: {Bit 0 = 0:real time, Bit 0 = 1: batch} {(Bit 7: limited)} Remarks “limited” means barcode buffer = 0 whe
Summary of the content on the page No. 10
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 ID 0x6A-0x6B Get RTC time Description Payload None Response 6 bytes: {YY}{MM}{DD}{HH}{MM}{SS} Code ID 0x6C-0x6D Set RTC time Description Payload 6 bytes: {YY}{MM}{DD}{HH}{MM}{SS} Response 1 byte: {Bit 0: Success} Code ID 0x74-0x75 Restore defaults settings Description Payload None Response 1 byte: {Bit 0: S
Summary of the content on the page No. 11
Data Capture for Workforce in Motion 2222....3333....3333.... UUUUsssseeeerrrr IIIInnnntttteeeerrrrffffaaaacccceeee mmmmeeeessssssssaaaaggggeeeessss Code ID 0x80-0x81 Get MMI Descriptor Description Payload None Response 2 bytes: {(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)} Code ID 0x82-0x83 Get MMI Mode Description Payload None Response 1 byte: {(Bit 1: Buzzer Enabl
Summary of the content on the page No. 12
Data Capture for Workforce in Motion 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} Response 1 byte: {(Bit 0: Success)} Code ID 0x8A-0x8B Play Signal Description Payload 2 bytes: {Signal number, 0 - 3} {Number of loops, 0 – 0xFE, 0xFF = infinity} Response 1 byte: {(Bit 0: Success)} Code ID
Summary of the content on the page No. 13
Data Capture for Workforce in Motion Response 1 byte: {(Bit 0: Success)} BaracodaPencil 2 – Communication Protocol v1.3 - 13 -
Summary of the content on the page No. 14
Data Capture for Workforce in Motion 2222....3333....4444.... MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss mmmmeeeessssssssaaaaggggeeeessss Code ID 0xC2-0xC3 Get/Set DataPrefix Description Payload Get : None Set : 1-33 bytes: { DataPrefix length} “DataPrefix String” Response Get : 1-33 bytes: { DataPrefix length} “DataPrefix String” Set : 1 byte: {Success?} Code ID 0xC4-0xC5 Get/Set DataSuffix Description Payload Get : None Set : 1-33 bytes: { DataSuffix le
Summary of the content on the page No. 15
Data Capture for Workforce in Motion Code ID 0xC8-0xC9 Get / Set Barcode length Description Payload Get : None Set : 2 bytes {authorized barcode length. 0 = disabled} Response Get : 2 bytes {authorized barcode length. 0 = disabled} Set : 1 byte {(Bit 0:Success)} Code ID 0xCA-0xCB Get and erase stored barcodes with no data loss mode Description Payload None Response 1 byte {(Bit 0:Success)} Code ID 0xCC-0xCD Reset modes Description Payload None =
Summary of the content on the page No. 16
Data Capture for Workforce in Motion { number of elements to be uploaded MSB } { number of elements to be uploaded LSB } Response None Code ID 2 Description Start uploading barcodes Payload 1 byte: {0 mandatory} Response 1 byte: {Bit 0: Success} Code ID 3 Description RESERVED Payload N/A Response N/A Code ID 4 Description Set upload status and end process Payload 2 bytes : {0 mandatory} {1 : upload successful, data can be erased from the scanner 0 : upload failed,
Summary of the content on the page No. 17
Data Capture for Workforce in Motion {1 = upload data after retrieving} Response 1 byte: {(Bit 0:Success)} Comments This is only available if no new scan has been made. Code ID 0xD8-0xD9 Enable remote trigger Description Payload None : use default 5s timeout 1 byte : {timeout (s)} Response 1 byte {(Bit 0:Success)} BaracodaPencil 2 – Communication Protocol v1.3 - 17 -
Summary of the content on the page No. 18
Data Capture for Workforce in Motion 2222....3333....5555.... CCCCaaaappppttttuuuurrrreeee mmmmeeeessssssssaaaaggggeeeessss Code ID 0xE0-0xE1 Get Capture Version Description Payload None Response “Capture Version String” or {0} if not applicable Code ID 0xE2-0xE3 Get Mode Description Payload None Response 1 byte: {0 = trigger, , 2 = disabled} Code ID 0xE4-0xE5 Set Mode Description Payload 1 byte OR {0 = trigger, 2 = disabled} Response 1 byte: {(Bit 0: Success)}
Summary of the content on the page No. 19
Data Capture for Workforce in Motion “Capture Prefix String” Code ID 0xEC-0xED Set Capture Prefix Description Payload 1-33 bytes: { Capture Prefix length} “Capture Prefix String” Response 1 byte: {(Bit 0:Success)} Code ID 0xEE-0xEF Get Capture Suffix Description Payload None Response 1-33 bytes: { Capture Suffix length} “Capture Suffix String” Code ID 0xF0-0xF1 Set Capture Suffix Description Payload 1-33 bytes: { Capture Suffix length} “Capture Suffix String” Res
Summary of the content on the page No. 20
Data Capture for Workforce in Motion {Stored barcodes count [15:8]} {Stored barcodes count [7:0]} Code ID 0xFA-0xFB Get and erase stored barcodes Description Payload None Response 1 byte: {(Bit 0:Success)} Code ID 0xFC-0xFD Erase stored barcodes Description Payload None Response 1 byte: {(Bit 0:Success)} Code ID 0xFE-0xFF Barcode decoder Commands Description Payload {header} {type} {size} “Parameters” Response If the device responds: {Code ID}{length}{header}{type
