Baracoda ScanWear Supplementary Manual Download Page 5

Page: 5 / 39

ToughRunners / ScanWear – Communication Protocol v1.1

- 5 -

Data Capture

for Workforce

in Motion

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

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

Summary of Contents for ScanWear

Page 1: ...Data Capture for Workforce in Motion ToughRunners ScanWear Communication Protocol Baracoda TM December 2008 ...

Page 2: ...NLY 9 3 4 RESTORE DEFAULT SETTINGS 10 3 5 MMI SETTINGS 10 3 6 BLUETOOTH COMMANDS 11 3 7 READING AND TRIGGERING COMMANDS 12 3 8 DECODER COMMANDS 16 3 9 DATA FORMAT COMMANDS 18 3 10 COMMUNICATION COMMANDS 23 3 11 POWER SAVING COMMANDS 23 4 SPECIAL PACKETS 25 4 1 DEPRECATED PACKETS 25 4 2 ACKNOWLEDGMENT PACKETS 25 4 3 SPECIAL SCANNER TO HOST MESSAGES 26 4 4 SPECIAL HOST TO SCANNER MESSAGES 26 5 APPEN...

Page 3: ... Data Capture for Workforce in Motion Revision History Revision History Revision History Revision History Changes to the original manual are listed below Document Date Description 1 0 25 sept 07 Initial release 1 1 16 Dec 08 Graphic Presentation updated ...

Page 4: ...ds Command 1 Command x Checksum ETX 1 byte 1 byte 1 byte 3 n bytes 3 n bytes 1 byte 1 byte 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 x b i i B mod 256 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...

Page 5: ...urance 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 Restore default settings 0x1 RESERVED 0x2 Firmware upgrade commands RESERVED 0x27 Start programming application AT89C51ED2 0x28 End programming 0x29 Clear firmware 0x2A Read...

Page 6: ...5E 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 symbology settings 0x82 Get voting value 0x83 Set voting value 0x84 Get scan beam timeout 0x85 Set scan beam timeout 0x9 RESERVED ...

Page 7: ...6 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 0xE RESERVED 0xF Power saving commands 0xF0 Get shutdown timers 0xF1 Set shutdown timers 0xF2 Get ba...

Page 8: ...d none Response 0 1 ERROR Command ID 0x02 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 3 2 3 2 3 2 Operational statistics Operational statistics Operational statistics Operational statistics Command ID 0x05 Description Retrieve operational statistics Length 0 payload none Response 10 bytes AAAABBBBCC where ...

Page 9: ...sponse 0 1 ERROR 3 3 3 3 3 3 3 3 W W W Wrist motion detection level rist motion detection level rist motion detection level rist motion detection level for BSW for BSW for BSW for BSW only only only 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 setting 1 easy Command ID 0x08 Description Set wrist mo...

Page 10: ...ts scanner Length 1 payload A 0 Response none 3 5 3 5 3 5 3 5 MMI settings MMI settings MMI settings MMI settings Command ID 0x40 Description Get vibrator Length 0 payload none Response ABC 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 0x41 Description Set v...

Page 11: ...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 ...

Page 12: ... Bd36 0x30 PIN Code 2 Bd37 0x30 PIN Code 3 Be 0x31 CheckSum x b i i B mod 256 0x01 0x5E x007 0x07 0x04 0x00 0x30 0x30 0x30 0x30 mod 0x100 0x131 mod 0x100 0x31 Bf 0x03 ETX 3 7 3 7 3 7 3 7 Reading and triggering commands Reading and triggering commands Reading and triggering commands Reading and triggering commands Command ID 0x60 Description Get reading mode Length 0 payload none Response ABCDEFGHI...

Page 13: ... 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 0x00 0x0A 0x00 0x00 0x00 ...

Page 14: ...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 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 t...

Page 15: ...iggering settings Length 0 payload none Response 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 Default settings 0xA1 0xA2 0xB1 0xB2 0xB3 0xC1 0xC2 ...

Page 16: ...imple 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 3 8 3 8 3 8 Decoder commands Decoder commands Decoder commands Decoder commands Command ID 0x80 Description Get symbology settings Length 0 payload none Response 17 bytes cf Appendix B for more details Default...

Page 17: ...tion Get voting value Length 0 payload none Response V number of decodes to validate a good scan 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 Description Get scan beam timeout Length 1 payload T timeout in seconds 255 Autoscan mode Default value 5 Response 0 1 ERROR Command ID 0x85 Descr...

Page 18: ...at commands Data format commands Command ID 0xA2 Description Get symbology prefix Length 0 payload None Response 22 bytes AABBCCDDEEFFGGHHIIJJKK 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 Codabloc F 0x00 means disabled Default settings 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0...

Page 19: ...Length 22 payload AABBCCDDEEFFGGHHIIJJKK 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 Codabloc F 0x00 means disabled Response 0 1 ERROR Command ID 0xA4 Description Get data suffix Length 0 payload None Response 0 32 bytes suffix Default settings No suffix ...

Page 20: ...d suffix Response 0 1 ERROR Command ID 0xA6 Description Get data prefix Length 0 payload None Response 0 32 bytes prefix Default settings No prefix Command ID 0xA7 Description Set data prefix Length 0 32 payload prefix Response 0 1 ERROR Command ID 0xA8 Description Get AIM symbology ID transmission Length 0 payload None Response A 0 disabled 1 enabled ...

Page 21: ...ion Set AIM symbology ID transmission Length 1 payload A 0 disabled 1 enabled Response 0 1 ERROR Command ID 0xAA Description Get symbology suffix Length 0 payload None Response 22 bytes AABBCCDDEEFFGGHHIIJJKK 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 ...

Page 22: ... 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 Command ID 0xAB Description Set symbology suffix Length 22 payload AABBCCDDEEFFGGHHIIJJKK 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 Codabloc F 0x00 means disabled Response 0 1 ERROR ...

Page 23: ...itch to slave when charging Bit A 1 1 if switch radio off when charging Default settings A 0x01 Command ID 0xD6 Description Set radio behavior when in charge Length 1 payload Bit A 0 1 if switch to slave when charging Bit A 1 1 if switch radio off when charging Response 0 1 ERROR 3 11 3 11 3 11 3 11 Power saving commands Power saving commands Power saving commands Power saving commands Command ID ...

Page 24: ...ings 0x04 0xB0 0x04 0xB0 0x04 0xB0 0x00 Command ID 0xF1 Description Set shutdown timers Length 7 payload AABBCCU Where AA scanner shutdown timer sec BB radio shutdown timer when in Master mode sec CC radio shutdown timer when in Slave mode sec U 0 unused Response 0 1 ERROR Command ID 0xF2 Description Get battery status Length 0 payload None Response 1 byte Bits A 0 6 battery level RFU Bit A 7 1 lo...

Page 25: ...sequence number X 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 Code ID Description Frame 0x16 SYN 0x16 1 X This message acknowledges the reception of a message to acknowledge with an unexpected sequence number X is the expected sequence number The device will resynchronize its remote sequence number when...

Page 26: ...4 Special host to scanner messages Special host to scanner messages Special host to scanner messages Special host to scanner messages Code ID 0x46 0x47 Description Get Capture Frame Format Payload None Response 1 byte 0 Baracoda 1 Baracoda ACK 2 Raw Default settings 0 Code ID 0x48 0x49 Description Set Capture Frame Format Payload 1 byte 0 Baracoda 1 Baracoda ACK 2 Raw Response 1 byte Bit 0 Success...

Page 27: ...d Answer Set PinCode 0x01 xx xx new pin size N digits PIN Default 0000 0x01 00 01 01 if done 0x01 00 01 00 if not Max Pin length 16 Command Header Length Payload Answer Get PinCode 0x07 00 00 N digits PIN Default 0000 0x07 PinCode size Pincode Command Header Length Payload Answer Set Name 0x02 xx xx new name size New name 0x02 00 01 01 if done 0x02 00 01 00 if not Names up to 20 Bytes Command Head...

Page 28: ...other device PC Access Point you will need to switch the clock role to allow the slave to be connected to more than one master Note that most of the BT access point already generate the BT clock role switch when a master device creates a connection In that case you don t need to specify this argument if you do it will cancel the Access Point clock switch and the result is as nothing was done Comma...

Page 29: ...art Module Local Services SPP only All other settings are not changed Command Header Length Payload Answer Get inquiry scan timeout 0x27 00 00 0x27 00 04 Inquiry Interval MSB Inquiry Interval LSB Inquiry Window MSB Inquiry Window LSB Inquiry Interval and Inquiry Window are in number of Bluetooth slots 1 slot 0 625 ms Command Header Length Payload Answer Set inquiry scan timeout 0x26 00 04 Inquiry ...

Page 30: ...l MSB Page Interval LSB Page Window MSB Page Window LSB default 0x320 0xb0 0x24 00 01 01 if done 0x24 00 01 00 if not Page Scan TimeOuts are used by the Module to answer to Connect Inquiries So if you set both values to 0 the Module will not be Connectable Typical values are Full power Inquiry Interval 0x400 Inquiry Window 0x200 Page Scan Interval 0x400 PageScan Window 0x200 Low power Inquiry Inte...

Page 31: ...nd Header Length Payload Answer Get sniff 0x10 00 00 0x10 00 08 MSB of MinSniff interval LSB of MinSniff interval MSB of MaxSniff interval LSB of MaxSnif interval Sniff Attempts MSB Sniff attempts LSB Sniff timeout MSB Sniff timeout LSB When setting only MinSniff and MaxSniff values the default value 0x08 will be used for Sniff attempts and Sniff timeout Typical values are Full speed full power Mi...

Page 32: ...d of 40s You will have very very low data rate Note This setting takes effect immediately Attempt Negociated Sniff For further details on Sniff values see the Bluetooth spec 1 1 chapter 10 8 2 Command Header Length Payload Answer Set link timeout 0x19 00 02 MSB of link Tmo LSB of link Tmo 0x19 00 01 01 if done 0x19 00 01 00 if not The link Time Out is a multiple of 625µsec 625µs 1 Bluetooth slot d...

Page 33: ...01 01 if secured 0x20 00 01 00 if non secured Command Header Length Payload Answer Get Bluetooth class of device 0x30 00 00 0x30 00 04 Class of Device See the Bluetooth spec for more details Typical Bluetooth class of device Peripheral 0x000500 default Undefined 0x001F00 Phone 0x502204 Computer 0x120104 PDA 0x100114 Access Point 0x120320 Command Header Length Payload Answer Set BT class of device ...

Page 34: ...0 01 00 if not Try to connect to this remote service Here are some service UUID SPP 0x1101 DUN 0x1103 FAX 0x1102 You can get more UUIDs by reading the Bluetooth spec Command Header Length Payload Answer Get Target Service UUID 0x39 00 00 0x39 00 02 UUID Command Header Length Payload Answer Set Encryption Mode 0x41 00 01 Encryption 1 Byte 0x41 00 01 01 if done 0x41 00 01 00 if not Argument is 0x01 ...

Page 35: ...0 01 00 if not Command Header Length Payload Answer Get Remote rfcomm channel 0x37 00 00 0x37 00 01 channel If channel is not zero the Module will directly try to connect if in master mode to the specified rfcomm channel Setting the channel to zero will force the Module to connect if in master mode to the first specified Remote Service UUID by default SPP The services in the Module are all set to ...

Page 36: ...0x08 16 OPC93 0x00 17 FNC1 0x1D COD1 Description Default b0 Reserved 0 b1 Enable MSI PLESSEY 0 b2 Enable Code 128 1 b3 Enable standard 2 5 0 b4 Enable CODABAR MONARCH 1 b5 Enable UPC EAN 1 b6 Enable interleaved 2 5 0 b7 Enable CODE 39 1 COD2 Description Default b0 unused 0 b1 unused 0 b2 unused 0 b3 unused 0 b4 Enable EAN 128 1 b5 Enable AIM ID for EAN128 0 b6 Disable EAN8 check digit transmission...

Page 37: ... not modify 0 b5 Reserved do not modify 1 b6 Reserved do not modify 0 b7 Reserved do not modify 0 Interleaved 2 of 5 parameters OP25I Description Default b0 Reserved do not modify 0 b1 0 0 1 fixed allowed length specified in LEI1 1 0 2 fixed allowed lengths specified in LEI1 and LEI2 0 1 3 fixed allowed lengths specified in LEI1 LEI2 and LEI3 1 1 any length allowed 4 1 b2 1 b3 Check digit not tran...

Page 38: ...ength allowed specify it in LES1 If two lengths allowed fill LES1and LES2 with positive values If zero is specified and the b1 b2 bits of OP25S are not 1 1 then the first standard 2 5 decoded barcode will fix the length CODABAR et PLESSEY parameters OPMON Description Default b0 Reserved do not modify 1 b1 Reserved do not modify 1 b2 Start Stop CODABAR 0 0 start stop abcd abcd 1 0 start stop ABCD A...

Page 39: ...transmit UPCE as EAN13 0 b3 0 transmit UPCA as EAN13 1 transmit UPCA as UPCA 1 b4 Reserved do not modify 0 b5 UPCE number system not transmitted 0 b6 Reserved do not modify 0 b7 EAN13check digit not transmitted 0 Code93 parameters OPC93 Description Default Reserved do not modify 0 EAN128 parameters FNC1 Description Default b0 b6 ASCII 0 à 127 GS replacment character 0x1D b7 FNC1 separator characte...

Search results

Summary of Contents for ScanWear

Reviews:

Related manuals for ScanWear

Brands by name

Popular brands

Baracoda ScanWear, Supplementary Manual

Search results

Summary of Contents for ScanWear

Reviews:

Related manuals for ScanWear

Brands by name

Popular brands