Baracoda 2 manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

Go to page of

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Baracoda 2, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Baracoda 2 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Baracoda 2. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Baracoda 2 should contain:
- informations concerning technical data of Baracoda 2
- name of the manufacturer and a year of construction of the Baracoda 2 item
- rules of operation, control and maintenance of the Baracoda 2 item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Baracoda 2 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Baracoda 2, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Baracoda service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Baracoda 2.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Baracoda 2 item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    Data Capture for W orkforce in Motion Baracoda Pencil 2 Communic ation Prot ocol ©Baracoda TM – January 2009[...]

  • Page 2

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 2 - Data Capture for W orkforce in Motion SUMMAR Y SUMMAR Y SUMMAR Y SUMMAR Y SUMMARY ................................................................... 2 REVISION HISTORY .......................................................... 3 1. INTRODUCTION ................................................[...]

  • Page 3

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 3 - Data Capture for W orkforce in Motion Revisi on Hi stor y Revisi on Hi stor y Revisi on Hi stor y Revisi on Hi stor y Changes to the original manual are listed belo w. Documen t Date Description 1.1 26 Jan. 07 Initial release 1.2 29 Sept. 08 Added new commands : 0x5A-0x5B : Get/Set master mode[...]

  • Page 4

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 4 - Data Capture for W orkforce in Motion 1. 1. 1. 1. Introduction Introduction Introduction Introduction 1.1. 1.1. 1.1. 1.1. Generalities Generalities Generalities Generalities BaracodaPencil 2 is a wir eless data capture product. This document is detailin g the protocol of com munication between[...]

  • Page 5

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 5 - Data Capture for W orkforce in Motion 2. 2. 2. 2. Communication protocol Communication protocol Communication protocol Communication protocol 2.1. 2.1. 2.1. 2.1. Bidirectional packets Bidirectional packets Bidirectional packets Bidirectional packets 2.1.1. 2.1.1. 2.1.1. 2.1.1. Cont rol message[...]

  • Page 6

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 6 - Data Capture for W orkforce in Motion 2.2. 2.2. 2.2. 2.2. Scanner to host Scanner to host Scanner to host Scanner to host messages messages messages messages 2.2.1. 2.2.1. 2.2.1. 2.2.1. Enca psulation scheme Encapsulati on scheme Encapsulati on scheme Encapsulati on scheme Code ID Description [...]

  • Page 7

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 7 - Data Capture for W orkforce in Motion 2.3. 2.3. 2.3. 2.3. Host to scanner Host to scanner Host to scanner Host to scanner messages messages messages messages 2.3.1. 2.3.1. 2.3.1. 2.3.1. Comm unication messag es Communicati on messages Communicati on messages Communicati on messages Code ID 0x4[...]

  • Page 8

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 8 - Data Capture for W orkforce in Motion Code ID 0x50 - 0x51 Description L o c k / U n l o c k S c a n e n g i n e Payload 1 byte : {0 = Unlock, 1 = Lock} Response 1 byte : {Bit 0 : Success} Code ID 0x52 - 0x53 Description D i s a b l e B a r c o d e P r o g r a m m i n g F u n c t i o n a l i t [...]

  • Page 9

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 9 - Data Capture for W orkforce in Motion 2.3.2. 2.3.2. 2.3.2. 2.3.2. Scan ner messages Scanner mes sages Scanner mes sages Scanner mes sages Code ID 0x60 - 0x61 Description G e t S c a n n e r S t a t u s Payload None Response 2 bytes: {(Bit 7: Upgrading ) (Bit 1: Docked) (Bit 0: Charging )} {Bat[...]

  • Page 10

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 10 - Data Capture for W orkforce in Motion {Number of minutes befo re shutdown wh en disconne ct ed, 1 to 0xFE, 0xFF = infinity} Response 1 byte: {Bit 0: Success} Code ID 0x6A - 0x6B Description G e t R T C t i m e Payload None Response 6 bytes: {YY}{MM}{DD}{HH}{M M}{SS} Code ID 0x6C - 0x6D Descri[...]

  • Page 11

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 11 - Data Capture for W orkforce in Motion 2.3.3. 2.3.3. 2.3.3. 2.3.3. User Interface messa ges User Interf ace messages User Interf ace messages User Interf ace messages Code ID 0x80 - 0x81 Description G e t M M I D e s c r i p t o r Payload None Response 2 bytes: {(Bit 6: Blue LED 1) (Bit 5: Red[...]

  • Page 12

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 12 - Data Capture for W orkforce 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 – 12 750Hz} {Delay until next step, in tenth of seconds} Response 1 byte: {[...]

  • Page 13

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 13 - Data Capture for W orkforce in Motion Response 1 byte: {(Bit 0: Success)}[...]

  • Page 14

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 14 - Data Capture for W orkforce in Motion 2.3.4. 2.3.4. 2.3.4. 2.3.4. Misc ellaneous messag es Miscellaneo us messages Miscellaneo us messages Miscellaneo us messages Code ID 0xC2 - 0xC3 Description G e t / S e t D a t a P r e f i x Payload Get : None Set : 1-33 bytes: { DataPrefix length} “Dat[...]

  • Page 15

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 15 - Data Capture for W orkforce in Motion Code ID 0xC8 - 0xC9 Description G e t / S e t B a r c o d e l e n g t h Payload Get : None Set : 2 bytes {authorized barcode leng th. 0 = disabled} Response Get : 2 bytes {authorized barc ode length. 0 = disabled} Set : 1 byte {(Bit 0:Success)} Code ID 0x[...]

  • Page 16

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 16 - Data Capture for W orkforce in Motion { number of elements t o be uploaded MSB } { number of elements t o 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 R[...]

  • Page 17

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 17 - Data Capture for W orkforce in Motion {1 = upload data after ret rieving} Response 1 byte: {(Bit 0:Success)} Comments This is only available if n o new scan has been made. Code ID 0xD8 - 0xD9 Description E n a b l e r e m o t e t r i g g e r Payload None : use default 5s ti meout 1 byte : {ti[...]

  • Page 18

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 18 - Data Capture for W orkforce in Motion 2.3.5. 2.3.5. 2.3.5. 2.3.5. Capt ure Capture Capture Capture messages messages messages messages Code ID 0xE0 - 0xE1 Description G e t C a p t u r e V e r s i o n Payload None Respon se “Capture Version String” or {0} if not applicable Code ID 0xE2 - [...]

  • Page 19

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 19 - Data Capture for W orkforce in Motion “Capture Prefix String ” Code ID 0xEC - 0xED Description S e t C a p t u r e P r e f i x Paylo ad 1 - 33 bytes: { Capture Prefix length} “Capture Prefix String ” Response 1 byte: {(Bit 0:Success)} Code ID 0xEE - 0xEF Description G e t C a p t u r [...]

  • Page 20

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 20 - Data Capture for W orkforce in Motion {Stored barcodes count [ 15:8]} {Stored barcodes count [ 7:0]} Code ID 0xFA - 0xFB Description G e t a n d e r a s e s t o r e d b a r c o d e s Payload None Response 1 byte: {(Bit 0:Success)} Code ID 0xFC - 0xFD De scription E r a s e s t o r e d b a r c[...]

  • Page 21

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 21 - Data Capture for W orkforce in Motion 2.4. 2.4. 2.4. 2.4. Decoder Communication Decoder Communication Decoder Communication Decoder Communication P rotocol Protocol Protocol Protocol 2.4.1. 2.4.1. 2.4.1. 2.4.1. fram e format frame forma t frame forma t frame forma t Header Type Size (Bytes) C[...]

  • Page 22

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 22 - Data Capture for W orkforce in Motion 2.4.3. 2.4.3. 2.4.3. 2.4.3. Type Type Type Type The Type field defines th e type of co mmand to be sent to the r eader, it is 1 byte long . Type Description A Get config : ask s the reader to give the con figuration opt ions for t he selected symbo logy. [...]

  • Page 23

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 23 - Data Capture for W orkforce in Motion For a Set Co nfig (type "B") with a SELECT ALL (header "A"), the command sent c an only be 1 byte long. Note: A high level bit ("1") corresponds to an Enable, a "0" bit means Disable. BYTE 1 (general opt ions): The [...]

  • Page 24

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 24 - Data Capture for W orkforce in Motion CODE 128 / EAN 128 (Hea der "C") Bit Option LSB 0 GS transmit (EAN128) 1 AIM Sym b ID transmit (EAN 128) 2 FREE 3 FREE 4 FREE 5 FREE 6 FREE MSB 7 FREE EAN 13 / UPC - A (Header " D") Bit Option LSB 0 Number System transmi tted (UPC A) 1[...]

  • Page 25

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 25 - Data Capture for W orkforce in Motion INTERLEAVED 2 OF 5 (Header "G") Bit Option LSB 0 FREE 1 FREE 2 FREE 3 FREE 4 FREE 5 FREE 6 FREE MSB 7 FREE STANDARD 2 OF 5 (Heade r "H") Bit Option LSB 0 FREE 1 FREE 2 FREE 3 FREE 4 FREE 5 FREE 6 FREE MSB 7 FREE MATRIX 2 OF 5 (Heade r [...]

  • Page 26

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 26 - Data Capture for W orkforce in Motion MSI (Header "K") Bit Option LSB 0 FREE 1 FREE 2 FREE 3 FREE 4 FREE 5 FREE 6 FREE MSB 7 FREE UPC - E (Header " L ") Bit Option LSB 0 Numb er System transmitte d 1 - 2 - 3 - 4 FREE 5 UPC - E transmitted as UPC - A 6 - MSB 7 FREE EAN 8 (H[...]

  • Page 27

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 27 - Data Capture for W orkforce in Motion MSB 7 FREE RSS Limited (Header " O ") Bit Option LSB 0 LINKAGE FLAG PRINT 1 APPLICATION ID PRI NT 2 FREE 3 FREE 4 FREE 5 FREE 6 FREE MSB 7 FREE 2.4.5.2. 2.4.5.2. 2.4.5.2. 2.4.5.2. Get conf ig Get config Get config Get config ( ( ( ( Type Type Ty[...]

  • Page 28

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 28 - Data Capture for W orkforce in Motion COMMANDS TABLE Asci i CODE COMMAND RESPONDING HEA DERS A Enable Symbology All B Disable Symbology All C Disable Min. length A, B, C, E, F, G, H , J, K D Enable Min. length (1) A, B, C, E, F, G, H , J, K E Enable Checksum calculati on (2) E, F, G, H, J, K [...]

  • Page 29

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 29 - Data Capture for W orkforce in Motion o Enable AIM symbology identifier transmissi on C p Dissable AIM symbol ogy identifier transmission C q Enable Price Co de transmission f or ISSN D r Disable Price Code transmission f or ISSN D s Add - on Digits not required b ut transmitted if read D t A[...]

  • Page 30

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 30 - Data Capture for W orkforce in Motion 2.4.6. 2.4.6. 2.4.6. 2.4.6. Exam ples Examples Examples Examples Here are some exa mples to illustrate each type of frame to be s ent to the decod er and the possible answer from the decoder. 2.4.6.1. 2.4.6.1. 2.4.6.1. 2.4.6.1. Get Conf ig Get Config Get [...]

  • Page 31

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 31 - Data Capture for W orkforce in Motion 2.4.6.2. 2.4.6.2. 2.4.6.2. 2.4.6.2. S S S S et Config et Config et Config et Config Exa Exa Exa Exa mple mple mple mple 2.1 2.1 2.1 2.1     Setting a con figuration of Co dabar symbolo gy. Setting a config uration of Codab ar symbology. Settin[...]

  • Page 32

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 32 - Data Capture for W orkforce in Motion Example Example Example Example 2.2 2.2 2.2 2.2     Setting a con figuration of al l symbologies . Setting a config uration of all s ymbologies. Setting a config uration of all s ymbologies. Setting a config uration of all s ymbologies. Frame [...]

  • Page 33

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 33 - Data Capture for W orkforce in Motion 2.4.6.4. 2.4.6.4. 2.4.6.4. 2.4.6.4. Special command Special com mand Special com mand Special com mand Example Example Example Example 4.1 4.1 4.1 4.1     Sending a spe cial command to Code39 symbol ogy. Sending a specia l command to Cod e39 s[...]

  • Page 34

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 34 - Data Capture for W orkforce in Motion APPEND IX 1 APPEND IX 1 APPEND IX 1 APPEND IX 1 : Blueto oth P roto col : Blu etoot h Pro tocol : Blu etoot h Pro tocol : Blu etoot h Pro tocol The configuration frames are as follows: The configuration frames are as follows: The configuration frames are [...]

  • Page 35

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 35 - Data Capture for W orkforce in Motion Command Set Mode Header 0x03 (flash only) Length 00 02 Payload 0x01 if MASTER, 0x00 if SLAVE, [Role switch] Response 0x03 00 01 01 if done 0x03 00 01 00 if not When in Master, the M odule connects to the address specified by Set REMOTE B DA or to the last[...]

  • Page 36

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 36 - Data Capture for W orkforce in Motion Command Get Bluetooth Versi on Header 0x76 Length 00 00 Payload R esponse 0x76, x, x, {version string } Command Restore Factory Settings Header Length Payload ('R', 's', 't') Response Command Get inquiry scan timeout Header 0[...]

  • Page 37

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 37 - Data Capture for W orkforce in Motion Command Set page scan timeout Header 0x24 Length 00 04 Payload [Page Interval (MSB) | Page Interval (LSB) | Page Window (MSB) | Page Window (LSB)] (default 0x320, 0xb0) Response 0x24 00 01 01 if done 0x24 00 01 00 if not Remark Page Scan T imeOuts are use[...]

  • Page 38

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 38 - Data Capture for W orkforce in Motion Command Set sniff Header 0x09 Length 00 04 Payload [MSB of MinSniff interval, LSB of MinSniff inter val, MSB of MaxSniff interval, LSB of MaxSnif int erval] Response 0x09 00 01 01 if done 0x09 00 01 00 if not Remark Command Set sniff (advanced) Header 0x0[...]

  • Page 39

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 39 - Data Capture for W orkforce in Motion Low Power (medium sp eed): MinSniff = 0x0050 MaxSniff = 0x00F0 Attempt = 0x0008 Timeout = 0x0030 MaxSniff and MinSni ff are only used for sniff neg otiation between the Smart Module and the other BT device. If both sides all ow sniff value MaxSniff, then [...]

  • Page 40

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 40 - Data Capture for W orkforce in Motion Command Get Security Mode Header 0x20 Length 00 00 Payload Response 0x20 00 01 01 if secured 0x20 00 01 00 if non s ecured Remark Command Set Security Mode Header 0x21 Length 00 {size} Payload {00 non secured, 01 se cured} {PIN CODE (default 01) Response [...]

  • Page 41

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 41 - Data Capture for W orkforce in Motion Typical Bluetooth class of device: Peripheral 0x000500 (default) Undefined 0x001F00 Phone 0x502204 Computer 0x120104 PDA 0x100114 Access Point 0x120320 Command Set Remote rfcomm chan nel Header 0x36 Length 00 01 Payload [channel (1byte)] Response 0x36 00 [...]

  • Page 42

    BaracodaPencil 2 – C ommunication Protocol v1.3 - 42 - Data Capture for W orkforce in Motion Payload Response 0x39 00 02 [UUID] Remark Try to connect to this re mote service. Here are some service UUI D: SPP 0x1 101 DUN 0x1103 FAX 0x1102 You can get more UUIDs by reading the Blu etooth spec. Command Get Encryption Mode Header 0x40 Length 00 00 Pa[...]