background image

 

 

4/14/2016 

 

D014465 CR1400 CR1000 CR2300 CR2600 CR3600 CR44X5 CR8000 CR900FD CR6000 CR5000 T500 Client Version ICD

 

 

 

Page 1 of 106

 

© 2013-2016 The Code Corporation 

 12393 South Gateway Park Place Suite 600, Draper, UT 84020 

 (801) 495-2200 

 FAX (801) 495-0280

 

C005066 

Interface Configuration Document For: 

CR900FD 

CR1000 

CR1000XHD 

CR1400 

CR1400XHD 

CR1428 
CR2300 
CR2600 

CR2600XHD 

CR3600 

CR3600DPM 

CR4405 
CR5000 

CR5000RTC 

CR6000 
CR8000 

T500

 

Firmware build 1206 (for CR5000 & CR5000RTC) 

Firmware build 5040 (for the T500) 

Firmware build 1174 (for all others) 

Summary of Contents for Code Reader CR3600 DPM

Page 1: ...outh Gateway Park Place Suite 600 Draper UT 84020 801 495 2200 FAX 801 495 0280 C005066 Interface Configuration Document For CR900FD CR1000 CR1000XHD CR1400 CR1400XHD CR1428 CR2300 CR2600 CR2600XHD CR3600 CR3600DPM CR4405 CR5000 CR5000RTC CR6000 CR8000 T500 Firmware build 1206 for CR5000 CR5000RTC Firmware build 5040 for the T500 Firmware build 1174 for all others ...

Page 2: ...der to Host Communication 8 6 1 Raw Data 9 6 2 Packet Data 9 7 Host to Reader Communication 13 7 1 Text Commands 13 7 2 Packetized Commands 14 7 3 Command Types 15 7 4 Prefix and Suffix Handling 25 8 File Installation 25 8 1 Simple Protocol 25 9 Reader Settings 26 9 1 Binary Dip Switch 26 9 2 Field of Interest 27 9 3 Reader Setting Persistence 27 9 4 Docked State Settings 28 9 4 1 Overview 28 9 4 ...

Page 3: ...D CR6000 CR5000 T500 Client Version ICD Page 3 of 106 2013 2016 The Code Corporation 12393 South Gateway Park Place Suite 600 Draper UT 84020 801 495 2200 FAX 801 495 0280 1 Keyword Table These keywords are used throughout the document to show relationships between settings ...

Page 4: ...t affect reading of barcodes with more than one part DataMatrix Data Matrix symbology DataRetention Settings that determine the behavior of data saved on the reader DataEncoding Settings that affect incoming outgoing data DefaultEvent Any settings that may affect default event behavior DPM Settings related to Direct Part Mark DuplicateBlock Settings related to blocking duplicate barcodes EAN JAN E...

Page 5: ...ature SimpleAV Settings that affect the Simple Age Verification feature on the CR5000 Stand Settings that affect reader behavior in a Stand StandDetect Settings related to detecting the Stand or table or the charging base as a Stand StandModes Settings that change based on entering or leaving the Stand table T500 Information and settings that relate to the T500 Reader Accessory Telepen Telepen sym...

Page 6: ...leased firmware for default values listed in Section 9 3 Notations The interface protocol is described as a set of grammars indicated by different type styles and symbols These indications are listed in the table below Example Indication Grammar Text Command Italic type Syntactic categories non terminals space Bold type Terminal symbols 0xFF 0x prefix indicating hexadecimal Literal byte values X S...

Page 7: ... creating and maintaining a set of commands that can be sent to the Reader The commands in the CRB file are immediately processed by the reader These CRB files can be created in any text editor with the file extension of crb The CRB system accepts all of the valid text commands There should be one command per line The CRB file may contain empty lines and comments prefixed with the semicolon charac...

Page 8: ...er Keyboard 0x0201 Reader IBM POS also known as IBM Handheld 0x0202 Reader HID Native also known as Downloader 0x0204 Reader Code VCOM 0x0205 M3 Modem Keyboard 0x0206 Reader HID POS 0x0207 M3 Modem DFU 0x0208 M3 Modem HID POS 0x0209 M3 Modem Keyboard bulk interface 0x020A T500 Cable Keyboard Used to communicate with CortexTools 0x0214 M3 Modem Code VCOM HID 0x0215 Reader CDC 0xFFFF M3 Modem Modem ...

Page 9: ...cket mode including data and packet overhead is a maximum of 16384 bytes Note The following acronyms from the ASCII character definitions are used below SOH Start of Heading 0x01 STX Start of Text 0x02 EOT End of Transmission 0x04 RS Record Separator 0x1E Language Part Definition packet start packet typenz dataopt end start packet startnr codeXML startnz packet start SOH X R protocol version Reade...

Page 10: ...ypad5 keypad6 keypad7 keypad8 keypad9 end codeXML endnz crc16nr codeXML end EOT crc16 big endian 16 bit number representing crc16 of the packet calculated over the entire packet excluding the crc16 itself See source files crc16 hc in Appendix Example CRC16 C Code for details on the crc16 algorithm and polynomials to be used The following packet types are defined a Append decode data indicates that...

Page 11: ...EM identifier D is the display type 0 is no display device YYYY is reserved HH is the hardware revision IIII is the hardware type identifier value in register 21B JJJJ is the boot application version KKKK is the operating system kernel version LLLL is the root file system version TAB is the ASCII TAB character Z Z is the OEM decoder version a null terminated string of printable ASCII characters m ...

Page 12: ...cket number 1 byte time stamp 4 bytes data size 2 bytes SOH X RS ap i VVV EOT crc16 2 bytes Figure 1 Example z and i Packets in Raw and Packet Modes Optionally whenever the Host receives a packet the Host will respond by sending a Y or R packet defined in the Host to Reader Communication section to the Reader If the expect response option is enabled in the Reader configuration the Reader will repe...

Page 13: ...ee Section 7 2 The command types are explained in Section 7 3 After the Host sends each complete command it should wait for a response packet from the Reader Expected responses are specified along with the command types in section 7 3 If the Reader responds with an e packet or doesn t respond within a reasonable timeout period the Host should resend the command a reasonable number of times 7 1 Tex...

Page 14: ...s text commands but disables echo and command responses See Section 7 3 Section 9 and Section 10 for additional information With text commands enabled the following two examples can be sent to a Reader in RS232 mode from HyperTerminal by just typing the example text Example 1 Make the Reader beep vibrate 3 times Note Readers with a vibration motor are the CR1400 CR1400XHD CR1428 CR2600 CR2600XHD C...

Page 15: ... defined per platform CR900FD CR1000 CR1000XHD CR2300 CR5000 CR5000RTC CR8000 Beep three times CR1400 CR1400XHD CR1428 CR2600 CR2600XHD CR3600 CR3600DPM CR6000 Beep and vibrate three times Note Readers with a vibration motor are the CR1400 CR1400XHD CR1428 CR2600 CR2600XHD CR3600 CR3600DPM and CR6000 Posts an event to the Reader data contains the event number as a single character See register C4 ...

Page 16: ...send any response 5 Indicates the end of a regular file download data contains the name of the file which is from 1 to 200 letters digits periods hyphens and underscores terminated with ASCII NUL The Reader will respond with d e or f 9 Requests the Reader to delete a file from its storage data contains the file name terminated with ASCII NUL Reserved no operation treated as a comment Causes the Re...

Page 17: ...d The Host CodeXML Modem is locked to a different Reader The Reader should indicate to the user that the packet has been rejected e g it may sound error beeps See related register 12F notify of packet rejection The Reader will not respond to the Host C Apply a value to a register on the reader and save the value data is in one of the following formats C XXX YYY where XXX is the register number and...

Page 18: ...der settings H Requires subcommand See below Lock Commands to lock and unlock the reader with a PIN Lock and Unlock the reader using the CR5000AV Configurator section of the Web Configuration Guide By default commands can be sent to the reader from a host such as CortexTools or CortexMobile even if the reader is locked Commands can also be sent to a locked reader by embedding them in a Keyed Confi...

Page 19: ...barcodes 1 Pick List Scan on trigger press use targeting LEDs otherwise The barcode must be near the center of the reader s field of view to be decoded Does not block duplicate barcodes 2 Detect Barcode Continuous scanning with IR illumination If a barcode is detected switch to red illumination Will not output the barcode a second time while it remains in the field of view 3 Detect Motion Continuo...

Page 20: ...operation is successful BOTH the reader and modem will blink the same pattern on the wireless indicator for the reader The pattern is two short blinks one long one short and a three second pause A short blink is approximately 0 5 seconds and a long blink is 1 second Example HAe d Disable Encryption Feature Disables packet data encryption In order for modem encryption mode to be disabled reader nee...

Page 21: ... Friendly Name Sends Bluetooth friendly name to wirelessly connected host f Set Friendly Name Friendly name follows the f up to 30 characters If more than 30 characters the name will be truncated Example HTfThis is a new name k Terminate Connection This command will terminate the active Bluetooth connection and clear the last connected index so that the T500 will not auto reconnect to the last hos...

Page 22: ... to the T500 when it has an existing connection It will not be discoverable to non paired hosts 2 All hosts may connect to the T500 when it is currently connected to another host Keywords T500 All other sub commands are reserved I Requests the Reader to send its information string no data The Reader will respond with i or e Optional Subcommands Is Retrieves Settings data Is scd s saved settings sa...

Page 23: ...ings P Put a value in a Reader register data contains a printable ASCII string in the following format hexadecimal register number in parentheses followed by a 32 bit signed integer value expressed in ASCII hexadecimal characters with optional minus sign or ASCII decimal characters preceded by the character e g 2e 1000 or 2e 4096 the specified integer replaces the existing register value The Reade...

Page 24: ...e has changed it may resend the previous data in a sequence of more than one packet T Requests the current date and time no data The Reader will respond with d with data containing the date and time formatted as yyyy mm dd hh mm ss W Requests the Reader to write its current settings from RAM to its non volatile memory The Reader will respond with d or e Note The W command saves changes that have b...

Page 25: ...nded ASCII values of 0x80 through 0xFF the characters must be encode as a 2 byte sequence starting with either 0xC2 or 0xC3 see http www fileformat info info charset UTF 8 list htm or http en wikipedia org wiki UTF 8 Exception if JavaScript is being bypassed during decoding then the prefix suffix may be in extended ASCII Example C suffix 01X 1ean n 04 will create a CodeXML sequence to send the sca...

Page 26: ...t encoding may be used for encoding a character as a sequence consisting of the percent character followed by two hexadecimal digits With percent encoding the example may be expressed as C 2E7F In Section 9 3 below the Reg column is the register number in hexadecimal to be used with the commands identified above In the Default column all values are in hexadecimal unless otherwise specified To use ...

Page 27: ... the High Density HD field and FOI 1 is the Wide W field At a given focus distance the FOI 0 field is designed to read small low mil barcodes while the FOI 1 field is designed to pick up large wide barcodes This document will refer to FOI 0 as HD and FOI 1 as Wide Note The CR900FD is a single Field of Interest reader There is no FOI 0 in the CR900FD 9 3 Reader Setting Persistence Some reader setti...

Page 28: ...s readers have an In Charger Event register and an Out of Charger Event register When the dock state of the reader changes the corresponding event from the register will be fired By default the events enable battery charge level indication when docked 3 The CR5000 CR5000RTC utilizes a set of Standard registers that have corresponding In Stand and Out of Stand registers for each The In Stand or Out...

Page 29: ...he In Stand or Out of Stand register s and then issue event 0xF2 to force the settings to take effect immediately Note that if the custom configuration barcode does not modify any of the In Stand or Out of Stand settings directly then event 0xF2 is not necessary As an example to create a custom configuration code that sets the beep volume of the CR5000 CR5000RTC to 30 at all times and configures t...

Page 30: ... during the Read Cycle this produces a little more flashing but reduces power consumption to a degree 1 Leave Illumination On Until End of the Read Cycle Leave illumination on during read 05 USB Declaration Wait State 0 0 Declare enumeration after receipt of set LED status report 1 Declare enumeration after receipt of get report descriptor command used for some Windows CE based devices 2 Declare e...

Page 31: ...led 1 Enabled Checksum checking must be enabled by setting bit 1 in order for checksum removal from the output setting bit 2 to have any effect Keywords 2Of5 0B Matrix 2 of 5 Symbology 0 Binary Dip Switch Bit Controls Value 0 Matrix 2 of 5 Decoding 0 Disabled 1 Enabled 1 Enable checksum checking 0 Disabled 1 Enabled 2 Remove checksum from the result 0 Disabled 1 Enabled Checksum checking must be e...

Page 32: ...Aztec symbologies Those symbologies must be enabled Keywords Aztec DataMatrix HanXin QR 16 Data Matrix Rectangular Symbology 1 0 Disabled 1 Enabled Note This register has no effect on a CR900FD without the proper 2D barcode decoding license Keywords DataMatrix 19 Data Matrix Symbology 3 Binary Dip Switch Bit Controls Value 0 Data Matrix Decoding 0 Disabled 1 Enabled 1 Inverse Data Matrix Decoding ...

Page 33: ...tooth Apple iOS Keyboard Mode 13 19 T500 Bluetooth Serial Port Profile SPP Mode 14 20 T500 Bluetooth HID Keyboard Mode This setting is used in conjunction with registers 08 and 42 to configure the communication mode between standard one way and two way modes For example USB two way native 1b 5 USB Native 08 2 packet mode 42 1 expect response Note To switch from USB keyboard mode to Downloader mode...

Page 34: ...ywords SerialComm 1D Serial Stop Bits 1 1 Send 1 Stop Bit 2 Send 2 Stop Bits Keywords SerialComm 1E Serial Data Bits 8 7 7 Data Bits 8 8 Data Bits Keywords SerialComm 1F Serial Flow Control 0 0 Disabled 1 Hardware Note Undefined behavior will result if this setting is enabled when Output Good Read on RTS 0x02F1 is enabled Keywords SerialComm 22 Serial Parity 0 0 None 1 Odd 2 Even Keywords SerialCo...

Page 35: ... QR Code Symbology 1 Binary Dip Switch Bit Controls Value 0 QR Code Standard Decoding 0 Disabled 1 Enabled 1 QR Code Inverse Decoding 0 Disabled 1 Enabled 2 Micro QR Code Decoding 0 Disabled 1 Enabled 3 Unused 0 Disabled 1 Enabled 4 QR Code Mirror Decoding 0 Disabled 1 Enabled 5 Model 1 QR Code Decoding 0 Disabled 1 Enabled Note This register has no effect on a CR900FD without the proper 2D barcod...

Page 36: ...re it may seem that the timer is longer than the value set Bluetooth readers This timer only applies if in the charging unit and will get added to register 32 to get the time to idle state from active mode Keywords ReaderState 2D Keyboard Maps 0 CR5000 CR5000RTC 2 Set the Keyboard Map by reading a Keyboard Language Settings barcode from the http codecorp com ConfigGuide The corresponding Keyboard ...

Page 37: ...the firmware will write a keyboard profile file containing the name of the keyboard map in corresponding to the legacy value and set this register value back to 2 according to the table below When 2D is set to A keyboard profile file will be written and reference this XML file Register 2D3 will be set to 0 English xml The legacy KB map 0 1 USInternational_Win xml 0 2 No change No change 3 USEnglis...

Page 38: ...s longer than the value set Bluetooth readers This is the time from active mode to idle mode when the unit is not in the charger If in the charger this gets added to register 2C to get the time from active to idle Bluetooth readers this state Active High power usage Bluetooth readers next state Idle Keywords ReaderState 33 Target Time Before Decode ms 0 Valid Range 0 to 7FFFFFFF Milliseconds This ...

Page 39: ...ts Keywords DefaultEvent 3A Trigger 2 3 For the CR2600 CR2600XHD and CR2300 trigger 2 is the button towards the front on the top of the reader For the CR3600 trigger 2 is the button to the right of the center navigation buttons Note Register C4 contains the list of valid events Keywords DefaultEvent 3B Trigger 3 0 The combination of pressing buttons defined by trigger 1 and trigger 2 being pressed...

Page 40: ...Hex Comment 3F Trigger 7 0 The combination of pressing buttons defined by trigger 1 trigger 2 and trigger 4 being pressed simultaneously Note Register C4 contains the list of valid events Keywords DefaultEvent 40 Text Command Timeout ms 2AF8 11000 Valid Range 0 to 7FFFFFFF Milliseconds The maximum time during which a complete text command from Host must be received Pending text command data is dis...

Page 41: ... 3 Disable Text Commands but Enable Magic Sequence See Below 0 Disabled 1 Enabled 4 Suppress URL Decode See Below 0 Disabled 1 Enabled 5 Accept On Timeout 0 Disabled 1 Enabled Magic Sequence The Magic Sequence is the string PAx where x is 1 3 or 7 as defined above This would normally be used in command text files which would begin with the text command on sequence and end with the command to retur...

Page 42: ...native 1B 5 USB Native 08 2 packet mode 42 1 expect response Persistence Protected Keywords Communications 43 JPEG Picture Quality percent 32 50 Valid Range 0 to 64 100 Percent 0 Raw Image No JPEG Compression 1 To 100 JPEG Compression Quality Percent Keywords PictureSettings 46 Prefix With Timestamp 0 47 MaxiCode Symbology 0 Binary Dip Switch Bit Controls Value 0 MaxiCode Decoding Mode 0 0 Disable...

Page 43: ...and output checksum character if one exists 1 Enable checksum checking and output checksum character 2 Enable checksum checking and remove checksum character from output If this register is set to a value greater than zero and no checksum is present in the barcode or the checksum is incorrect the barcode will not read Keywords Codabar 49 Code 39 Full ASCII Symbology 0 0 Disabled 1 Enabled Code 39 ...

Page 44: ...X 801 495 0280 Reg Setting Name Default Hex Comment 4B Postal Barcode Symbology 0 Binary Dip Switch Bit Controls Value 0 USPS Postnet 0 Disabled 1 Enabled 1 USPS Planet 0 Disabled 1 Enabled 2 USPS Intelligent Mail 0 Disabled 1 Enabled 3 Australia Post 0 Disabled 1 Enabled 4 Dutch Post KIX 0 Disabled 1 Enabled 5 Japan Post 0 Disabled 1 Enabled 6 UK Royal Mail 0 Disabled 1 Enabled 7 UPU ID tags 0 Di...

Page 45: ...ataBar Expanded Stacked decoding 0 Disabled 1 Enabled 2 GS1 DataBar Limited decoding 0 Disabled 1 Enabled 3 GS1 DataBar Omnidirectional and GS1 DataBar Truncated decoding 0 Disabled 1 Enabled 4 GS1 DataBar Stacked and GS1 DataBar Stacked Omnidirectional decoding 0 Disabled 1 Enabled Keywords GS1Databar 4D UPC Expansion 0 0 Disabled 1 Enabled This register enables converting UPC E output to UPC A f...

Page 46: ...is is a value based setting Calculate and compare checksums of this type and or removal of the checksum See examples below 0 Disabled checksum checking 1 One Byte Modulus 10 2 One Byte Modulus 10 One Byte Modulus 11 3 Two Bytes Modulus 10 4 reserved 5 One byte Modulus 10 then strip 6 check modulus 10 11 then strip 7 check two modulus 10 then strip 5 UK Plessey original 0 Disabled 1 Enabled Example...

Page 47: ...I 0 Width 280 640 Valid Range 1 to 640 pixels Decoder uses only the specified pixel width in the HD field FOI 0 See section 9 2 Note The High Density field FOI 0 does not exist on the CR900FD 54 Decoder HD field FOI 0 Height 3C0 960 Valid Range 1 to 960 pixels Decoder uses only the specified pixel height in the HD field FOI 0 See section 9 2 Note The High Density field FOI 0 does not exist on the ...

Page 48: ...t uses the same encoding as Code 39 and can be decoded as Code 39 with unintended data when Code 32 is not enabled It is not necessary to enable Code 39 to enable Code 32 Keywords Code39 PharmaCode 6C Code 93 Symbology 1 0 Disabled 1 Enabled 6D Code 128 Symbology 1 0 Disabled 1 Enabled 6E Interleaved 2 Of 5 Symbology 1 0 Disabled 1 Enabled Keywords 2Of5 Interleaved2Of5 6F Codabar Symbology 1 0 Dis...

Page 49: ...ro and no checksum is present in the barcode or the checksum is incorrect the barcode will not read Keywords 2Of5 Interleaved2Of5 72 Auto Stored Data Erase Auto Log Erase 1 0 Disable 1 Enable Note When Enabled data and images are cleared from nonvolatile memory when they are successfully uploaded to the Host In Log mode this is set to Disabled Note Only applies to readers using Bluetooth communica...

Page 50: ...ed on auto reconnect will be turned off if it is on Keywords DataRetention 78 Settings Lock 1 1 Settings unlocked 3 Settings locked except settings Lock 85 Tri Optic Options 0 Binary Dip Switch Bit Controls Value 0 Tri Optic Decoding Normal Quiet Zones 0 Disabled 1 Enabled 1 Allow Short Quiet Zones 0 Disabled 1 Enabled 2 No Quiet Zones Required 0 Disabled 1 Enabled 3 Reverse order of first and sec...

Page 51: ...odes Keywords ReaderState 8C USB Virtual COM Common Mode 1 0 Disabled 1 Enabled This and every other reader in USB VCOM Mode with USB Virtual COM Common Mode enabled will use a common VCOM port on the host PC Any reader in USB VCOM Mode with this setting disabled will use a unique VCOM port on the host PC Persistence Protected Note This setting is only valid for CR8000 1000 1400 900FD 6000 and can...

Page 52: ...art another read cycle if it isn t This setting does not suppress beeps for anything but a successful decode event Keywords Beep 98 Decoder HD field FOI 0 X Offset 0 Valid Range 0 to 639 pixels Decoder uses the pixels after the specified pixel offset in the HD field FOI 0 See section 9 2 Note The High Density field FOI 0 does not exist on the CR900FD 99 Decoder HD field FOI 0 Y Offset 0 Valid Rang...

Page 53: ... of the barcode s smaller dimension For example with a 10 x 20 mm barcode and a setting of 150 the barcode must be within 15 mm of the center of the image Any value over 1000 is considered infinite tolerance and no target checking is performed Keywords StandModes 9E Extra Cabled Idle Time CR2300 CR2600 CR2600XHD CR3600 CR3600DPM 2710 10000 CR4405 500 This is the time added to the idle timeout regi...

Page 54: ...mand C 9F 1 Standby Mode is the time after the Idle Mode Countdown Timer has expired and before the Standby Mode Countdown Timer has expired There are many user and firmware events that will reset the timer or send the reader back into a higher power mode therefore it may seem that the timer is longer than the value set Note Only applies to readers using Bluetooth communication modes Keywords Read...

Page 55: ...virtual image i e not the rotated physical image Note On a Code Reader overall image is 960 pixels by 1280 pixels Upper half is Wide field FOI 1 lower half is High Density FOI 0 The High Density field FOI 0 does not exist on the CR900FD Keywords PictureSettings AD Wide field FOI 1 Picture Window Upper Position 0 Specify upper edge of window used with take picture The position and size are relative...

Page 56: ...image is 960 pixels by 1280 pixels Upper half is Wide field FOI 1 lower half is High Density FOI 0 The High Density field FOI 0 does not exist on the CR900FD Keywords PictureSettings B0 Target On Before Picture ms 3E8 1000 Valid Range 0 to 7FFFFFFF Milliseconds 0 Target off before picture capture Keywords PictureSettings B3 Number Of Retries Before Reader Gives Up Sending Packet 3 Valid Range 0 to...

Page 57: ...tion F0 is selected as the default event Event numbers same as register 39 0 No Action 1 Keep Awake 2 Show Target 3 Read In Both Fields Default 5 Read In High Density field FOI 0 See section 9 2 Note The CR900FD does not have a High Density field FOI 0 6 Read In Wide field FOI 1 See section 9 2 7 Take Picture 8 Read In Most Recently Successful Field 0D to 50 13 To 80 Custom events handled by JavaS...

Page 58: ...nect when there is data to send but only within specified time of last valid connection 3 Auto Connect If Cabled attempt to connect if Reader is cabled or in charger Bluetooth readers Also see register 76 Reader will not allow the user to set auto reconnect on and store data If any setting that allows storing data is turned on auto reconnect will be turned off if it is on Keywords DataRetention C7...

Page 59: ...hout support for small quiet zones Examples To set length to 8 and To enable small quiet zone set C9 to 9 8 1 To disable small quiet zone set C9 to 8 8 0 To set length to E 14 and To enable small quiet zone set C9 to F 15 E 1 To disable small quiet zone set C9 to E 14 E 0 Bit Controls Value 0 Small Quiet Zone 0 Disabled 1 Enabled 6 1 Number of Digits Must be even and 64 100 or less 31 7 Reserved K...

Page 60: ...Reader will attempt connection for up to this amount of time when a connection is explicitly requested such as when a QuickConnect Barcode is read or an upload is requested by event or command Note Only applies to readers using Bluetooth communication modes DB Merge Selected Decodes 0 0 Disabled 1 Enabled When enabled multiple valid decodes from a single read are concatenated This includes Composi...

Page 61: ...t combinations of triggers e g trigger 3 which is trigger 1 2 asserted together E8 Trigger 6 Confirmation Time ms 0 Valid Range 0 to 7FFFFFFF Milliseconds The trigger input must be asserted for this amount of time before the trigger event is generated Setting this value 0 makes it easier to select combinations of triggers e g trigger 3 which is trigger 1 2 asserted together E9 Trigger 7 Confirmati...

Page 62: ... Enabled Note The firmware determines whether one digit or two digit checksum should be checked internally F8 PharmaCode Symbology 0 See Section Error Reference source not found HYPERLINK l _PharmaCode PharmaCode for more details Binary Dip Switch Bit Controls Value 0 PharmaCode decoding 0 Disabled 1 Enabled 1 Support color bar 0 Disabled 1 Enabled 3 Reverse instead of Normal direction 0 Disabled ...

Page 63: ... last radio query the cached status is returned Otherwise the Reader will query the radio for connection status which takes up to 1 second Note Only applies to readers using Bluetooth communication modes 10D Grid Matrix Symbology 0 Binary Dip Switch Bit Controls Value 0 Grid Matrix 0 Disabled 1 Enabled All other bits are reserved 12D Hong Kong 2 Of 5 Symbology 0 Binary Dip Switch Bit Controls Valu...

Page 64: ... blocked for this amount of time in milliseconds 0 turns off blocking of duplicate barcodes Note For the CR5000 CR5000RTC only the reader will continue to block duplicate barcodes as long as it continues to detect the barcode and until the barcode has been removed for the ignore duplicate barcode time if the time is not 0 In other words for the CR5000 CR5000RTC to scan the same barcode twice the b...

Page 65: ... illuminated and the pulse width of the good read signal on RTS Keywords GoodReadRTS 1F7 Platform configure buttons and Stand Detection 42 66 CR2600 CR2600XHD CR2300 CR3600 CR3600DPM 2a 42 CR4405 2 Binary Dip Switch Bit Controls Value 1 Button 1 Enable 0 Disabled 1 Enabled 3 Button2 Enable 0 Disabled 1 Enabled 5 Button4 Enable 0 Disabled 1 Enabled 6 Enable Stand Detection 0 Disabled 1 Enabled Note...

Page 66: ...ols Value 1 CR6000 Illumination 0 Dark Field illumination 1 Diffuse Bright Field 2 2 Direct Bright Field 3 Dark Field and Diffuse Bright Field Keywords DPM MotionDetection 21B Reported Board Type See Comment column Valid Range 1 to 9999 The firmware will report this number as the hardware type identifier field of the reader information string Reader Type Value CR900FD 384 900 CR1000 7 CR1000XHD 7 ...

Page 67: ... data are blocked for this amount of time in milliseconds 0 turns off blocking of duplicate barcodes Note Not used in the CR5000 CR5000RTC reader Keywords DuplicateBlock 21D USB Speed 0 0 High Speed 1 Full Speed Speed at which USB Connection is made Keywords Communications 235 In Charger Event 0 CR2300 CR2600 CR2600XHD CR3600 CR3600DPM CR4405 E0 224 This event will be triggered when the reader is ...

Page 68: ... USB VCOM Connection Delay ms 0 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds This is the additional amount of time that the reader will wait after connecting before sending data The delay will only be used with the associated communication mode Keywords Communications 246 USB HIDPOS Connection Delay ms 0 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds This is the additional amount of time t...

Page 69: ...aper UT 84020 801 495 2200 FAX 801 495 0280 Reg Setting Name Default Hex Comment 24A Han Xin Barcode 0 Binary Dip Switch Bit Controls Value 0 Enable Disable Han Xin 0 Disabled 1 Enabled Note This register has no effect on a CR900FD without the proper 2D barcode decoding license Keywords HanXin 24F Decoding Extras 0 This is a bitmask that enables additional decode data post processing Binary Dip Sw...

Page 70: ...PC 0 Disabled 1 Enabled 5 Removes UPC A number system digit Keywords UPC 0 Disabled 1 Enabled 6 Removes UPC E check digit Keywords UPC 0 Disabled 1 Enabled 7 Removes UPC E number system digit Keywords UPC 0 Disabled 1 Enabled 8 Removes EAN JAN 13 check digit Keywords EAN JAN 0 Disabled 1 Enabled 9 Removes EAN JAN 8 check digit Keywords EAN JAN 0 Disabled 1 Enabled 10 Convert EAN 8 to EAN 13 Keywor...

Page 71: ...ail check character Keywords Postal 1 Enabled 18 Remove error correction code words from Australia Post output Keywords Postal 0 Disabled 1 Enabled 250 Korean Post Symbology 0 Binary Dip Switch Bit Controls Value 0 Enable Korean Post 0 Disabled 1 Enabled Keywords Postal 251 Background Transmit Enable 1 CR4405 0 0 Disabled 1 Enabled If Enabled use background transmit feature With this enabled user ...

Page 72: ...nabled 6 Dot peen light on dark DPM license required Keywords DPM 0 Disabled 1 Enabled 7 Laser chemical etch DPM license required Keywords DPM 0 Disabled 1 Enabled 11 Robust Inkjet DPM Keywords DPM 0 Disabled 1 Enabled 12 Light DPM fast reading of all 1D 2D and high contrast DPM Keywords DPM 0 Disabled 1 Enabled Note All other bits are Reserved 25B Bluetooth Keyboard Discoverable Time sec 1E 30 Va...

Page 73: ...Define that the input encoding is UTF 8 and convert the UTF 8 to Unicode code points Keywords DataEncoding KeyboardMap 270 Requested Download Memory Allocation Size 0 This is the optimal amount of memory to allocate for the current file download to the reader Persistence Reset on boot 271 Connection Delay ms iAP2 External Accessory mode 0 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds This is t...

Page 74: ...Voltage mV 0 CR4405 ED8 3800 If the reader automatically sleeps because of a low battery it will wake automatically if the battery voltage goes above this level Note Supported on CR4405 only Keywords Battery 27B Cabled Event 0 CR4405 E1 225 This event will be triggered when the reader is connected via a cable See register C4 for a list of events Note Supported on CR4405 only 27C Uncabled Event 0 C...

Page 75: ...4405 only Keywords Battery 284 Device Battery Charge Mode 2 Defines the way in which the reader will attempt to charge a connected device phone All power schemes involving charging the device will stop charging when the critical sled battery level is reached register 282 0 Do not charge 1 Keep phone fully charged 2 Managed Power Scheme Never charge device phone if sled battery is below value in re...

Page 76: ...000 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds If this amount of time ms elapses without a device battery update only the sled battery percentage is used to determine whether the device charging state should be changed Note Supported on CR4405 only Note Applies to Device Battery Charge Mode 284 option 2 only Keywords Battery 288 Full Battery Level 5F 95 Valid Range 0 to 64 100 Percent Used ...

Page 77: ...ry Pre Indicate Period ms 1F4 500 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds When indicating a medium battery and not charging this is the time between the triggering event such as a button press and the first blink Note Supported on CR4405 only Keywords Battery 28E Medium Battery Indicate Period ms 1F4 500 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds When indicating a medium battery a...

Page 78: ...play in the color sequence see register 298 Note Supported on CR4405 only Keywords Battery 293 High Battery Charging Indicate Period ms 1F4 500 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds When indicating a high but not yet fully charged battery while charging this is the duration of each LED color display in the color sequence see register 299 Note Supported on CR4405 only Keywords Battery 2...

Page 79: ...0 Draper UT 84020 801 495 2200 FAX 801 495 0280 Reg Setting Name Default Hex Comment 296 High Battery Charging Post Indicate Period ms 1F4 500 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds When indicating a high but not yet fully charged battery while charging this is the time between LED color sequences which are defined in register 299 Note Supported on CR4405 only Keywords Battery Charging ...

Page 80: ...13 2016 The Code Corporation 12393 South Gateway Park Place Suite 600 Draper UT 84020 801 495 2200 FAX 801 495 0280 297 Low Battery Charging Indicate Color 1 Color to display when charging the battery and the battery is low 1 red 2 yellow 4 green All other values are invalid Note Supported on CR4405 only Keywords Battery Charging ...

Page 81: ...oration 12393 South Gateway Park Place Suite 600 Draper UT 84020 801 495 2200 FAX 801 495 0280 Reg Setting Name Default Hex Comment 298 Medium Battery Charging Indicate Color 2 Color to display when charging the battery and the battery is medium 1 red 2 yellow 4 green All other values are invalid Note Supported on CR4405 only Keywords Battery Charging ...

Page 82: ... 4 green All other values are invalid Note Supported on CR4405 only Keywords Battery Charging 29B Device Battery Maintenance Level 64 100 Valid Range 0 to 64 100 Percent Only applies to charging mode 3 in charging mode register 284 Value at which charging scheme attempts to keep the device battery level Note Supported on CR4405 only Keywords Battery 29C Device Battery Critical Level 19 25 Valid Ra...

Page 83: ...e 0 to 64 100 Percent Reader will report 0 battery capacity if the actual battery drops below this percent Keywords Battery 29F Upper battery percent scaling 64 100 CR4405 5A 90 Valid Range 0 to 64 100 Percent Reader will report 100 battery capacity if the actual battery rises above this percent Keywords Battery 2A3 Code 49 Symbology 0 0 Disabled 1 Enabled 2A8 Use demo script 0 CR3600 1 0 Disabled...

Page 84: ...is level the sled will stop providing power to the iPhone Note This will cause a communications failure between the iPhone and the USB host but it is necessary to prevent sled reboots that would also cause communications failures Note Supported on CR4405 only Keywords Battery 2B0 USB pass through mode hysteresis battery capacity percent 19 25 Valid Range 0 to 64 100 Percent When in USB pass throug...

Page 85: ...havior 0 Use the same as the CR5000 CR5000RTC quick decode behavior 1 Use red illumination fixed 20 IR 2 Use red illumination fixed 30 IR 3 Use red illumination only Note Applies to CR5000 CR5000RTC only All other readers will ignore this register Keywords AGC AGCMode DPM 2B4 Public Sector Behavior 0 Binary Dip Switch Bit Controls Value 0 Enable public sector parsing 0 Disabled 1 Enabled 1 Enable ...

Page 86: ...ents Keywords DefaultEvent 2B9 Trigger 4 Release Event 0 If non zero the specified event is generated when this button is released Note Register C4 contains the list of valid events Keywords DefaultEvent 2BA Trigger 5 Release Event 0 If non zero the specified event is generated when this button is released Note Register C4 contains the list of valid events Keywords DefaultEvent 2BB Trigger 6 Relea...

Page 87: ...ndModes StandDetect DefaultEvent 2BF Out of Stand Event 0 CR2300 CR2600 CR2600XHD CR3600 CR3600DPM F2 242 CR5000 CR5000RTC F5 245 This event will be posted when the reader is removed from its stand See register C4 for a list of events Note Applies to Bluetooth and CR5000 CR5000RTC readers only Keywords Stand StandModes StandDetect DefaultEvent 2C0 In Stand Target Tolerance 640 1600 When the reader...

Page 88: ...ault Event FF 255 CR5000 CR5000RTC 2 When the reader is removed from the stand for CR5000 CR5000RTC when it is lifted up and Stand Detection is enabled register C4 will be set to the value in this register See register C4 for a list of events Note Applies to Bluetooth and CR5000 CR5000RTC readers only Also see registers 1F7 to enable Stand Detection 2AB to define the charging base as a Stand and C...

Page 89: ...e since the last scancode sent over a keyboard interface this setting is used when the scancode to be sent is not a release scancode Any value below 3 ms will have no noticeable effect Keywords InterCharacterDelay 2C8 Keyboard minimum inter scancode delay release scancode ms 0 Valid Range 0 3 to 7FFFFFFF 2147483647 Milliseconds Require at least this amount of time since the last scancode sent over...

Page 90: ...led 1 Enabled Keywords DuplicateBlock Stand 2CB iPhone Onscreen Keyboard Release Delay ms 7D0 2000 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds When the iPhone receives keyboard data from the sled the onscreen keyboard will disappear before sending the first character and reappear after receiving the last character This setting is the number of milliseconds that the onscreen keyboard will rem...

Page 91: ...ickConnect Barcode special operation 16 30 QuickConnect Barcode parameter QuickConnect Barcode special operation 0 No special operation behavior 1 Override communication protocol in 1 way mode 2 Override communication protocol in 2 way mode 3 Post an event QuickConnect Barcode parameter For special operations 1 and 2 this parameter is the desired communication protocol see register 08 For special ...

Page 92: ...ut applying any pattern detection value as 0 the reader will capture an image for decoding when any motion is detected When Basic pattern detection is not sensitive enough for some cases you can turn both Basic and Advance pattern detection ON value as 3 In this situation most of the cases will be detected by the Basic pattern detection with fast response time and the Advance pattern detection can...

Page 93: ... 90 Percent This setting limits the available storage to a percentage of the total storage It is not recommended to increase this threshold greater than 90 2D3 Control Character Input Method 0 This setting defines the input method in which Control Characters are sent when in keyboard mode 0 Language Default 1 Ctrl Character 2 Alt Keypad 3 Alt Leading Zero Persistence Preserved Note The language de...

Page 94: ...rs only Keywords Stand StandModes 2DF In Stand Ignore Duplicate Barcode ms 258 600 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds When the reader is placed on a surface and Stand Detection is enabled register 159 will be set to the value in this register The CR5000 CR5000RTC does not use register 21C the extended duplicate block time Note Applies to CR5000 CR5000RTC readers only Keywords Stand ...

Page 95: ...ywords Stand StandModes 2E4 Illuminate on Motion Duration ms 3E8 1000 Valid Range 0 to 7FFFFFFF 2147483647 Milliseconds Period of time that quick decoding will be disabled and illumination will occur after detecting motion if Illuminate on Motion is enabled Note Applies to CR5000 CR5000RTC readers only Keywords Stand StandModes 2E5 Stand Alone Age Verification Primary Age 15 21 Valid Range 0 to 10...

Page 96: ...Settings 231 Note Applies to CR5000 CR5000RTC readers only Keywords Stand StandModes 2F0 Output Encoding of Unicode converted input 0 This setting determines output encoding of decoded data that was previously converted to Unicode code points This register is ignored if no conversion was made Value Description 0 Send Unicode data using Keyboard XML lookup Keywords KeyboardMap 1 Send Unicode data u...

Page 97: ...m the host including CortexTools CortexMobile or custom applications based on the CodeUtil library This includes applications written for PC Apple Android and Windows Mobile Keywords SettingsLock 2FF Reject PDF417 in AV Mode 1 0 Disabled 1 Enabled When this register is enabled a reader in SimpleAV mode will reject all PDF417 barcodes which the decoder determines are not valid Driver License data N...

Page 98: ...r the reader is locked Keywords SettingsLock 10 Radio Commands The Host controls the radio by issuing commands The following tables describe the available commands Command numbers less than 0x80 are Bluetooth commands The column is the radio command number in hexadecimal to be used with the command For example 0E gets the Bluetooth device address The bytes column indicates how many bytes of data a...

Page 99: ...iendly name 0F Get device s user friendly name Example 0F 0 Clear Connection History 12 Clears the connection history Bluetooth addresses link keys etc It is recommended that the reader be rebooted after this operation 0 Set Bluetooth PIN 14 Sets the Bluetooth PIN up to 16 characters Default is 0000 Example 14abcd set Bluetooth PIN to abcd If the pin is being used with register 173 to connect to a...

Page 100: ...ndard rules for all bars Horizontally and vertically oriented symbols are decoded Decoding is performed in the normal direction left bars more significant than right bars for horizontal symbols top bars more significant than bottom bars for vertical symbols 3 Enable PharmaCode decoding Color bars expected relaxed contrast rules for the three least significant bars Horizontally and vertically orien...

Page 101: ... This CRC16 consists of two consecutive bytes each in range 0 255 most significant byte first A CRC16 is calculated on each packet byte over the entire packet excluding the prefix and the CRC16 itself crc_t crc 0 send firstByte crc crc crc firstByte firstByteSize send secondByte crc crc crc secondByte secondByteSize send crcHighByte send crcLowByte crc16 h ifndef crc16_h define crc16_h include std...

Page 102: ...3 2016 The Code Corporation 12393 South Gateway Park Place Suite 600 Draper UT 84020 801 495 2200 FAX 801 495 0280 include crc16 h crc_t crc crc_t initialCrc const unsigned char p size_t n enum crcBits 16 charBits 8 diffBits crcBits charBits crc_t c initialCrc include crc16tab h while n c c charBits crcTab c diffBits p return c eof ...

Page 103: ...0x1a71 0x0a50 0x3a33 0x2a12 0xdbfd 0xcbdc 0xfbbf 0xeb9e 0x9b79 0x8b58 0xbb3b 0xab1a 0x6ca6 0x7c87 0x4ce4 0x5cc5 0x2c22 0x3c03 0x0c60 0x1c41 0xedae 0xfd8f 0xcdec 0xddcd 0xad2a 0xbd0b 0x8d68 0x9d49 0x7e97 0x6eb6 0x5ed5 0x4ef4 0x3e13 0x2e32 0x1e51 0x0e70 0xff9f 0xefbe 0xdfdd 0xcffc 0xbf1b 0xaf3a 0x9f59 0x8f78 0x9188 0x81a9 0xb1ca 0xa1eb 0xd10c 0xc12d 0xf14e 0xe16f 0x1080 0x00a1 0x30c2 0x20e3 0x5004 0...

Page 104: ...wing sample C code This CRC14 consists of two consecutive bytes each in range 0 127 most significant byte first A CRC16 is calculated on each packet byte over the entire packet excluding the prefix and the CRC16 itself Bitwise AND each byte of the CRC16 checksum with 0x7F to generate the two bytes of the CRC14 checksum crc_t crc 0 send firstByte crc crc crc firstByte firstByteSize send secondByte ...

Page 105: ...default code set used for mapping to scancodes version optional user supplied version of the mapping Data none Example characterMapping id ascii version 1 Copyright Attributes value optional user supplied copyright information Data none Example Copyright value Copyright c 2013 The Code Corporation history Attributes none Data modified tags Example history modified version 1 date 2013 message modif...

Page 106: ...Copyright c 2013 The Code Corporation history modified version 1 date 2013 04 19 Original table modified modified version 2 date 2013 04 26 Removed inputs above 0xFF modified history Language name English id 00 revision 0 1 author Mark Alan Ashby initials MAA Input encoding ASCII value 0000 printable action none Scancodes condition none Scancode value 00 modifier 04 Scancode value 62 modifier 04 S...

Reviews: