QX Hawk Industrial Imager User’s Manual P/N 83-006800 Rev B
Copyright and Disclaimer Copyright ©2010 Microscan Systems, Inc. ISO 9001 Certified Issued by TüV USA All rights reserved. The information contained herein is proprietary and is provided solely for the purpose of allowing customers to operate and/or service Microscan manufactured equipment and is not to be released, reproduced, or used for any other purpose without written permission of Microscan. Throughout this manual, trademarked names might be used.
Introduction Table of Contents Chapter 1 Quick Start Step 1 Check Hardware .......................................................................... 1-2 Step 2 Connect the System ..................................................................... 1-3 Step 3 Position the Imager ...................................................................... 1-4 Step 4 Install ESP.................................................................................... 1-5 Step 5 Select Model ..........................
Table of Contents Diagnostics .......................................................................................... 5-175 Chapter 6 Terminal Terminal Window..................................................................................... 6-2 Find ......................................................................................................... 6-3 Send ........................................................................................................ 6-4 Macros.......................
Introduction About the QX Hawk Industrial Imager The key features of the QX Hawk Industrial Imager are: • • • • • • • • • • Fully integrated liquid lens technology, allowing infinite focus flexibility High-resolution modular optical zoom system Simple plug-and-play connectivity with Ultra-Lock™ cordsets and connectors Best-in-class X-Mode™ algorithms Embedded Ethernet TCP/IP A green flash (visible from all angles) to signal a successful read LED array for performance, communication, and I/O user feedback
Warning and Caution Summary Warning and Caution Summary This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses, and can radiate radio frequency energy, and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communication.
Introduction Statement of Agency Compliance The QX Hawk has been tested for compliance with FCC (Federal Communications Commission) regulations and has been found to conform to all applicable FCC Rules and Regulations. To comply with FCC RF exposure compliance requirements, this device must not be co-located or operate in conjunction with any other antenna or transmitter.
Statement of RoHS Compliance Statement of RoHS Compliance All Microscan readers with a ‘G’ suffix in the FIS number are RoHS-Compliant. All compliant readers were converted prior to March 1, 2007. All standard accessories in the Microscan Product Pricing Catalog are RoHS-Compliant except 20-500013-01 and 98-000039-02. These products meet all the requirements of the European Parliament and the Council of the European Union for RoHS compliance.
1 Quick Start Contents Step 1 Check Hardware................................................................................................................ 1-2 Step 2 Connect the System .......................................................................................................... 1-3 Step 3 Position the Imager............................................................................................................ 1-4 Step 4 Install ESP ........................................................
Check Hardware Step 1 — Check Hardware Item 1 2 3 4 5 6 7 8 Description QX Hawk Industrial Imager QX-1 Interface Device QX Cordset, Common, M12 12-pin Plug to M12 12-pin Socket, 1 m QX Cordset, Host, Serial, M12 12-pin Plug to DB9, 1 m QX Cordset, Host, Serial, M12 12-pin Socket to DB9, 1 m QX Power Supply, M12 12-pin Socket, 1.
Quick Start Step 2 — Connect the System Important: When connecting Ultra-Lock cordsets to the QX Hawk and QX-1, align the pins first and then push the connector into place. Do not twist the connectors, as this will bend the pins. Important: Do not attempt to power more than four imagers with a single power supply in a daisy chain configuration. Add a QX-1 and one power supply for every four additional imagers in the daisy chain.
Position the Imager Step 3 — Position the Imager • Position the imager at a focal distance of one inch or more from a test symbol. • Tip the imager relative to the symbol if necessary to avoid the glare of direct (specular) reflection. • Symbols can be rotated (tilted) at any angle; however, for best results symbols should be aligned with the field of view.
Quick Start Step 4 — Install ESP ESP Software can be found on the Microscan Tools CD that is packaged with the QX Hawk. 1. Follow the prompts to install ESP from the CD. 2. Click on the ESP icon to run the program. Note: ESP can also be installed from the Download Center at www.microscan.com. Minimum System Requirements • • • • • • 166 MHz Pentium processor (Pentium II processor recommended) Windows Vista, XP, or 2000 operating system Internet Explorer 5.
Select Model Step 5 — Select Model When you start ESP, the model menu will appear: 1. Click the button showing the QX Hawk. 2. Click OK. Note: You can also simply double-click the button showing your imager to make your selection. 3. Click Yes when the following dialog appears: Note: If you need to select another model later, click the Switch Model button near the top of the screen or use Model > New Model in the menu toolbar.
Quick Start Step 6 — Connect Connection Wizard To connect using the Connection Wizard: • Click Connect on the menu toolbar, and then select Connection Wizard. • Select RS-232 or Ethernet to activate the appropriate display. • Configure settings as required by the application, and click Connect.
Connect (cont.) Step 6 — Connect (cont.) Ethernet TCP/IP Once the QX Hawk is connected, incoming symbol data can be displayed in the Terminal, as shown below.
Quick Start Step 7 — Locate Symbol Locate by ESP • In ESP’s EZ Mode, click the Locate button to enable the red X pattern. The symbol in the field of view will appear in the video view beneath the Locate and Calibrate buttons, and you will see the red target pattern projected from the front of the imager. • Center the target pattern on the symbol. Center on object in field of view. Important: The entire symbol should fall within the field of view (FOV) of the imager.
Locate Symbol Locate by EZ Button If you are not connected to a host computer, the EZ Button allows you to locate a symbol in the imager’s field of view. EZ Button • Hold down the EZ Button for about one second and release when you hear one short beep. The amber 20% LED will illuminate, and you will see the red target pattern projected from the front of the imager. • Center the target pattern on the symbol. Note: To end all EZ Button functions, press the EZ Button once and quickly release.
Quick Start Step 8 — Calibrate Imager settings can be adjusted automatically for optimum performance by either the EZ Button or by ESP. During the calibration routine, the imager will flash its amber Read Rate percent LEDs and illumination LEDs while searching camera settings and determining the best configuration for decoding symbol data. Upon successful completion of this routine, a green LED pattern will flash brightly and illuminate the symbol.
Test Read Rate Step 9 — Test Read Rate Read Rate indicates the number of successful decodes per second achieved by the imager. Test Read Rate by ESP 1. Click the Test button to start the Read Rate test. If a symbol has been successfully decoded, its data and related information will be presented in the field below the image display window. While the symbol is being decoded, the Read Rate LEDs will indicate the corresponding read rate percentage on the top of the unit. 2.
Quick Start Step 10 — Configure the Imager Click the App Mode button to make configuration changes to the imager. The following modes are accessible by clicking the buttons at the top of the screen: • • • • • Click the EZ Mode button to return to EZ Mode. Click the Autoconnect button to establish communication. Click the Send/Recv button to send or receive commands. Click the Switch Model button to open the model menu, or to return to a previous model.
Save Changes Step 11 — Save Changes To make changes to configuration settings in the tree controls: 1. Left-click on the + to expand the desired tree. 2. Double-click on the desired parameter and click once in the selection box to view options. 3. Place the cursor in 4. Left-click again on the the selection box, open screen to complete scroll down to the the selection. setting you want to change, and click once on the setting. 5.
2 Using ESP Contents EZ Mode........................................................................................................................................2-2 App Mode......................................................................................................................................2-3 Menu Toolbar ................................................................................................................................2-4 Navigating in ESP ...................................
EZ Mode EZ Mode EZ Mode allows the user to test read rate and calibrate the imager. After connecting to the imager, the EZ Mode view will appear. On-screen instructions assist the user with positioning, testing, and calibration.Imager Locate/Calibrate/Learn The calibration routine optimizes the imager by comparing Read Rates at various camera and image processing settings. Click Locate to find the symbol in the field of view and display it in the video view.
Using ESP App Mode From EZ Mode, click on the App Mode button to access the tabbed tree controls in Parameters, the intuitive user interfaces in Setup, the Terminal interface, and the Utilities interface. Note: The App Mode and EZ Mode buttons appear in the same position to allow easy switching between these primary modes. Video, Evaluation, Calibration, WOI, Configuration Database, Ordered Output, Output Format, Dynamic Setup Click this icon to return to EZ Mode.
Menu Toolbar Menu Toolbar File New Whenever New is selected, the default configuration of ESP is loaded. Open/Save When Save or Save As is selected, the ESP configuration is saved to the host computer’s hard drive and available whenever the same file is selected under Open. Important: When configuration changes are saved to the hard drive, these changes are not automatically saved to the imager.
Using ESP Model The Model dropdown menu shows a list of recent imagers that have been used with ESP. When a different model is chosen, the connection to the present model is terminated. To connect to another model, select New Model, choose a new model from the pop-up menu that appears, and click OK. Note: When an ESP file is saved, the settings of all the models defined in that file are saved.
Menu Toolbar Options The Options menu allows the user to save memos and set up ESP Preferences. Note: Preferences will be saved and loaded into ESP whenever ESP is opened next, whether or not the ESP file is saved. Preferences > General Tab The Toolbar Style options allow the user to determine how ESP will display the mode options in the two rows at the top of the screen. Reload Last File At startup, reloads the last file saved to the host computer’s hard drive.
Using ESP Preferences > Terminal Tab Show Non-Printable Characters When Show Non-Printable Characters is enabled, characters such as “CRLF” will be displayed in the Terminal window. When Enhanced Format is checked, the characters are displayed with more detailed formatting. Change Keyboard Macros Clicking the Change Keyboard Macros button brings up the Function Keys dialog. In this dialog, select the desired function key and then enter the macro keystrokes in the associated key map.
Menu Toolbar Preferences > Bar Code Options Tab Sizing Information Sets the bar height (in inches) and bar width (in mils, or thousandths of an inch) of user-created symbols. Example: A bar width of 18 mils is 0.018 inches.
Using ESP Preferences > Advanced Tab The Auto Sync options at the top of the Advanced tab allow the user to determine whether Auto Sync will be enabled automatically in sections of ESP where it is used, or if it will ask before it enables Auto Sync functions. Always Ask Before Auto Sync Occurs If this option box is checked, specific Auto Sync functions can be enabled. Receive Settings from the Reader will automatically send the imager’s settings to ESP when Auto Sync is enabled.
Menu Toolbar Preferences > Advanced Tab (cont.) Ask to Save ESP File when Quitting When enabled, prompts the user to save a .esp file when ending a session. The .esp file will be saved in the location specified by the user. Connect to Readers via TCP/IP When enabled, shows the TCP/IP Connection Wizard by default. Use Default Storage Location When enabled, automatically stores data in ESP’s Application Data folder.
Using ESP Document Memo The information entered in the Document Memo field will appear in a context-sensitive text box whenever the cursor hovers over the Document Memo item on the Options menu. Model Memo Similar to Document Memo, the information entered in the Model Memo field will appear in a context-sensitive text box whenever the cursor hovers over the Model Memo item on the Options menu. Memos created in Model Memo are specific to the model enabled when the message was created.
Menu Toolbar Connect The Connect dropdown menu allows the user to access the Connection Wizard, as well as the Autoconnect and Configure Multidrop dialogs. Connect and Disconnect can also be performed directly from the dropdown menu without opening a dialog. Connection Wizard To connect using the Connection Wizard: • Click Connect on ESP’s menu toolbar, and then select Connection Wizard. • Select RS-232 or Ethernet to activate the appropriate display.
Using ESP Autoconnect • If the RS-232 connection attempt fails, use Autoconnect to establish a connection between the imager and the host. • If the communication port is not the default COM1, use the dropdown menu to change the port. • Once the correct port is chosen, click Start to connect. • When a connection is established, the green indicator in the status bar at the bottom right of the screen will be visible.
Menu Toolbar View The View menu allows the user to move quickly between the Parameters, Setup, Terminal, and Utilities interfaces without using the icon buttons on the App Mode toolbar. It also allows the user to access the Bar Code Dialog, shown below. Bar Code Dialog Symbols can be created in the Bar Code Dialog by typing the text to be encoded. This is a useful tool for creating configuration symbols, allowing the user to configure the imager by reading the user-created symbols.
Using ESP Navigating in ESP To change imager settings, or to access the Setup, Terminal, or Utilities views, click the App Mode button. To return to EZ Mode, click the EZ Mode button. To make changes to configuration settings in the tree controls: 1. Left-click on the + to expand menu items. The X indicates that the setting is default. 2. Double-click the desired parameter and single-click in the selection box to view options. 3. Place the cursor in the selection box, scroll down 4.
Send/Receive Options Send/Receive Options To access Receive, Save, and Default options, click the Send/Recv button. These options can also be reached by right-clicking in any of the configuration views. Receiving From the Send/Recv menu, select Receive Reader Settings. Caution: Selecting this option will upload the imager’s settings. If the ESP file has a number of custom settings that must be maintained and downloaded into the imager, these settings will be lost.
Using ESP Defaulting When Default Current Menu Settings or Default all ESP Settings are selected, only the ESP settings are defaulted. Advanced Options Send Current View This is the same as Save to Reader > Send No Save except that only the commands in the current configuration tree are sent. Send Current Command This is the same as Send Current View, except that it saves only the command that is currently selected.
Send/Receive Options 2-18 QX Hawk Industrial Imager User’s Manual
3 Hardware Integration Contents Connectors ................................................................................................................................... 3-2 Cordsets ....................................................................................................................................... 3-3 QX Hawk and QX-1 Connectors and Pinouts............................................................................... 3-4 Power and Trigger Switching..................................
Connectors Connectors Industrial cabling and connectivity schemes must be able to withstand environmental extremes of heat, cold, and moisture, and be secure enough not to be disconnected or damaged inadvertently in the course of day-to-day operation. The current industry standard for connectivity is a sealed, circular connector such as the M12. The International Electrotechnical Commission (IEC) standard for M12 connectors describes them as fixed and free screw-locking connectors.
Hardware Installation Cordsets The terms “cordset” and “cable” are both applicable to industrial connectivity, but they are not synonymous. Cordsets enable communications and power between imagers and interface devices. Cordsets have an M12 Ultra-Lock connector at one or both ends. Examples of cordsets are shown below. M12 Ultra-Lock to M12 Ultra-Lock Cordset M12 Ultra-Lock to RJ45 (Ethernet) Cordset M12 Ultra-Lock to Photo Sensor Cordset Cables do not have M12 Ultra-Lock connectors at either end.
QX Hawk and QX-1 Connectors and Pinouts QX Hawk and QX-1 Connectors and Pinouts When deploying a network of imagers and interface devices in an industrial setting, it is important to use components whose pin assignments are arranged in a way that avoids communication errors and equipment damage. This can be achieved with components that are designed in a logical, consistent, and easy-to-implement way. The QX Hawk has a very simple pin assignment methodology.
Hardware Installation Grounding the QX Hawk Proper grounding is necessary for operator safety, noise reduction, and the protection of equipment from voltage transients. Buildings, including any steelwork, all circuits, and all junction boxes must be grounded directly to an earth ground in compliance with local and national electrical codes. QX Hawk An earth ground is provided through the cable shields and chassis of the imager.
QX Hawk and QX-1 Connectors and Pinouts Expected Power and Ground Connections for Proper Operation Grounding Notes: • • • • Ensure that mounting bracket “Earth” is at the same potential as power source “Earth”. Supply “Return” and “Earth” ground must be stable, low-impedance reference points. “2-Terminal Power Supply” must still provide an “Earth” connection to the imager. “Signal Ground” can be used for communications and/or discrete signal ground reference.
Hardware Installation QX-1 Interface Device The QX-1 Interface Device’s receptacles are physically the same as those on the QX Hawk, but they do not have explicit pin assignments. The QX-1 allows users to bus power and communications as required by the application. Connectors 1 and 3 are 12-pin plugs, and Connector 2 is a 12-pin socket. All three connectors can be assigned to bus power and data as required by the application.
Power and Trigger Switching Power and Trigger Switching 1, 3 1,3, T 3-8 PWR TRIG 1,2, 3 1,2, 3, T Power can be bussed between imagers and interface devices. At each location on a network where a new power supply is added, the Power switch on the QX-1 can be used to break power between Connector 2 and Connectors 1, 3, and T. The Trigger signal between Connector 2 and Connectors 1, 3, and T can be broken using the Trigger switch. This isolates trigger signals as required by the application.
Hardware Installation Port Routing The physical advantages created by flexible signal routing and switching are enhanced further by Port Routing, which can be configured in ESP. Port Routing eliminates the need for dedicated “Host” and “Aux” ports in a traditional sense. With Port Routing, any port can be defined as a Host or Aux port. Port Routing also allows users to define the data types that are accessible from specific ports.
Application Examples Application Examples The following examples demonstrate how the components described in previous pages can be deployed in industrial applications. Daisy Chain Daisy chain configurations are used in applications such as product packaging, where single items have multiple symbols. For example, a box with one symbol on the top and symbols on either side requires at least three imagers to ensure that all symbols will be decoded.
Hardware Installation Multidrop Multidrop networks are used in applications where it is necessary to decode symbols at multiple locations within an industrial process. Imagers are placed at stations located between manufacturing steps, and data from those imagers is directed to a multidrop concentrator before being sent to a host. An example of this type of application is food packaging, in which part number data is collected and tracked throughout the packaging process.
Application Examples Ethernet TCP/IP Ethernet TCP/IP is the standard Ethernet interface used to connect multiple locations in a network, such as computers in an office network. It can also be used to network other communications devices, such as imagers and PLCs on a factory floor. The highlighted areas below demonstrate how an Ethernet daisy chain can be arranged.
4 Setup Contents Video............................................................................................................................................. 4-2 Evaluation ................................................................................................................................... 4-14 Calibration................................................................................................................................... 4-17 Window of Interest .............................
Video Video The Video view allows the user to perform the same Locate, Calibrate, and Test routines. There is also a focal distance adjustment tool to the right of the video view. Video also features simple Capture and Decode functionality. Initiates Calibration routine. Initiates Data Matrix Learn operation. Initiates Select Reader Optics dialog. Activates the imager’s target pattern and initiates live video display of the symbol in the field of view.
Setup Learn The Learn command, located in ESP’s EZ Mode and in the Setup section on the Video tab, puts the QX Hawk into a mode of operation that will cause it to “learn” the next Data Matrix symbol decoded. Learn Mode remains active until either a Data Matrix symbol is decoded or Learn Mode is disabled by re-clicking the Learn button.
Video Select Lens This value must reflect the correct camera lens currently installed on the product. This value is configured after leaving the factory. However, since the lens can be changed by the user, this parameter needs to be updated to reflect the currently installed lens. Click the Select Lens button on the Video tab. To verify lens type, turn off power to the QX Hawk (do not look into the targeting laser). Then look at the outer rim of the unit’s camera lens.
Setup Camera Setup Click the App Mode button and then the Setup button. You will see the Camera Setup tree control to the right of the Video interface. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Communication settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format.
Camera Setup Camera Settings Gain Sets the gain value for the image sensor. This setting can be configured through autocalibration, and is the recommended method for configuring this settings. A higher can value will increase the brightness of the image, but the noise performance of the system is reduced. Prior to configuring the gain, the required shutter speed should be set, and the gain should be configured to optimize the shutter speed setting.
Setup Illumination Type Mode Configures the illumination pattern. “Bright Field” is used for most applications. For Mode 4, the internal illumination is always off, similar to configuration setting 0 (Always Off). Mode 2 Bright Field Mode 3 Mode 4 (Internal LEDs Off) Brightness Configures the amount of illumination output from the unit’s built-in lighting.
Camera Setup Focus Distance Provides focal distance adjustment for the camera. When “Distance units” is set to “millimeters”, the Focal Distance parameter has a range of 25 to 4000. Any value outside this range will be rejected. When “Distance units” is set to “1/100 inch”, Focal Distance is limited to a range of 100 to 4000. If the user attempts to set the Focal distance to less than 100 (1 inch), the parameter will be set to 100.
Setup Sub-Sampling The camera can be enabled to sub-sample pixels in the specified image frame. Sub-sampling can be specified as either 4:1 or 16:1, which signifies the sampling rate. 4:1 1 pixel output for every 4 pixels sampled. When selected the image will be sampled 2:1 in the vertical direction and 2:1 in the horizontal direction for a combined 4:1 ratio. An image with a dimension of 640 x 480 will be scaled to 320 x 240. 16:1 1 pixel output for every 16 pixels sampled.
Camera Setup Window of Interest The active pixel area of the image sensor is defined as the “Window of Interest” (WOI). This allows the user to select an area in the Field of View that the desired symbol will be located. The programmable window of interest is useful for increasing decode speed, improving threshold, selecting desired symbol from multiple symbols in FOV. The user provides the upper-left pixel location and the size in both rows and columns to define the Window of Interest.
Setup Height Defines the size, in rows, of the image window. Maximum value is defined as the Maximum row size of Image sensor, minus the row pointer value. Width Defines the size, in columns, of the image window. Maximum value is defined as the Maximum column size of Image sensor, minus the column pointer value.
Camera Setup Image Processing Settings Image Processing Timeout See Image Processing Timeout in Read Cycle. Capture Mode See Capture Mode in Read Cycle. Morphological Pre-Processing Morphological Pre-Processing allows the user to select the method for processing images, and to choose the operator size for that method. Important: This command must be set to Enabled for Morphological Operation to function.
Setup Open Open removes minor light defects of dark cells by performing a Dilate function followed by an Erode function. Close Close removed minor dark defects of light cells by performing an Erode function followed by a Dilate function. Operator Size Operator Size determines the size of the area or “pixel neighborhood” (measured in pixels) in which the morphological operation is being performed.
Evaluation Evaluation In Evaluation, you can view images currently in the imager, capture and decode a symbol, save it as a digital file, and perform histogram and line scan evaluations. When you click on the Evaluation tab, you will see the images that are currently stored in the imager. Click Receive to refresh this view. Click Capture/Decode to display the and decode event will occur, regardless of read cycle settings. Click Read to trigger a read cycle.
Setup Histogram The Histogram function is useful in determining quality and contrast of symbols. A histogram is a graphic representation of the numeric count of the occurrence of each intensity (gray level) in an image. The horizontal axis represents the values of gray levels, and the vertical axis represents the number of pixels for each gray level. Note: Since histograms are performed in the imager, the results will be saved regardless of whether the image was uploaded as a JPEG (.jpg) or a bitmap (.
Evaluation Line Scan 1. From the Evaluation tab, click the Line Scan button. A window like that shown below will appear. 2. Drag your cursor horizontally across the image. This will create a dashed horizontal line. Pixel information and a visual representation of the dark and light pixels will be displayed below the image. When you center your cursor over the dashed line, it becomes a double arrow cross. This allows you to move the line anywhere in the window.
Setup Calibration The Calibration interface in ESP is a powerful and intuitive way to optimize the imager’s performance. It allows the user to control several complex, simultaneous calibration operations, and to follow the progress of those operations using cues such as progress bars, real-time representations of calibration values, and other dynamic user feedback.
Window of Interest Window of Interest The active pixel area of the image sensor is called the Window of Interest (WOI). The WOI allows the user to select an area of the field of view in which the desired symbol is located. The programmable window of interest increases decode speed, improves threshold, and makes it easy to select specific symbols from among several in the field of view. The user provides the upper-left pixel location and the size of the window to define the Window of Interest.
Setup Window of Interest Graphic Interface 1. From the Camera menu, click the WOI tab to bring up Window of Interest. If you haven’t already captured an image, click the Capture and Decode button to decode the present image. If successful, the Good Read indicator on the WOI tab will be green and the symbol will appear in the pane below. Note: You can resize the image by clicking and dragging the ESP window from the lower right corner. This is useful where very small symbols are being read. 2.
Configuration Database Configuration Database The Configuration Database allows the user to manage multiple configuration profiles. It is a useful tool in applications that require several different imager configurations to be applied sequentially, and it allows the user to perform far more complex operations than would be possible with only one set of configuration parameters.
Setup Shutter Speed Sets the camera’s shutter speed (60 – 250,000, default 2,500) for the selected index. Gain Sets the camera’s gain (0 – 33, default 20) for the selected index. Focal Distance Sets the camera’s focal distance (25 – 4,000, default 80) for the selected index. Sub-Sampling Sets the sub-sampling rate (4:1 or 16:1, Disabled by default) for the selected index.
Configuration Database Any Type All of the preceding symbol types, except Pharmacode, are enabled while this database index is being used. Data Matrix If enabled, Data Matrix will be active for this database index. Important: The ECC Level must be configured using the Data Matrix command . If no ECC level has been configured, then it will not decode a Data Matrix symbol. QR Code If enabled, QR Code will be active for this database index.
Setup BC412 If enabled, BC412 will be active for this database index. Pharmacode If enabled, Pharmacode will be active for this database index. DataBar-14 If enabled, DataBar-14 will be active for this database index. DataBar Limited If enabled, DataBar Limited will be active for this database index. DataBar Expanded If enabled, DataBar Expanded will be active for this database index. Micro QR Code If enabled, Micro QR Code will be active for this database index.
Configuration Database Database and Capture Modes The configuration database behaves the same for both “Rapid” and “Continuous” Capture Mode, the only discernable difference is in “Rapid” capture mode the database incrementing always operates in “Number of Image Frames” with a “frame count” of 1.
Setup Database Mode Switch Mode Selects the event that causes the imager to load the next entry from the database to current, active settings. When timer/count expires and “Image Process Looping” is enabled the next database entry that has a camera modification will be used. Notes: Capture event always occurs when the 1st database entry is used. This setting has no effect in Rapid Capture mode. Rapid Capture mode always operates in “Number of Frames” mode, with a “Frame Count” = 1.
Configuration Database Image Dimensions This feature defines how the image dimension parameters are implemented. Window of Interest (WOI) In this mode the database image dimension parameters are Camera Settings and dictate the size of the image to be captured. Region of Interest (ROI) In this mode the database image dimension parameters are Image Processing\Decode Settings and specify the region or area of the captured image to be processed. The ROI coordinate data is based on the full scale image size.
Setup Ordered Output Output filtering is a method of providing a set of good read qualifiers and also providing ordered output. There is a filter for up to the first 10 positions in a multisymbol output. The first filter corresponds to the first symbol output at the end of the read cycle. Each filter has settings for the following six parameters: Filter Number, Symbology Type, Length, Wildcard, Placeholder, Matching Data, Decode Direction, and Database Number.
Ordered Output Filter Number This is the filter index number that represents the position of the symbol in the data output at the end of the read cycle. This index number should be entered along with the following filter settings for the predetermined symbol position. Symbology Type Specifies the symbology type allowed to occupy this location in multisymbol output. Note: To filter or order a symbol, the symbol must meet all the requirements of the selected filter index.
Setup Ordered Output Filter Settings Double-clicking on a row in the Ordered Output table brings up the Ordered Output Filter Settings dialog. Use these settings to determine Symbology Type, Length of the symbol, a user-defined Matching String, ASCII Lookup, Wildcard Character, Placeholder Character, Database Number, and Decode Direction. Click Apply to save the settings to the corresponding filter.
Ordered Output Rules for Output Filter Configuration Output Filter Configuration Rule # 1 Each symbol that is decoded must match one of the filters before it can be saved to a read cycle record. There is an exception to this rule, however, when the number of symbols required for a read cycle exceeds the number of active filters. In such a case, unfiltered symbols can be placed into unfiltered output positions.
Setup Output Format Enable Output Format This is a global enable/disable parameter. Use Set Number of Symbols and Output Phrase to assign symbols for formatting, and Symbol Parse to determine the specific output content for the assigned symbols. On the Output Format tab, check the Enable Output Format box.
Output Format Set Number of Symbols Number of Symbols determines the number of symbols to which output formatting will apply. Output Phrase Output Phrase refers to the user-defined Preamble, selected symbols, and Postamble sequence in the read cycle result. Use the Set Number of Symbols spin box to determine the number of symbols to be included in the output phrase. Enter Postamble characters by double-clicking in the text field and then using the Postamble calculator.
Setup Symbol Parse Extract The Extract Range function corresponds to the Start Location and Length parameters in the Format Extract serial command. Multiple character sequences can be extracted and inserted using Symbol Parse. In this example, the selected extraction range is characters 2-4. The “Sample Symbol” example on the Symbol Parse dialog shows the selected character positions extracted and output as desired.
Output Format Insert The Insert process is very similar to the Extract process, except that Insert allows the user to enter characters using the Insert calculator (shown above). Notice that Extract and Insert share the same Parse Table.
Setup Dynamic Setup Dynamic Setup is used to calculate image capture timing during a read cycle. Without proper timing, the imager will not be able to decode all symbols in a read cycle. An external trigger is used to activate image captures so the user can make timing adjustments as capture events occur. Read Rate is represented graphically in real-time as the user makes adjustments to the time delay between image captures.
Dynamic Setup 4-36 QX Hawk Industrial Imager User’s Manual
5 Parameters Contents Communication ............................................................................................................................. 5-2 Read Cycle ................................................................................................................................. 5-40 Symbologies ............................................................................................................................... 5-60 I/O Parameters.........................................
Communication Communication Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the Communication tab to display the Communication tree control. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Communication settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format.
Parameters Port Routing The QX Hawk features a communication system based on Port Routing instead of traditional, dedicated serial ports. Decisions can be made about the direction and content of communication between ports based on different Data Types. Any available port can be used in any combination. The fundamental concept of Port Routing is that communication design can be based upon Data Types rather than ports.
Communication RS-232 A The following settings define the basic transmission speeds and digital standards that ensure common RS-232 formatting. Baud Rate Can be used to transfer data faster or to match host port settings. The rate at which the imager and host transfer data back and forth. Parity Only changed if necessary to match host setting. An error detection routine in which one data bit per character is set to 1 or 0 so that the total number of bits in the data field is either even or odd.
Parameters Data Bits Only changed if necessary to match host setting. One or two bits added to the end of each character to indicate the end of the character. Symbol Data Output Enables or disables decoded symbol data output from the imager. Extra Symbol Information Enables or disables extra symbol information output from the imager. Diagnostics Output Enables or disables diagnostics output from the imager.
Communication External Source Processing Mode Enables or disables processing of commands or data from sources external to the imager. Command Command enables command processing in the imager. Note: Command processing is always enabled for RS-232 A. Data Data enables RS-232 A as a data source port. Note: The data path between in the source port and out the source port is always two-way.
Parameters RS-232 B The following settings define the basic transmission speeds and digital standards that ensure common RS-232 formatting. Baud Rate Can be used to transfer data faster or to match host port settings. The rate at which the imager and host transfer data back and forth. Parity Only changed if necessary to match host setting. An error detection routine in which one data bit per character is set to 1 or 0 so that the total number of bits in the data field is either even or odd.
Communication Data Bits Only changed if necessary to match host setting. One or two bits added to the end of each character to indicate the end of the character. Symbol Data Output Enables or disables decoded symbol data output from the imager. Extra Symbol Information Enables or disables extra symbol information output from the imager. Diagnostics Output Enables or disables diagnostics output from the imager.
Parameters External Source Processing Mode Enables or disables processing of commands or data from sources external to the imager. Command Command enables command processing in the imager. Data Data enables RS-232 B as a data source port. Note: The data path between in the source port and out the source port is always two-way. Data is copied from source data ports and all those source ports’ data is transmitted to the destination port, and from the destination port to the source port.
Communication RS-422 The following settings define the basic transmission speeds and digital standards that ensure common RS-422 formatting. Baud Rate Can be used to transfer data faster or to match host port settings. The rate at which the imager and host transfer data back and forth. Parity Only changed if necessary to match host setting. An error detection routine in which one data bit per character is set to 1 or 0 so that the total number of bits in the data field is either even or odd.
Parameters Data Bits Only changed if necessary to match host setting. One or two bits added to the end of each character to indicate the end of the character. Symbol Data Output Enables or disables decoded symbol data output from the imager. Extra Symbol Information Enables or disables extra symbol information output from the imager. Diagnostics Output Enables or disables diagnostics output from the imager.
Communication External Source Processing Mode Enables or disables processing of commands or data from sources external to the imager. Command Command enables command processing in the imager. Data Data enables RS-422 as a data source port. Note: The data path between in the source port and out the source port is always two-way. Data is copied from source data ports and all those source ports’ data is transmitted to the destination port, and from the destination port to the source port.
Parameters Ethernet Enables or disables Ethernet connectivity in the imager. Important: For further information about setting up TCP/IP with a PC, see Configuring Ethernet TCP/IP.
Communication IP Address Enter the IP address of the imager in this field.
Parameters Subnet Enter the Subnet address of the imager in this field.
Communication Gateway Enter the Gateway address of the imager in this field.
Parameters IP Address Mode Determines how the imager’s IP address will be defined. Static In Static Mode, the imager uses the user-defined IP address entered in ESP. DHCP In DHCP Mode, the imager automatically acquires the IP address, Subnet, and Gateway addresses from a DHCP or BOOTP server.
Communication TCP Port 1 One of two TCP ports for Ethernet communication with the imager. The default setting is 2001. Symbol Data Output Enables or disables decoded symbol data output from the imager. Extra Symbol Information Enables or disables extra symbol information output from the imager. Diagnostics Output Enables or disables diagnostics output from the imager. External Source Processing Mode Enables or disables processing of commands or data from sources external to the imager.
Parameters TCP Port 2 One of two TCP ports for Ethernet communication with the imager. The default setting is 2003. Symbol Data Output Enables or disables decoded symbol data output from the imager. Extra Symbol Information Enables or disables extra symbol information output from the imager. Diagnostics Output Enables or disables diagnostics output from the imager. External Source Processing Mode Enables or disables processing of commands or data from sources external to the imager.
Communication Search and Configure Mode Search and Configure Mode is intended primarily for initial setup of a QX Hawk in a network. This parameter controls whether or not the QX Hawk will respond to ESP’s Search function in the Ethernet TCP/IP connect dialog section of the Connection Wizard: After the QX Hawk is in full use in an application, you may want the imager to continue to appear in the Search response list for future searches.
Parameters Protocol Selection In general, the point-to-point protocols will work well in most applications. They require no address and must use RS-232 or RS-422 communication standards. Protocols define the sequence and format in which information is transferred between the imager and the host, or in the case of Multidrop, between the imagers and a concentrator.
Communication Protocol Options Point-to-Point (Standard) Used only with RS-232 or RS-422. Standard Point-to-Point requires no address and sends the data to the host whenever it is available, without a request or handshake from the host. Point-to-Point with RTS/CTS A scanner initiates a data transfer with an RTS (request-to-send) transmission. The host, when ready, responds with a CTS (clear-to-send) and the data is transmitted.
Parameters Address The Protocol Address can be any number between 1 and 50. Protocol Port RS-232 A or RS-422 can be used as Protocol Ports.
Communication ACK / NAK Options These parameters take effect for ACK/NAK on the main RS-232 or RS-422 ports (not on the Auxiliary Port), and are completely independent of the Polling Mode Options. The imager always follows the protocol in both directions (to and from the host). There is no option to disable it from either direction.
Parameters ACK/NAK Protocol The following are general outlines of the ACK/NAK protocol. Items that are framed by brackets ( [ ] ) can either be disabled or enabled. LRC does not include STX, but it does include preamble, postamble, and ETX. Symbol Data Output TX to host: [STX] [preamble] SYMBOL DATA [postamble] [ETX] [LRC] Response from host: ACK/NAK. Sent when LRC, ETX, postamble, or timeout (waiting for more data) are detected (if REQ is disabled) depending on what is enabled.
Communication Polling Mode Options These parameters only take effect for Polling Mode on the main RS-232 or RS-422 ports (not on the Auxiliary Port), and are completely independent of the ACK/NAK Options . The values of protocol characters can be changed, but the protocol events cannot be disabled. The polling mode address is configured in the command. To enable true multidrop protocol, the RS422/485 port must be enabled, , in order to turn the transmitter on and off.
Parameters Response Timeout Only used when a response is required from the host. While in Multidrop, if the imager does not receive an ACK or NAK from the host after sending polled data, it will act on a fault. The imager can be set to wait indefinitely by setting Response Timeout to zero. The time that the imager will wait before timing out if ACK, NAK, and ETX are enabled, and a host response is expected.
Communication LRC Status Used when extra data integrity is required. An error-checking routine that verifies the accuracy of transmissions. It is the exclusive OR of all characters following the STX (start of text) up to and including the ETX (end of text). What this means is that the binary representation of all the characters in a transmission are cumulatively added in a column and each resulting odd integer is assigned a 1 and each even integer a 0 (two 1s = 0, two 0s = 0, a 1 and a 0 = 1).
Parameters External Data Routing External Data Routing settings configure the global operation of all external data port settings.
Communication Transparent Mode When Transparent Mode is enabled, the following conditions apply: Symbol Data to Source = Fixed to Enabled Ambles to Source = Fixed to Disabled Echo to Source = Fixed to Enabled Output at End of Read Cycle = Fixed to Enabled Output at ETX = Fixed to Enabled with user-defined characters. Default character will be used if this setting is set to Disabled. Output at Timeout = Fixed to Enabled with user-defined timeout. Default time will be used if this setting is set to Disabled.
Parameters Half Duplex Mode When Half Duplex Mode is enabled, the following conditions apply: Symbol Data to Source = Fixed to Enabled Ambles to Source = Fixed to Enabled Echo to Source = Fixed to Disabled Output at End of Read Cycle = Fixed to Disabled Output at ETX = Fixed to Disabled with user-defined characters. Default character will be used if this setting is set to Disabled. Output at Timeout = Fixed to Disabled with user-defined timeout. Default time will be used if this setting is set to Disabled.
Communication Full Duplex Mode When Full Duplex Mode is enabled, the following conditions apply: Symbol Data to Source = Fixed to Disabled Ambles to Source = Fixed to Disabled Echo to Source = Fixed to Disabled Output at End of Read Cycle = Fixed to Disabled Output at ETX = Fixed to Disabled with user-defined characters. Default character will be used if this setting is set to Disabled. Output at Timeout = Fixed to Disabled with user-defined timeout.
Parameters Destination Port Determines the port to which data will be sent. Ambles to Source Enables or Disables the ability to send Preambles and Postambles to the Source port. Echo to Source Enables or Disables the ability to send an Echo to the Source port. Output at End of Read Cycle Enables or Disables the ability to output data at the end of read cycle.
Communication Output at ETX Determines the output at ETX. Output at Timeout Determines the Timeout value for output.
Parameters Array Communication Modes Mode Daisy Chain When set to Daisy Chain, follows Microscan Daisy Chain protocol. Note: Daisy Chain can also be autoconfigured by sending the Daisy Chain Autoconfigure serial command. Source Defines the communication port. Daisy Chain ID Status When enabled, the imager will append a two-character prefix to each imager in the array. This allows the user to identify which imager sent the data.
Communication Daisy Chain ID The Daisy Chain ID is a two-character identifier.
Parameters Daisy Chain Autoconfigure For quick setup of a daisy chain configuration. The command to Autoconfigure the daisy chain is sent to the primary imager and the software responds in the following ways: • Counts the number of secondary imagers in the daisy chain. • Assigns an internal ID number (1...n) to each secondary imager, where the first secondary imager is number 1 (the primary imager’s ID being a 0).
Communication Preamble Useful for identifying and controlling incoming data. For example, defining the preamble as a carriage return and a line feed causes each decoded message to be displayed on its own line.
Parameters Postamble Useful for identifying and controlling incoming data. For example, defining the postamble as a carriage return and a line feed causes each decoded message to be displayed on its own line. Postamble Characters Allows the user to define up to four postamble characters that can be added to the end of the decoded data.
Read Cycle Read Cycle Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the Read Cycle tab to display the Read Cycle tree control. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Read Cycle settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format. Refer to Read Cycle.
Parameters Read Cycle Setup Setting up read cycle and triggering parameters involves a series of decisions based on the particular application, as follows: 1. Select the number of symbols to be read in a single cycle. 2. Decide on the trigger type to be used: if serial, choose a serial character; if external, choose either External Level or External Edge. 3. Designate how the read cycle should end (Timeout, New Trigger).
Read Cycle Multisymbol Multisymbol is commonly used in shipping applications where a shipping symbol contains individual symbols for part number, quantity, etc. This feature allows one trigger to pick up all the symbols. Multisymbol allows the user to define up to 100 symbols that can be read in a single read cycle. The following conditions apply: • The maximum number of characters in a read cycle is 3,000 for all symbols.
Parameters Trigger The Trigger is the event that initiates a read cycle. Note: When calibrating the imager or testing read rate, the current trigger setting will be disregarded. Trigger Mode Continuous Read Continuous Read is useful in testing symbol readability or imager functions. It is not recommended for normal operations. In Continuous Read, trigger input options are disabled, the imager is always in the read cycle, and it will attempt to decode and transmit data for every symbol.
Read Cycle Continuous Read 1 Output Continuous Read 1 Output can be useful in applications where it is not feasible to use a trigger and all succeeding symbols contain different information. It is also effective in applications where the objects are presented by hand. In Continuous Read 1 Output the imager self-triggers whenever it decodes a new symbol or a timeout occurs. If End of Read Cycle Mode is set to Timeout and the symbol doesn’t change, the output is repeated at the end of each timeout period.
Parameters External Level Initiate Read Cycle: Object #1, moving in front of the detector beam, causes a change in the trigger state, which initiates the read cycle. End Read Cycle: The same object, moving out of the detector beam, causes another change in the trigger state, which ends the read cycle. This mode is effective in an application where the speeds of the conveying apparatus are variable and the time the imager spends reading each object is not predictable.
Read Cycle Serial Data Serial Data is effective in a highly controlled environment where the host knows precisely when the object is in the field of view. It is also useful in determining if a No Read has occurred. In Serial Data, the imager accepts an ASCII character from the host or controlling device as a trigger to start a read cycle. A Serial Data trigger behaves the same as an External Edge trigger. Serial commands are entered inside angle brackets, as shown here: .
Parameters Trailing Edge Used to ignore accidental triggers when Trigger Mode is set to External Edge or External Level. To consider a change in state on the trigger input, the level must be stable for the trigger filter duration. In an edge mode, the imager will trigger a read cycle if the active state has been uninterrupted for the entire trigger filter duration.
Read Cycle Serial Trigger Allows the user to define the trigger character and delimiters that start and stop the read cycle. A serial trigger is considered an online host command and requires the same command format as all host commands. It must be entered within angle bracket delimiters < and > or, in the case of non-delimited triggers, it must define individual start and stop characters. Character (Delimited) Allows the user to define the trigger character that initiates the read cycle.
Parameters Start Character (Non-Delimited) Useful in applications where different characters are required to start a read cycle. A single ASCII host serial trigger character that starts the read cycle and is not enclosed by delimiters such as < and >. Non-delimited Start characters can be defined and will function according to the trigger event.
Read Cycle Stop Character (Non-Delimited) Useful in applications where different characters are required to end a read cycle. A single ASCII host serial trigger character that ends the read cycle and is not enclosed by delimiters such as < and >. Non-delimited Stop characters can be defined and will function according to the trigger event.
Parameters Decodes Before Output Decodes Before Output specifies the number of times a symbol needs to be decoded before symbol data is output and a good read is declared.
Read Cycle End of Read Cycle The read cycle is the time during which the imager will attempt to decode a symbol. A read cycle can be ended by a timeout or a new trigger, or a combination of the two. End of Read Cycle Mode Note: When operating in Continuous Read or Continuous Read 1 Output, the imager is always in the read cycle. Timeout Typically used with Continuous Read 1 Output and Serial Data and Edge.
Parameters New Trigger New Trigger is an effective way to end a read cycle when objects move past the imager at irregular intervals (not timing-dependent). New Trigger ends the current read cycle and initiates a new one when a new trigger occurs. New Trigger refers only to a rising edge trigger. With External Edge, Serial Data, or Serial Data and Edge enabled, an edge or serial trigger ends a read cycle and initiates the next read cycle.
Read Cycle Capture Mode Capture mode specifies how multiple captures are taken and managed throughout a read cycle. Rapid Capture In a rapid capture mode one or multiple captures can taken at an interval specified by the time delay between captures parameter. In this mode the only limiting time factor is the integration and transfer timing.
Parameters Timed Capture Capture events are controlled by the timing values entered in the “Capture Time” command. Triggered Capture When set to trigger captures mode the imager operates in the following manner: • The number of captures represents the number of triggers expected from the system per read cycle. The first trigger enters the read cycle. • Subsequent triggers initiate captures in the read cycle up to the number of captures is met or the end of read cycle condition is met.
Read Cycle Capture Time This command specifies the frame delays associated with the frames captured in a rapid capture mode of operation. Time Before 1st Capture This value specifies the delay from the trigger to the first capture of any triggered read cycle. Time Between Captures 1-2 This value specifies the delay to wait before starting a frame capture for the next capture in the rapid capture sequence.
Parameters Time Between Captures 6-7 This value specifies the delay to wait before starting a frame capture for the next capture in the rapid capture sequence. Time Between Captures 7-8 This value specifies the delay to wait before starting a frame capture for the next capture in the rapid capture sequence. Notes for Rapid Capture, Timed Capture If rapid capture is configured for timed captures this delay is measured from the point at which the previous delay expired.
Read Cycle Store No Read Image Image storage allows the user to store images from separate read cycles and has the ability to retrieve them later. The number of available slots for storage depends on the mode of operation. If functioning in the rapid capture mode the number of images available to store is the maximum number of the rapid count – the current setting for rapid count. If the user is operating in a continuous capture mode then they can store up to the maximum number of the rapid count – 3.
Parameters Image Processing Settings Number of Symbols in Field of View Any Number of Symbols No limit on number of symbols attempted to decode in an image frame. One Symbol Only one symbol will be decoded in an image frame, and this will be regardless of any qualifying attributes associated with the read cycle. Image Processing Timeout Specifies the maximum amount of time allowed for image processing to spend on a captured image. When the time-out expires, the image processing is aborted.
Symbologies Symbologies Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the Symbologies tab to display the Symbologies tree control. To open nested options, single-click the +. The * indicates that the setting is the default. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Symbologies settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format.
Parameters Data Matrix ECC 200 Status Disabled The imager will not attempt to decode ECC 200 symbols. Enabled The imager will attempt to decode ECC 200 symbols. ECC 000 Status Disabled The imager will not attempt to decode ECC 000 symbols. Enabled The imager will attempt to decode ECC 000 symbols. ECC 050 Status Disabled The imager will not attempt to decode ECC 050 symbols. Enabled The imager will attempt to decode ECC 050 symbols.
Symbologies ECC 100 Status Disabled The imager will not attempt to decode ECC 100 symbols. Enabled The imager will attempt to decode ECC 100 symbols. ECC 140 Status Disabled The imager will not attempt to decode ECC 140 symbols. Enabled The imager will attempt to decode ECC 140 symbols. ECC 120 Status Disabled The imager will not attempt to decode ECC 120 symbols. Enabled The imager will attempt to decode ECC 120 symbols. ECC 130 Status Disabled The imager will not attempt to decode ECC 130 symbols.
Parameters QR Code Disabled The imager will not attempt to decode QR Code symbols. Enabled The imager will attempt to decode QR Code symbols.
Symbologies Micro QR Code Disabled The imager will not attempt to decode Micro QR Code symbols. Enabled The imager will attempt to decode Micro QR Code symbols.
Parameters Code 39 Code 39 is considered the standard for non-retail 1D symbology. An alphanumeric symbology with unique start/stop code patterns, composed of 9 black and white elements per character, of which 3 are wide. Check Character Status Enables or Disables the check character. Check Character Output Status Check Character Output Status, when added to the symbol, provides additional data security. When enabled, the check character character is read and compared along with the symbol data.
Symbologies Fixed Symbol Length Status When enabled, the imager will check the symbol length against the symbol length field. If disabled, any length will be considered valid. Fixed Symbol Length Fixed Symbol Length helps prevent truncations and increases data integrity by ensuring that only one symbol length will be accepted. Specifies the exact number of characters that the imager will recognize (this does not include start and stop and check character characters).
Parameters Code 128 Code 128 is a smaller symbology useful in applications with limited space and high-security requirements. A very dense alphanumeric symbology. It encodes all 128 ASCII characters, it is continuous, has variable length, and uses multiple element widths measured edge to edge. Fixed Symbol Length Status When enabled, the imager will check the symbol length against the symbol length field. If disabled, any length will be considered a valid symbol.
Symbologies EAN Status When this field is disabled, the imager will not check any Code 128 labels for conformance to EAN requirements, or perform any special formatting. When enabled, the imager can read symbols with or without a function 1 character in the first position. If a symbol has a function 1 character in the first position, it must conform to EAN format. Symbols that conform to EAN format will also be subject to the special output formatting options available in this command.
Parameters Application Record Separator Status When enabled, an EAN separator will be inserted into the output between fields whenever an EAN-conforming symbol is decoded and EAN output formatting applies. Application Record Separator Character This is an ASCII character that serves as an EAN separator in formatted EAN output.
Symbologies BC412 Check Character Output Status Disabled The imager will strip the verified check digit from the symbol data. Enabled The imager will format the verified check digit as part of the symbol data. Fixed Symbol Length Status Disabled The imager will accept any length BC412 symbol as valid. Enabled The imager will reject any BC412 symbol that does not match the fixed code length value for BC412.
Parameters Interleaved 2 of 5 Interleaved 2 of 5 has been popular because it is the most dense symbology for printing numeric characters less than 10 characters in length; however, Microscan does not recommend this symbology for any new applications because of inherent problems such as symbol truncation. A dense, contimuous, self-checking, numeric symbology.
Symbologies Symbol Length 1 Useful in applications where Interleaved 2 of 5 symbols of a specific length are required. The Symbol Length 1 field is one of two fields against which the decoded symbol is compared before accepting it as valid or rejecting it. Important: If Range Mode Status is set to Disabled, the length of the symbol must match either Symbol Length 1 or Symbol Length 2 to be considered a valid symbol.
Parameters Range Mode Status Important: Unless Range Mode is enabled, Symbol Length must be set to decode Interleaved 2 of 5 symbols. Useful in applications where Interleaved 2 of 5 symbols of a specific length are required. When Range Mode is disabled, the imager checks the value of the symbol length against the values set in Symbol Length 1 and Symbol Length 2. If the symbol length does not match either of the preset values, then it is rejected as invalid.
Symbologies Codabar Used in photo-finishing and library applications. Previously used in medical applications, but not typically used in newer medical applications. Codabar is a 16-bit character set (0 through 9, and the characters $, :, /, ., +, and –) with start/stop codes and at least two distinctly different bar widths. Start and Stop Match Status When disabled, the imager will decode Codabar symbols whether or not the start and stop characters are the same.
Parameters Large Intercharacter Gap When disabled, the spaces between characters, or the “intercharacter gap”, are ignored during the decode process. Note: If the intercharacter space is large enough to be considered a margin, the symbol will not decode, regardless of this parameter’s setting. Fixed Symbol Length Status When disabled, the imager will accept any Codabar symbol provided it doesn’t exceed the system’s maximum capabilities.
Symbologies Check Character Output Status When this field is disabled and a check character calculation is enabled, the imager will strip the verified check character from the symbol data output. This condition must be accounted for if a fixed length is also being used. When enabled, the imager will output the check character as part of the symbol data. This condition must be accounted for if a fixed length is also being used.
Parameters UPC/EAN Used primarily in point-of-sale applications in the retail industry. It is commonly used with Microscan imagers in applications in combination with Matchcode when there is a need to verify that the right product is being placed in the right packaging. UPC (Universal Product Code) is a fixed length, numeric, continuous symbology. UPC can have two- or five-digit supplemental data following the normal symbol. The UPC Version A (UPC, A) symbol is used to encode a 12 digit number.
Symbologies Supplementals Status Reads Supplementals typically used in publications and documentation. A supplemental is a 2 to 5 digit symbol appended to the main symbol. When set to Enabled or Required, the imager reads supplemental code data that has been appended to the standard UPC or EAN codes. Disabled UPC Supplementals will not be decoded. Enabled When enabled, the imager will try to decode a main and a supplemental.
Parameters Separator Character As required by the application. Allows the user to change the separator character from a comma to a new character. Note: Whenever Separator Character is defined as a comma ( , ) sending a command from ESP’s Terminal will return the current settings, including the separator character comma which appears after the separator status comma. Supplementals Type As required by symbology used in application.
Symbologies UPC-E as UPC-A When disabled, the imager will output the version E symbols in their encoded 6-character format. When enabled, the imager will format the symbol as either a 12-character UPC-A symbol or an EAN-13 symbol, depending on the state of the EAN status parameter. This formatting reverses the zero suppression that is used to generate the symbol in the UPC specification.
Parameters Code 93 Used in some clinical applications. Code 93 is a variable-length, continuous symbology employing four element widths. Each Code 93 character has nine modules that may be either black or white. Each character contains three bars and three spaces. Fixed Symbol Length Status When disabled, the imager will accept any Code 93 symbol provided is doesn’t exceed the system’s maximum capabilities. When enabled, the imager will reject any Code 93 symbol that doesn’t match the fixed symbol length.
Symbologies Pharmacode Used mostly in pharmaceutical packaging. Encodes up to five different numbers, each with its own color, which may be entered in decimal or “binary” format with a 1 represented by a thick bar and a 0 represented by a thin bar. Bar width is independent of height. In decimal format, each part can be up to 999,999. In binary format, each input can have up to 19 ones and zeros. Important: When Pharmacode is enabled, other linear symbologies will not decode properly.
Parameters Bar Width Status If set to Mixed, the imager will autodiscriminate between narrow bars and wide bars. If set to All Narrow, all bars will be considered as narrow bars. If set to All Wide, all bars will be considered as wide bars. If set to Fixed Threshold, it will use the fixed threshold value to determine whether the bars are narrow or wide. The Bar Width Status setting will be ignored when the imager is able to tell the difference between the narrow and the wide bars.
Symbologies Postal Symbologies Important: Postal Symbologies must have a pixels-per-element value of no more than 7 to be decoded reliably by the QX Hawk. The imager must be configured to specific read range, field of view, and camera parameters before decoding Postal Symbologies. Position the postal symbol in the center of the imager’s field of view.
Parameters Postal Symbology Type 1D Postal Symbologies are used in mail sortation, auditing, certified mail, registered mail, metered mail, and point-of-sale (POS) applications. This commend determines the postal symbology that will be decoded by the imager. U.S. Postal (POSTNET, PLANET, USPS4CB) When U.S. Postal is enabled, the imager will only decode POSTNET, PLANET, and USPS4CB symbols. Important: POSTNET Status, PLANET Status, and USPS4CB Status are enabled by default. However, if any of the three U.
Symbologies POSTNET Status POSTNET is used by the United States Postal Service to direct mail. The ZIP Code or ZIP+4 Code is encoded in the symbol. Data is encoded in half-height and full-height bars, making POSTNET a “2-state” symbology. The delivery point (usually the last two digits of the address or post office box number) is also typically encoded in POSTNET symbols. If U.S. Postal and POSTNET Status are both enabled, the imager will decode POSTNET symbols.
Parameters POSTNET Allow B and B’ Fields If U.S. Postal and POSTNET are enabled, and POSTNET Allow B and B’ Fields is enabled, the imager will allow B and B’ fields in POSTNET symbols. Australia Post Allow 0 FCC If Australia Post is enabled, and Australia Post Allow 0 FCC is enabled, the imager will allow 0 FCC in Australia Post symbols.
Symbologies GS1 DataBar Note: GS1 DataBar symbologies were previously known as “Reduced Space Symbology” or “RSS”. DataBar Expanded Note: DataBar Expanded was previously known as “RSS Expanded”. Used to encode primary and supplementary data in retail point-of-sale and other applications. DataBar Expanded is a variable length symbology that can encode supplementary information in addition to the 14-digit EAN item identification number and is capable of encoding up to 74 numeric or 41 alphabetic characters.
Parameters DataBar Limited Note: DataBar Limited was previously known as “RSS Limited”. DataBar Limited is designed to be read by laser scanners and CCD imagers. It is not recommended for omnidirectional slot imagers. Encodes a smaller 14-digit symbol (74 modules wide) that is not omnidirectional. DataBar Omnidirectional Note: DataBar Omnidirectional was previously known as “RSS-14”. Used in the grocery, retail, and prescription drug industries where 14-digit EAN item identification may be needed.
Symbologies PDF417 Used in applications where a large amount of information (over 32 characters) needs to be encoded within a symbol, typically where the symbol is transported from one facility to another. For example, an automobile assembly line might use a single symbol with multiple fields of information that will be read at several stations along the way, without reference to a database.
Parameters Codeword Collection Single Image The imager will attempt to decode the PDF417 symbol only from the information provided in a single image. Multiple Image The imager will process codewords from multiple images within the same read cycle and combine them to decode a single PDF417 symbol.
Symbologies MicroPDF417 Used for labelling small items that need large data capacity. A variant of PDF417, a very efficient and compact stacked symbology that can encode up to 250 alphanumeric characters or 366 numeric characters per symbol. Fixed Symbol Length Status When Enabled, the imager will reject any MicroPDF417 symbol that does not match the Fixed Symbol Length. Fixed Symbol Length Used to increase data integrity by ensuring that only one symbol length will be accepted.
Parameters Aztec Code Used in document imaging, railway ticket validation, and some postal applications. A 2D matrix symbology built on a square grid with a square “bull’s-eye” pattern at the center. Aztec Code can encode up to 3,832 numeric or 3,067 alphabetical characters, or 1,914 bytes of data. The level of Reed-Solomon error correction used with Aztec Code is configurable, from 5% to 95% of the total data region. The recommended error correction level is 23% of symbol capacity plus codewords.
Symbologies Composite When set to Enabled or Required, will decode the 2D composite component of a linear symbol. The linear symbol can be DataBar-14, DataBar Expanded, DataBar Limited, EAN-128, UPC-A, EAN-13, EAN-8, and UPC-E. Enabled If Composite is set to Enabled, the imager will decode both the 2D composite and linear components. However, if the 2D composite component is not decoded, the linear data will be sent by itself at the end of the read cycle.
Parameters Symbology Identifier Symbology Identifier is a standard prefix set of characters that identifies the symbol type. When enabled, the imager analyzes and identifies the symbology and adds a three-character identifying prefix to the data: • ] (closed bracket character) indicating the presence of a symbology identifier.
Symbologies Explanation of Modifiers for Code 39, Codabar, and Interleaved 2 of 5 • For Code 39, Codabar, and Interleaved 2 of 5, the modifier indicates Check Character and Check Character Output status. • For Code 39 only, Full ASCII must be enabled to see modifiers 4, 5, and 7.
Parameters I/O Parameters Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the I/O tab to display the I/O Parameters tree control. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: I/O Parameters settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format.
I/O Parameters Symbol Data Output Symbol Data Output relates to data and should not be confused with Outputs 1, 2, and 3 listed in the Output Parameters which describe output states and functions. Useful when the host needs symbol data only under certain conditions. Defines the conditions under which decoded symbol data is transmitted to the host. Note: Symbol Data Output Status, if set to Match or Mismatch, will not take effect unless Matchcode Type is enabled and a master symbol is loaded into memory.
Parameters When to Output Symbol Data This command allows the user to choose when symbol data can be sent to the host. As Soon As Possible As Soon As Possible is useful in applications in which symbol data needs to be moved quickly to the host, typically when the host is making decisions based on symbol data. Note: More than one decode might in fact be required to qualify as a good read, depending on how Decodes Before Output is set.
I/O Parameters No Read Message Used in applications where the host needs serial verification that a symbol has not been read and especially useful in new print verification. When enabled, and if no symbol has been decoded before timeout or the end of the read cycle, the No Read message will be transmitted to the host. No Read Message Status Disabled Only symbol data is output after a read cycle.
Parameters Read Duration Output Useful in evaluating actual read cycle timing results, especially when initially setting up an application to determine maximum line speed (obtainable based on spacing between symbols.) When enabled the duration of the read cycle (in milliseconds) is appended to the symbol data. The read duration is the time from the beginning of the read cycle until data is output.
I/O Parameters Output Indicators The QX Hawk has a beeper and two LED arrays, as follows: 1. An array of green LEDs projected from the front of the imager that can be programmed to flash in response to user-defined conditions. 2. An array of status LEDs on the side of the imager. Green Flash Mode Used as a visual verification that a good read has occurred. An array of green LEDs in the front of the imager can be programmed to flash in response to user-defined conditions.
Parameters Static Presentation Static Presentation Mode is used in conjunction with Continuous Read mode. When operating in Static Presentation Mode, the red LEDs will illuminate while the imager is searching for a symbol in Continuous Read mode. When a symbol is placed in the field of view and a good read occurs, the green LEDs will illuminate and stay on for the duration of time set in Green Flash Duration.
I/O Parameters Targeting Always Off The targeting LEDs remain off. On Only When Not In Read Cycle The targeting LEDs illuminate while the imager is not in a read cycle. When a read cycle is entered the targeting LEDs will turn off, they will come back on upon exiting. On Only When In Read Cycle The targeting LEDs illuminate upon entering a read cycle, and will turn off upon exiting the read cycle. Always On The targeting LEDs are always illuminated.
Parameters Beeper An audible verification that either a good read or a No Read has occurred. A beep is emitted after each good read or No Read. Note: The beeper will also sound at any of the following times: • When the imager is defaulted. • When a Send and Save command is sent from ESP. • At the conclusion of an Auto Calibration procedure. • When a , , , or command is sent from ESP’s Terminal.
I/O Parameters LED Configuration When the Symbol Grade Standard is set to ISO/IEC 16022 grade and the Bar Graph is configured for Grading, this parameter determines which ISO/IEC 16022 grade to display on the LED bar graph. Using the read rate scale as reference if the ISO/IEC 16022 grade result was a grade A, all the LEDs from 20% to 100% would be illuminated. If the result was a grade F, only the 20% LED would illuminate. ISO/IEC 16022 Grade Final Grade LEDs represent ISO/IEC 16022 final grade.
Parameters Serial Verification Allows the user to verify configuration command status. Serial Command Echo Status This command is useful in removing any doubt about the imager’s interpretation of any configuration command. For example, if the current preamble is “SOM” and is entered, the imager will echo back since the attempted entry “START” exceeds the four character limit for that command.
I/O Parameters Control / Hex Output Useful for viewing settings with binary characters when using serial commands on a terminal. Determines the response to a Serial Command Echo or status request command. When set to Control, two characters are transmitted to represent a non-displayable character. For example, a carriage return will be shown as: ^M.
Parameters EZ Trax Output EZ Trax Output Status When EZ Trax output is enabled, the imager will attempt to output all enabled EZ Trax options. EZ Trax will not function unless enabled. Comm Port Selects the communication port that will be used to transfer image files. Image Mode Determines which read cycle condition triggers image file output.
I/O Parameters Image Format Selects the format of the image output file. JPEG Quality Sets the amount of JPEG image compression. A value of 1 represents the highest compression and lowest image quality, and 100 represents the lowest compression and highest image quality. Object Info Output If a symbol is decoded during an image capture, the symbol type and other supplementary symbol information is also included.
Parameters Grade Output Symbol quality information will be output in the form of an abbreviated identifier for each read cycle.
I/O Parameters EZ Button EZ Button Serves as a master switch to enable/disable the EZ Button status. The EZ Button has four positions: First Beep, Second Beep, Third Beep, and Fourth Beep, selectable by the length of time the button is held down, and indicated by one, two, three, and four beeps in succession. Each position can be programmed for any of eight EZ Button Modes.
Parameters EZ Button Status Disabled When set to Disabled, the EZ Button does not function. Enabled When selected, the EZ Button is enabled and the function of each button position is selected by the EZ Button Modes command. Trigger When selected, the EZ Button acts as a trigger for the imager to start and end read cycles. All other button operations are inactive.
I/O Parameters Default on Power-On When enabled, if the EZ Button is held down on power-on, the imager will default to customer defaults and save for power-on. This is the same as sending a command from ESP’s Terminal. Load Configuration Database Loads Configuration Database settings to the imager. Save for Power-On Saves imager settings for Power-On.
Parameters EZ Button Modes Useful for performing multiple, repetitive tasks at the work site. Allows the user to program each of the EZ Button’s 4 positions from a selection of 7 modes. First Beep Hold down button until the first beep is heard. Disabled When set to Disabled, the associated button position will have no function associated with it, and the position will be skipped over. Read Rate Read Rate is initiated when the associated button position is selected.
I/O Parameters Second Beep Hold down button until the second beep is heard. Disabled When set to Disabled, the associated button position will have no function associated with it, and the position will be skipped over. Read Rate Read Rate is initiated when the associated button position is selected. Read Rate will perform decodes/second and is the same as sending a from ESP’s Terminal. To exit Read Rate, quickly press and release the EZ Button.
Parameters Third Beep Hold down button until the third beep is heard. Disabled When set to Disabled, the associated button position will have no function associated with it, and the position will be skipped over. Read Rate (Default) Read Rate is initiated when the associated button position is selected. Read Rate will perform decodes/second and is the same as sending a from ESP’s Terminal. To exit Read Rate, quickly press and release the EZ Button.
I/O Parameters Fourth Beep Hold down button until the fourth beep is heard. Disabled When set to Disabled, the associated button position will have no function associated with it, and the position will be skipped over. Read Rate Read Rate is initiated when the associated button position is selected. Read Rate will perform decodes/second and is the same as sending a from ESP’s Terminal. To exit Read Rate, quickly press and release the EZ Button.
Parameters Status Indicators The side of the QX Hawk features an array of LEDs that indicate various aspects of imager activity. Controls the operation of the MOD/ACT and NET/LNK LEDs. Disabled When set to Disabled, the MOD/ACT and NET/LNK LEDs are always off. Note: All green and red LEDs will turn on briefly during power-on or reset to confirm that they are functioning. PHY Activity If Ethernet is available: LNK = Solid green when transceiver is linked.
I/O Parameters Bar Graph Read Rate, Auto Calibration, Bar Code Configuration, and Read Cycle Result all share the Bar Graph (20% – 100%) LEDs. I/O 1 I/O 1 always shows the combined state of the discrete outputs. If any output is active, the I/O 1 LED will be on. I/O 2 I/O 2 always shows the state of the hardware input trigger. If the trigger is active, I/O 2 will be on.
Parameters Calibration Options This command specifies the operation of the calibration feature. The default configuration is setup to perform calibration on gain, focus and symbol type. Shutter speed is disabled as the default setting, since shutter speed is more of an application specific parameter and normally should be configured by the user to meet the requirements of the application. The calibration process will optimize the gain setting for the configured shutter speed (Camera).
I/O Parameters Shutter Speed Unless an application is a static setup, the shutter speed setting should be configured by the user based on their application. For dynamic applications the user should configure the shutter speed setting, so the calibration process can optimize the gain for that setting. The following table illustrates a general guide-line for shutter speed configurations for various line speeds.
Parameters Focus Position Since the focus can be configured by simply entering the target distance value from the imager, normally the user will configure the focus without requiring calibration. However, if it is necessary to calibrate the focus distance there are two methods to accommodate this task. Don’t Calibrate The focus position is fixed and is not part of the calibration process. Calibrate The focus position will be calibrated to provide the best image quality and performance.
I/O Parameters Symbol Type Don’t Calibrate Only the current symbologies enabled will be considered during the calibration process. Calibrate Autodiscrimination is in effect during the calibration process. All symbologies readable by the product, except PDF417 and Pharmacode will be attempted during calibration. Any new symbologies successfully decode during calibration will remain enabled at the end of the process. All enabled symbologies will remain enabled.
Parameters Row and Column If the calibration process is successful the Window of Interest will be modified to frame the symbol plus an addition margin area around the symbol, determined by the “WOI margin” parameter. Row If the calibration process is successful the Window of Interest rows will be modified to horizontally frame the symbol plus an addition margin determined by the “WOI margin” parameter.
I/O Parameters Database Identifier Output Useful in tracking which database entries read which symbols. Database Identifier Output Status Disabled When this command is disabled, no database identifier information will be output. Enabled When this command is enabled, the imager will append a two-digit number and the characters “DB” to the data output following the separator for each symbol decoded using Configuration Database.
Parameters Input 1 Input Mode Determines the function of the Input pin. Disabled When set to Disabled, the Input pin has no impact on operation. Reset Counts When set to Reset Counts, a transition to the active state of the Input will cause the imager to reset the internal counters. Unlatch Output This setting is used in combination with any of the three outputs in Latch Mode 1 (Unlatch Input # 1 Pin). A transition to the active state will clear any of the three outputs that were previously latched.
I/O Parameters Output 1 Parameters Output On Output On provides discrete signalling to host software to control external devices such as PLCs and relays. It is useful for routing, sorting, and to prevent mis-packaging and mis-routing. Sets the discrete output functions for specific user-selected conditions. Allows the user to set the conditions under which an output (or outputs) will be activated.
Parameters Diagnostic Warning Typically used when a discrete indication of a diagnostic condition is needed. Activates discrete output when a diagnostic warning condition is met, depending on the diagnostic option enabled. In Read Cycle Activates a discrete output when the imager is in a read cycle.
I/O Parameters Output State Sets the active electrical state of the discrete output. Pulse Width Sets the time that the discrete output remains active. Output Mode Sets the condition in which the discrete output is de-activated. Pulse This is the default mode of operation in which the programmable output is activated when the Output On condition has been met and held active for the duration of the selected pulse width.
Parameters Latch Mode 2 (Unlatch Opposite Condition) The programmable output is activated when the Output On condition has been met and held active until the opposite condition selected under Output On has been met. For example, if No Read is enabled under Output On, the programmable output will go active on a No Read and remain active until the opposite condition, a good read, occurs.
I/O Parameters Trend Analysis Note: Output On under Output 1 Parameters must be set to Trend Analysis for this output to function. Under Output 1 Parameters, expand the Trend Analysis tree. Useful in cases where the user doesn’t want to shut down for one condition but wants to monitor quality and read conditions. Applies Trend Analysis settings to Output 1.
Parameters Number of Triggers The number of triggers to examine for the trend analysis condition. Number to Output On Example: If Number to Output On is set to 3 and Trend Analysis Mode is set to No Read, then the output will not be activated until 3 No Reads have occurred. Sets the number of Trend Analysis Mode events (mismatches, No Reads, or reads/trigger as configured by Trend Analysis Mode) to occur within the trigger evaluation period before activating the associated output.
I/O Parameters Decodes per Trigger When set to this mode, and when the appropriate output is set to output on trend analysis, the imager will function in a Decodes per Trigger mode during the read cycle and the trend analysis operation. Output will be activated based on whether or not the symbol decode count at the end of the read cycle crosses the decodes per trigger threshold.
Parameters Symbol Quality (ISO/IEC 16022) Output on Symbol Contrast The symbol contrast is formatted and attached to the Data Matrix symbol data as either a grade or value. Output on Print Growth The print growth is formatted and attached to the Data Matrix symbol data as either a grade or value. Output on Axial Non-Uniformity The axial non-uniformity is formatted and attached to the Data Matrix symbol data as either a grade or value.
I/O Parameters Symbol Contrast Threshold This is the grade to use as a threshold for driving the output. Output will be driven if the Symbol Contrast grade is under the threshold. Print Growth Threshold This is the grade to use as a threshold for driving the output. Output will be driven if the Print Growth grade is under the threshold. Axial Non-Uniformity Threshold This is the grade to use as a threshold for driving the output.
Parameters Diagnostics Note: Output On under Output 1 Parameters must be set to Diagnostic Warning for this output to function. Under Output 1 Parameters, expand the Diagnostics tree. When Diagnostic Warning is enabled, the Output On configuration has no effect. The output will remain active as long as one of the diagnostic warning conditions is met. The output will become inactive once it detects that there are no diagnostic warning conditions.
I/O Parameters Output 2 Parameters Output 2 has the same parameters and default settings as Output 1. Output On Output On provides discrete signalling to host software to control external devices such as PLCs and relays. It is useful for routing, sorting, and to prevent mis-packaging and mis-routing. Sets the discrete output functions for specific user-selected conditions. Allows the user to set the conditions under which an output (or outputs) will be activated.
Parameters Diagnostic Warning Typically used when a discrete indication of a diagnostic condition is needed. Activates discrete output when a diagnostic warning condition is met, depending on the diagnostic option enabled. In Read Cycle Activates a discrete output when the imager is in a read cycle.
I/O Parameters Output State Sets the active electrical state of the discrete output. Pulse Width Sets the time in 10 ms increments that the discrete output remains active. Output Mode Sets the condition in which the discrete output is de-activated. Pulse This is the default mode of operation in which the programmable output is activated when the Output On condition has been met and held active for the duration of the selected pulse width.
Parameters Latch Mode 2 (Unlatch Opposite Condition) The programmable output is activated when the Output On condition has been met and held active until the opposite condition selected under Output On has been met. For example, if No Read is enabled under Output On, the programmable output will go active on a No Read and remain active until the opposite condition, a good read, occurs.
I/O Parameters Trend Analysis Note: Output On under Output 2 Parameters must be set to Trend Analysis for this output to function. Under Output 2 Parameters, expand the Trend Analysis tree. Useful in cases where the user doesn’t want to shut down for one condition but wants to monitor quality and read conditions. Applies Trend Analysis settings to Output 2.
Parameters Number of Triggers The number of triggers to examine for the trend analysis condition. Number to Output On Example: If Number to Output On is set to 3 and Trend Analysis Mode is set to No Read, then the output will not be activated until 3 No Reads have occurred. Sets the number of Trend Analysis Mode events (mismatches, No Reads, or reads/trigger as configured by Trend Analysis Mode) to occur within the trigger evaluation period before activating the associated output.
I/O Parameters Decodes per Trigger When set to this mode, and when the appropriate output is set to output on trend analysis, the imager will function in a Decodes per Trigger mode during the read cycle and the trend analysis operation. Output will be activated based on whether or not the symbol decode count at the end of the read cycle crosses the decodes per trigger threshold.
Parameters Symbol Quality (ISO/IEC 16022) Output on Symbol Contrast The symbol contrast is formatted and attached to the Data Matrix symbol data as either a grade or value. Output on Print Growth The print growth is formatted and attached to the Data Matrix symbol data as either a grade or value. Output on Axial Non-Uniformity The axial non-uniformity is formatted and attached to the Data Matrix symbol data as either a grade or value.
I/O Parameters Symbol Contrast Threshold This is the grade to use as a threshold for driving the output. Output will be driven if the Symbol Contrast grade is under the threshold. Print Growth Threshold This is the grade to use as a threshold for driving the output. Output will be driven if the Print Growth grade is under the threshold. Axial Non-Uniformity Threshold This is the grade to use as a threshold for driving the output.
Parameters Diagnostics Note: Output On under Output 2 Parameters must be set to Diagnostic Warning for this output to function. Under Output 2 Parameters, expand the Diagnostics tree. When Diagnostic Warning is enabled, the Output On configuration has no effect. The output will remain active as long as one of the diagnostic warning conditions is met. The output will become inactive once it detects that there are no diagnostic warning conditions.
I/O Parameters Output 3 Parameters Output 3 has the same parameters and default settings as Output 1 and Output 2. Output On Output On provides discrete signalling to host software to control external devices such as PLCs and relays. It is useful for routing, sorting, and to prevent mis-packaging and mis-routing. Sets the discrete output functions for specific user-selected conditions. Allows the user to set the conditions under which an output (or outputs) will be activated.
Parameters Diagnostic Warning Typically used when a discrete indication of a diagnostic condition is needed. Activates discrete output when a diagnostic warning condition is met, depending on the diagnostic option enabled. In Read Cycle Activates a discrete output when the imager is in a read cycle.
I/O Parameters Output State Sets the active electrical state of the discrete output. Pulse Width Sets the time in 10 ms increments that the discrete output remains active. Output Mode Sets the condition in which the discrete output is de-activated. Pulse This is the default mode of operation in which the programmable output is activated when the Output On condition has been met and held active for the duration of the selected pulse width.
Parameters Latch Mode 2 (Unlatch Opposite Condition) The programmable output is activated when the Output On condition has been met and held active until the opposite condition selected under Output On has been met. For example, if No Read is enabled under Output On, the programmable output will go active on a No Read and remain active until the opposite condition, a good read, occurs.
I/O Parameters Trend Analysis Note: Output On under Output 3 Parameters must be set to Trend Analysis for this output to function. Under Output 3 Parameters, expand the Trend Analysis tree. Useful in cases where the user doesn’t want to shut down for one condition but wants to monitor quality and read conditions. Applies Trend Analysis settings to Output 3.
Parameters Number of Triggers The number of triggers to examine for the trend analysis condition. Number to Output On Example: If Number to Output On is set to 3 and Trend Analysis Mode is set to No Read, then the output will not be activated until 3 No Reads have occurred. Sets the number of Trend Analysis Mode events (mismatches, No Reads, or reads/trigger as configured by Trend Analysis Mode) to occur within the trigger evaluation period before activating the associated output.
I/O Parameters Decodes per Trigger When set to this mode, and when the appropriate output is set to output on trend analysis, the imager will function in a Decodes per Trigger mode during the read cycle and the trend analysis operation. Output will be activated based on whether or not the symbol decode count at the end of the read cycle crosses the decodes per trigger threshold.
Parameters Symbol Quality (ISO/IEC 16022) Output on Symbol Contrast The symbol contrast is formatted and attached to the Data Matrix symbol data as either a grade or value. Output on Print Growth The print growth is formatted and attached to the Data Matrix symbol data as either a grade or value. Output on Axial Non-Uniformity The axial non-uniformity is formatted and attached to the Data Matrix symbol data as either a grade or value.
I/O Parameters Symbol Contrast Threshold This is the grade to use as a threshold for driving the output. Output will be driven if the Symbol Contrast grade is under the threshold. Print Growth Threshold This is the grade to use as a threshold for driving the output. Output will be driven if the Print Growth grade is under the threshold. Axial Non-Uniformity Threshold This is the grade to use as a threshold for driving the output.
Parameters Diagnostics Note: Output On under Output 3 Parameters must be set to Diagnostic Warning for this output to function. Under Output 3 Parameters, expand the Diagnostics tree. When Diagnostic Warning is enabled, the Output On configuration has no effect. The output will remain active as long as one of the diagnostic warning conditions is met. The output will become inactive once it detects that there are no diagnostic warning conditions.
I/O Parameters Quality Output Quality Output Separator The separator character separates quality output data from symbol data. Decodes per Trigger Status When Enabled, the imager enters a state where it processes frames as configured until the end of a read cycle, with or without a successful symbol decode. When the read cycle ends, the imager outputs any decoded symbol data along with the decodes per trigger count.
Parameters Symbol Quality Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the Symbol Quality tab to display the Symbol Quality tree control. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Symbol Quality settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format.
Symbol Quality Global Total Read Time When enabled, outputs the amount of time that was required by the imager to decode the symbol. Symbol Quality Separator This field specifies the separator used to separate the quality output data. Output Mode Determines how symbol quality evaluations will be output.
Parameters Data Matrix ISO/IEC 16022 Parameters Symbol Contrast Outputs the candidate symbol’s Symbol Contrast value. Print Growth Outputs the candidate symbol’s Print Growth value. Axial Non-Uniformity Outputs the candidate symbol’s Axial Non-Uniformity value. Unused ECC Outputs the candidate symbol’s Unused ECC value.
Symbol Quality Grading Percent Cell Damage The percent of symbol cells that are damaged. Capture Time The amount of time the imager required to capture the area in which the symbol was located. Locate Time The amount of time the imager required to locate the symbol. Decode Time The amount of time the imager required to decode the symbol. Pixels Per Element The average number of pixels in a symbol element. ECC Level The level of error correction used when decoding the symbol.
Parameters Report Tab The Report tab allows the user to initiate Data Matrix Grading and to generate and save grading reports. To save the report as a PDF file, an HTML file, a CSV file, or an RTF file, click the Save Report button. Reports appear in the viewing area underneath the Data Matrix Grading and Save Report buttons. The Symbol Quality interface is divided into three sections: Report, Locate, and Preferences. The imager’s field of view is shown here.
Symbol Quality Locate Tab The Locate tab allows the user to determine the position of the symbol within the imager’s field of view, and to optimize the imager’s camera settings for symbol quality evaluation. Click the Locate button to display the symbol in the imager’s field of view. 5-164 Click the Calibrate button to optimize camera settings.
Parameters Preferences Tab The Preferences tab allows the user to set defaults that are automatically activated when grading is completed. For this reason, the user is advised to set preferences before performing grading. This information is appended at the bottom of the report. Choose the default report type to be generated when you click Save Report on the Report tab. Check Autofit Content to ensure that saved PDF report content will fit on a single page.
Matchcode Matchcode Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the Matchcode tab to display the Matchcode tree control. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Matchcode settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format. Refer to Matchcode.
Parameters Overview of Matchcode Matchcode allows the user to store master symbol data in the imager’s memory, compare that data against other symbol data, and define how symbol data and/or discrete signal output will be directed. A master symbol database can be set up for up to 10 master symbols.
Matchcode Matchcode Type Allows the user to choose the way that master symbols will be compared with subsequently read symbols. Note: First set Trigger Mode to External Level, External Edge, or Serial Data. Wild Card Allows the user to enter user-defined wild card characters in the master symbol. Note: If Matchcode Type is set to Sequential, the imager will behave as if Number of Symbols were set to 1, regardless of the user-defined configuration.
Parameters Match Start Position Match Start Position is useful in defining specific portions of a symbol for comparison. For example, if a symbol contains a part number, manufacturing date, and lot code info, but only the part number information is needed, set the imager to sort only the part number and to ignore the other characters.
Matchcode Wild Card Example: With Wild Card Character defined as the default asterisk, defining CR*34 as the master symbol will result in matches for CR134 and CR234, but not CR2345. Entering the wild card at the end of the master symbol, as in CR*, will result in matches for variable symbol lengths such as CR1, CR23, CR358, etc. Wild Card Character allows a user to define a wild card character as part of the master symbol.
Parameters Sequence on No Read Sequence on No Read is useful when the imager needs to stay in sequence even if no decode occurs. When Sequence on No Read is Enabled and Matchcode Type is set to Sequential, the imager sequences the master symbol on every match or No Read. When disabled, it does not sequence on a No Read.
Matchcode Sequence on Mismatch Note: Matchcode Type must be set to Sequential for this command to function. Enable this parameter if every trigger event should have a decode and more than one consecutive mismatch may occur. When set to Enabled, the master symbol sequences on every decode, match, or mismatch. Disable this parameter if every trigger event should have a decode but no more than one consecutive mismatch may occur.
Parameters Sequence Step When the master symbol is sequenced (incremented/decremented), Sequence Step defines the magnitude of change. New Master Pin If Matchcode and New Master Pin are enabled and the new master pin is momentarily connected to ground (must be held low for a minimum of 10 ms), master symbol information will be loaded into the database based on the next read cycle that achieves a Good Read, starting with Index 1.
Matchcode Match Replace Provides a convenient shortcut for applications that need to output a predefined text string whenever a symbol matches a master symbol. Outputs a user-defined data string whenever a match occurs and Matchcode is enabled. Replacement String User-defined data string that, when enabled, replaces symbol data whenever a match occurs.
Parameters Diagnostics Click the App Mode button and then the Parameters button to display the tree control tabs. Then click the Diagnostics tab to display the Diagnostics tree control. The * indicates that the setting is the default. To open nested options, single-click the +. To change a setting, double-click the setting and use the cursor to scroll through the options. Note: Matchcode settings can also be sent to the imager from ESP’s Terminal using Microscan’s K command format.
Diagnostics Hours Since Reset (Read-only) Used as a troubleshooting tool that can help pinpoint the cause of a reset. Records the number of hours and minutes of operation since the last system reset. Hours 16-bit counter that increments every 60 minutes. Range: 0 to 23 hours. Minutes 16-bit counter that increments every 60 seconds. Range: 0 to 59 minutes.
Parameters Service Message Status When Enabled, a Service Message of up to 128 characters is sent whenever the system detects that the service time has expired. Service Message Allows the user to define a service message of up to 128 characters. Threshold Allows the user to determine the length of time until the service message will be sent. Resolution The service timer has a resolution field for setting up the timer increment. Options are increments of seconds or minutes.
Diagnostics User-Defined Name User-Defined Name allows the user to enter any combination of ASCII characters to identify the imager.
6 Terminal Contents Terminal Window.......................................................................................................................... 6-2 Find .............................................................................................................................................. 6-3 Send ............................................................................................................................................. 6-4 Macros.........................................
Terminal Window Terminal Window Click this button to display the Terminal view. Copy, paste, save Clear screen Macros listed on this bar Type text here to find matching text in the Terminal window. Terminal screen Click on Macros arrow to Add Macro, Remove Macro, or Edit Macro. Type serial commands here. Click on desired Macro to run. The Terminal interface allows the user to send serial commands to the imager by using macros, by copying and pasting, or by typing commands in the Send text field.
Terminal Find The Find function allows the user to enter text strings to be searched for in the Terminal. For example: 1. Type “ABC” into the Find box. 2. Press Enter. The first instance of “ABC” will be highlighted in the Terminal window. 3. Click the Find button to the left of the text field to locate additional instances of “ABC”.
Send Send The Send function allows the user to enter serial commands and then send them to the imager. 1. Type the command into the Send box. 2. Press Enter. 3. Click the Send button to the left of the text field to send the command additional times.
Terminal Macros Macros can be stored in a macro selection bar, edited in a separate window, and executed by clicking on the macro name. Click on Next Row to see the next row of macros Click on the first arrow here to see Add Macro or Default Macros. When macros are defaulted, the entire macro set is restored to the original macro commands. Click on subsequent arrows to edit macros. Click a macro button to execute it in the Terminal.
Terminal Window Menus Terminal Window Menus Right-click on the Terminal window to display the following menu: • • • • • • • • • • • • Copy selected text to clipboard. Paste from Terminal or other text. Clear all text in Terminal window. Select All text in the Terminal window. Save... brings up a Save As dialog. Change Font... of text in Terminal; brings up a Font dialog. Change Echo Font... to change typed text; brings up a Font dialog. Enable Echo enables Echo text (typed by user).
7 Utilities Contents Serial Utility Commands ............................................................................................................... 7-2 Read Rate .................................................................................................................................... 7-4 Counters ....................................................................................................................................... 7-6 Device Control ........................................
Serial Utility Commands Serial Utility Commands Note: For a list of all K commands, see Serial Commands. Type Bar Code Configuration Calibration Counters Default/Reset/Save Command <@CAL> <@OPTIC> Device Control Firmware/Checksum 7-2 <#> <#a> <#b> <#d> <#k> <#s> <#.> <#a.
Utilities Firmware/Checksum Imager Status Learn Master Database Read Rate Reboot System Static Validation Targeting Temperature Y-Modem Transfer Options <#b.> <#d.> <#k.
Read Rate Read Rate Click the Utilities button and then the Read Rate tab to display the Read Rate view. To see the number of decodes per second, click the Decodes/sec radio button and then the Start button. To see the percentage of decodes, click the Percent radio button and then the Start button. Read Rate information is displayed in the lower portion of the Utilities view. Serial commands can also be sent to the imager from this screen.
Utilities Read Rate Serial Utility Commands Enter Decodes / Second Test Sending instructs the imager to transmit the decodes per second and symbol data (if any). The decode rate can vary dramatically due to the angle and location of the symbol in relation to the field of view. This test is very useful in aligning and positioning the imager during setup. Enter Decode Percent Test Sending instructs the imager to transmit the percentage of decodes and any decoded symbol data.
Counters Counters Click the Utilities button and then the Counters tab to display the Counters view. Counter commands can be a numeric value from 00000 to 65535. After reaching the maximum numeric limit of 65535, an error message will be displayed and the counter will automatically roll over and start counting again at 00000.
Utilities Counters Serial Utility Commands No Read Counter Sending displays the total number of no reads that have occurred since power-on or the last No Read Counter Reset command. A will be output if the counter is overflowed (nnn represents the number of times it has been overflowed; 255 times is the maximum). Sending again will return the amount by which the counter has been overflowed.
Counters Mismatch Counter Sending displays the total number of symbols successfully decoded that do not match the master symbol since power-on or the last Mismatch Counter Reset command. A will be output if the counter is overflowed (nnn represents the number of times it has been overflowed; 255 times is the maximum). Sending again will return the amount by which the counter has been overflowed.
Utilities Device Control Click the Utilities button and then the Device Control tab to display the Device Control view. The Output 1 Pulse, Output 2 Pulse, and Output 3 Pulse buttons activate the link between the + and – of the host connector. The buttons in the Extras section Disable or Enable the reader. Device Control Serial Utility Commands Output 1 Pulse Sending activates the link between Output 1 (+) and Output 1 (–) of the host connector (regardless of Master Symbol or Output 1 status).
Differences from Default Differences from Default Click the Utilities button and then the Differences tab to display the Differences from Default view. Clicking the Differences from Default button will cause ESP to check all stored configuration settings and compare them to default settings. All settings that are different than default will appear in the left column (shown below), and descriptions of those settings will appear in the right column.
Utilities Master Database Click the Utilities button and then the Master Database tab to display the Master Database view. Important: The Master Database is used for all Matchcode modes except Sequential and Wild Card, both of which use Master Database Index # 1. Master Database Overview Used where more than one master symbol is required, as in a Multisymbol setup, for matching and other Matchcode operations.
Master Database Master Symbol Database Size Master Symbol Database Size allows the user to select 1 to 10 master symbols for the master symbol database. Set Master Symbol Database Size here.
Utilities Enter Master Symbol Data Allows the user to enter master symbol data for any enabled master symbol index number (1 to 10), provided the total number of characters does not exceed the maximum allowed. Enter data for 1 to 10 master symbols. Caution: If no data is entered, the existing data will be deleted. 1. Open the Utilities menu. 2. Set the number of master symbols to be created in Master Symbol Database Size. 3.
Master Database Request Master Symbol Data Returns master symbol data for any enabled master symbols from 1 to 10. 1. Click the Utilities button and the Master Database tab. 2. Click the Receive Reader’s Database button. Read Next Symbol as Master Symbol After the size of the database is set, the imager can read the next symbol as the master symbol for any given master symbol number. To store the next symbol decoded as master symbol # 1, send: or .
Utilities Request New Master Status Informs the user when a new master symbol is pending and which position it is in. Returns the position in the master symbol database that will be loaded on the next read. Send the command from ESP’s Terminal. The imager returns: Once a symbol has been read and loaded, the status will be cleared and the response will be .
Delete Master Symbol Data Master symbol data can be deleted using ESP. 1. Click the Utilities button to access the master symbol. 2. Click the Master Database tab and double-click the symbol number to be deleted. 3. Delete text and click OK.
Utilities Firmware Click the Utilities button and then the Firmware tab to display the Firmware view. Firmware Update Firmware Update is used to download application code to the imager. Application code versions are specific to the imager. Consult with a sales representative before downloading application code. If needed, application code can be requested from Microscan. To download application code: 1. First, be sure that the imager is connected to the host computer. 2. Apply power to the imager. 3.
Firmware Firmware Verification Request Part Number Send a request to the imager for application code, boot code, DSP code, or kernel code part numbers. 1. Click the Firmware tab. 2. Select App Code, Boot Code, DSP Code, or Kernel Code from the dropdown menu to the left of the Request Part No. button. 3. Click the Request Part No. button to see the part number displayed in the text field to the right.
Utilities Request Checksum Send a request to the imager for application code or DSP code checksums. 1. Click the Firmware tab. 2. Select App Code or DSP Code from the dropdown menu to the left of the Request Checksum button. 3. Click the Request Checksum button to see the part number displayed in the text field to the right. Request Checksum by Serial Command • When (a request for all available firmware checksums) is sent, the imager returns: .
Firmware Request Build Number by Serial Command Note: X = base part number; R = revision number; B = build number • When <#.> (a request for all part numbers) is sent, the imager returns: <#a/35-XXXXXX-RR.BBB><#b/35-XXXXXX-RR.BBB><#d/35-XXXXXX-RR.BBB> <#k/35-XXXXXX-RR.BBB><#p/35-XXXXXX-RR.BBB>. • When <#a.> (a request for the application code build number) is sent, the imager returns: <#a/35-XXXXXX-RR.BBB>. • When <#b.
Utilities Bar Code Configuration Mode Definition: Serial Cmd: Bar Code Configuration Mode is a way of programming the imager by using ECC 200 Data Matrix symbols. Bar Code Configuration Mode can be entered three different ways: 1. By forcing the imager into Bar Code Configuration Mode by serial command . 2. By configuring one of the 4 EZ Button positions to Bar Code Configuration Mode. 3.
Calibration Calibration Sending the <@CAL> command from ESP’s Terminal initiates auto-calibration without entering the auto-calibration menu. The calibrated parameters are determined by the settings of the Calibration Options command. Lens Calibration Important: The <@OPTIC> command should only be used when changing the lens module. Sending the <@OPTIC> command puts the imager into a setup mode for the purpose of improving the accuracy of the focal distance parameter ().
Utilities Default/Reset/Save Understanding and controlling the imager’s active, saved, and default settings is critical to its successful operation.
Default/Reset/Save Customer Default Parameters Customer default parameters (saved by ) are the same set of parameters as power-on parameters but are saved in a different, isolated section of NOVRAM. This allows a user essentially to create a back-up set of parameters that can be recalled in the event that the current parameters or power-on parameters have been accidentally changed or are no longer desired. It is important to note that a hardware default does not affect customer default parameters.
Utilities Imager Status Imager Status Request The imager responds to a status request with a two character hex value, such as . To determine status: 1. Look up the binary conversion in the table below. For example, the first hex 2 would be 0 0 1 0 in binary, as read from binary digits 3 through 0; the second hex 2 is also 0 0 1 0 as read from binary digits 7 through 4. 2. Next, enter your binary values from the table below in the “Binary” column next to the appropriate bit.
Imager Status Single Status Request This request will return the value of the variables associated with the requested K command. The request of a single entry of a database command cannot exceed the number of database slots for the specific command. Single Descriptor Request This request returns the basic functional description of all fields in the requested K command.
Utilities Learn Operations Learn Sending the command from ESP’s Terminal will put the imager into a mode of operation that will cause it to “learn” the next Data Matrix symbol decoded. This mode of operation will remain active until either a Data Matrix symbol is decoded or the call is made to disable the mode and revert back to normal operation.
Reboot System Reboot System Sending a command from ESP’s Terminal will “cold-reboot” the system, starting from Boot Code.
Utilities Static Validation Sending a command from ESP’s Terminal will cause the imager to perform a static validation operation and will output validation results to the Terminal. Output Screen Data Matrix validation information is output in the format below in response to the command. Note: If the imager fails to decode the Data Matrix symbol, a No Read message is displayed.
Static Validation Print Growth Definition: The extent to which dark or light markings appropriately fill or exceed their module boundaries. These values are determined by counting pixels in the clock pattern of the binary digitized image, then comparing it to a nominal value and minimum and maximum values. The grade is defined in this way: A (4.0) if -.050 ≤ PG ≤ 0.50 B (3.0) if -.070 ≤ PG ≤ 0.70 C (2.0) if -.085 ≤ PG ≤ 0.85 D (1.0) if -.100 ≤ PG ≤ 1.00 F (0.0) if PG < -1.00 or PG > 1.
Utilities Targeting Activate Targeting System Sending a command (lower-case L and numeral 1) from ESP’s Terminal activates the imager’s targeting system. De-activate Targeting System Sending a command (lower-case L and numeral 0) de-activates the imager’s targeting system.
Temperature Temperature Sending a <@TEMP> command from ESP’s Terminal will cause the imager to output the current temperature of the image sensor in degrees celsius. The output from this command is only updated after an image frame has been captured. If the command is requested but an image has not been captured, the previous temperature output value will remain the same. Output Example: Command <@TEMP> 7-32 Response
Utilities Y-Modem Transfer Options Y-Modem Upload Note: There are only three scales available from the imager. The three scales are full, quarter, and eighth. The Directory response will read out the image dimensions. To receive the image, request to download by the reported dimensions. If quarter-scaled or eighth-scaled images are required, then divide the dimensions by 4 or by 8 and request by the reduced dimensions. (1.
Y-Modem Transfer Options Y-Modem Download (Code) Key app.bin dsp.bin ker.bin Note: The “key” field only accepts app.bin, dsp.bin, or ker.bin.
Appendices Contents Appendix A General Specifications .............................................................................................. A-2 Appendix B Electrical Specifications ............................................................................................ A-8 Appendix C Ground and Shield Considerations......................................................................... A-16 Appendix D Flying Lead Cordset Pinouts.................................................................
General Specifications Appendix A — General Specifications Mechanical Height: 1.59" (40.5 mm) Width: 2.27" (57.6 mm) Depth: 3.79" (96.3 mm) Weight: 10 oz.
Appendices Electrical Power Requirement: 5-28VDC Discrete I/O Input 1 (Trigger/New Master): Optoisolated, 4.5–28V rated (13 mA at 24VDC); New Master is (–) to signal ground Outputs (1, 2, 3): Optoisolated, 1–28V rated (ICE < 100 mA at 24VDC, current limited by user) Safety Certifications CDRH, FCC, CE, CB, BSMI (compliant) RoHS/WEEE Compliant ISO Certification ISO 9001 Certified Issued by TüV USA ©2010 Microscan Systems, Inc. All rights reserved. Specifications subject to change.
General Specifications QX-1 Interface Device Mechanical Height: .75" (19.1 mm) Width: 2.50" (83.5 mm) Depth: 3.15" (80 mm) Weight: 7 oz.
Appendices Read Ranges Note: Ranges correspond to specific symbol element sizes, and range increases as element size increases. Modular Zoom Optics: Inches (mm) 15° Narrow Bar Width 1D 2D 0.0033 (0.08) 0.005 (0.13) 15° 0.0075 (0.19) Read Range (using autofocus) Field of View Depth of Field Inside Edge Outside Edge Inside Edge 1 to 6 (25 to 152) 0.53 (13) 1.8 (46) 0.2 (5) Outside Edge 0.8 (20) 0.010 (0.25) 1 to 14 (25 to 356) 0.53 (13) 3.5 (89) 0.8 (20) 2.5 (64) 0.015 (0.38) 0.
General Specifications Read Ranges (cont.
Appendices FIS Options FIS-6800-0110G FIS-6800-1110G FIS-6800-0210G FIS-6800-1210G FIS-6800-0310G FIS-6800-1310G QX Hawk, Industrial Imager, CMOS, 15 Degree Optic, Serial QX Hawk, Industrial Imager, CMOS, 15 Degree Optic, Ethernet QX Hawk, Industrial Imager, CMOS, 30 Degree Optic, Serial QX Hawk, Industrial Imager, CMOS, 30 Degree Optic, Ethernet QX Hawk, Industrial Imager, CMOS, 45 Degree Optic, Serial QX Hawk, Industrial Imager, CMOS, 45 Degree Optic, Ethernet Accessories 98-000143-01 98-000144-01 98-0
Electrical Specifications Appendix B — Electrical Specifications 9 Watts (max.), 5-28VDC, 200 mV p-p max. ripple, 270mA at 24VDC (typ.) Power Requirement QX Hawk Connectors QX Hawk (Back View) A is a serial M12 12-pin plug. B is a serial M12 12-pin socket or an Ethernet M12 8-pin socket.
Appendices Optoisolated Outputs The reader has optoisolated outputs that can transfer signals from the reader to peripherals. Outputs can be configured as either NPN or PNP, but NPN and PNP cannot be mixed in a system, because the output common is shared by all outputs.
Electrical Specifications NPN Output for External Load A-10 QX Hawk Industrial Imager User’s Manual
Appendices PNP Output for Host Input QX Hawk Industrial Imager User’s Manual A-11
Electrical Specifications PNP Output for External Load A-12 QX Hawk Industrial Imager User’s Manual
Appendices Optoisolated Inputs All discrete inputs are optoisolated. Inputs can be configured as either NPN or PNP, but NPN and PNP cannot be mixed in a system, because the input common is shared by all inputs.
Electrical Specifications PNP A-14 QX Hawk Industrial Imager User’s Manual
Appendices QX-1 Connectors Connector T on the QX-1 Interface Device is the Trigger connector. Connectors 1, 2, and 3 can be used to bus power and data as required by the application. The connectors on the QX-1 interface device physically mirror those on the QX Hawk imager, but they do not have explicit pin assignments. The QX-1 connectors take on the communications and power roles that are assigned to them.
Ground and Shield Considerations Appendix C — Ground and Shield Considerations Proper grounding is necessary for operator safety, noise reduction, and the protection of equipment from voltage transients. Buildings, including any steelwork, all circuits, and all junction boxes must be grounded directly to an earth ground in compliance with local and national electrical codes. QX Hawk An earth ground is provided through the cable shields and chassis of the imager.
Appendices Expected Power and Ground Connections for Proper Operation Notes: • • • • Ensure that mounting bracket “Earth” is at the same potential as power source “Earth”. Supply “Return” and “Earth” ground must be stable, low-impedance reference points. “2-Terminal Power Supply” must still provide an “Earth” connection to the imager. “Signal Ground” can be used for communications and/or discrete signal ground reference. It must not be used as Power Ground or Earth Ground.
Flying Lead Cordset Pinouts Appendix D — Flying Lead Cordset Pinouts Microscan offers two flying leads cordsets—61-000166-01 and 61-000167-01—for use in QX hardware configurations. The diagrams below show the correspondence of wire colors to pins. 61-000166-01 — QX Cordset, M12 12-Pin Plug, Flying Leads The 61-000166-01 cordset connects to QX Hawk Connector B (serial) and QX-1 Connector 2.
Appendices Appendix E — Serial Commands Note: For a list of utility commands such as defaults, read rate requests, device control options, and imager status requests, see Serial Utility Commands.
Serial Commands Capture Time Store No Read Image Image Processing Timeout Number of Symbols in Field of View Configuration Database Number of Active Indexes Configuration Database
Appendices DataBar Limited DataBar Expanded MicroPDF417 Camera Setup Window of Interest Focus Distance Illumination Camera Settings Sub-Sampling Morphological Pre-Processing Morphological Operations I/O Parameters Calibration Options Serial Verification Beeper Quality Output Symbol Data Output Read Duration Output Global Symbol Quality Output ISO/IEC 16022 Parameters Data Matrix Grading No Read Message Input 1 Frame Information ISO/IEC 16022 Grade LED Display Green Flash LED Status Indicators EZ Trax Output
Serial Commands Diagnostics Output 1 Diagnostics Output 2 Diagnostics Output 3 Symbol Quality Output 1 Symbol Quality Output 2 Symbol Quality Output 3 Output 1 Parameters Output 2 Parameters Output 3 Parameters Matchcode Matchcode Master Symbol Database Size New Master Pin Master Symbol Match Replace Mismatch Replace Diagnostics Hours Since Reset (Read-only) Service Message User-Defined Name Output Format Format Extract Format Insert Format Assign Output Format Status Output Filter Configuration Output Fi
Appendices Serial Command Format Microscan readers are controlled by two types of serial commands: configuration commands and utility commands. Rules that apply to both configuration and utility commands • Less than ‘<‘ and greater than ‘>’ angle bracket characters enclose the commands. • Commands and data are case sensitive. Characters must be entered as upper or lower case, as specified. Serial Utility Commands Serial Utility Commands are sent during operations and are not followed by or .
Serial Commands Concatenating Configuration Commands Commands can be concatenated (added together) in a single string. For example, enables LRC, sets End of Read Cycle mode to New Trigger, enables Narrow Quiet Zone, and resets the data buffers without saving the changes for power-on. Serial Command Status Request To ensure that any command was received and accepted, send the Show Reader Status command: .
Appendices Serial Configuration Commands The following serial commands can be entered through ESP’s Terminal to control QX Hawk functions. Detailed descriptions of command parameters are available in Parameters.
Serial Commands Parity, RS-232 A Serial Cmd: Default: Options: 0 = None 0 = None 1 = Even 2 = Odd Stop Bits, RS-232 A Serial Cmd: Default: Options: 0 = One 0 = One 1 = Two Data Bits, RS-232 A Serial Cmd: Default: Options: 1 = Eight 0 = Seven 1 = Eight RS-232 B Status, RS-232 B Serial Cmd: Default: Options: 1 = Enabled 0
Appendices Data Bits, RS-232 B Serial Cmd: Default: Options: 1 = Eight 0 = Seven 1 = Eight RS-422 Status, RS-422 Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Baud Rate, RS-422 Serial Cmd: Default: Options: 8 = 115.2K 0 = 600 1 = 1200 2 = 2400 3 = 4800 4 = 9600 5 = 19.2K 6 = 38.4K 7 = 57.6K 8 = 115.
Serial Commands IP Address Serial Cmd: Default: Options: 192.168.0.100 0.0.0.0 – 255.255.255.255 Subnet Serial Cmd: Default: Options: 255.255.0.0 0.0.0.0 – 255.255.255.255 Gateway Serial Cmd: Default: Options: 0.0.0.0 0.0.0.0 – 255.255.255.
Appendices Extra Symbol Information, RS-232 A Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Diagnostic Output, RS-232 A Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled External Source Processing Mode, RS-232 A Serial Cmd: Default: Options:
Serial Commands RS-422 Data Type Symbol Data Output, RS-422 Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Extra Symbol Information, RS-422 Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Diagnostic Output, RS-422 Serial Cmd: Default: Options:
Appendices Ethernet TCP Port 1 Data Type Symbol Data Output, Ethernet TCP Port 1 Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Extra Symbol Information, Ethernet TCP Port 1 Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Diagnostic Output, Ethernet TCP Port 1 Ser
Serial Commands Diagnostic Output, Ethernet TCP Port 2 Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled External Source Processing Mode, Ethernet TCP Port 2 Serial Cmd: Default: Options: 1 = Command 0 = Disabled 1 = Command 2 = Data Preamble Preamble Status Serial Cmd: Default: Options
Appendices LRC Status Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled ACK/NAK Options Serial Cmd: RES-NAK Defaults RES: (Reset) REQ: (Request) STX: (Start of Text) ETX: (End of Text) ACK: (Acknowledge) NAK: (Negative Acknowledge) 00 (disabled) 00 (disabled) 00 (disabled) 00 (disabled) 06 15 Polling Mode Options Serial Cmd: RES-NAK Defaults RES: (Reset) REQ: (Request) STX: (Start of Text) ETX: (End of Te
Serial Commands ASCII Character Entry Modifier Commands that require ASCII text fields, such as Preamble and Postamble commands, can be sent to the imager as hex pairs (see Appendix G, ASCII Table, for conversions). Serial Cmd Format: To enter ASCII fields as hex values (00 to FF), add a lower-case h directly after the command’s K number, and then enter the hex value that corresponds with the desired ASCII character.
Appendices Address Serial Cmd: Default: Options: 1 1 – 50 1 = Poll address 0x1C, select address 0x1D 2 = Poll address 0x1E, select address 0x1F ...
Serial Commands Ambles to Source Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Echo to Source Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Output at End of Read Cycle Serial Cmd: Default: Options:
Appendices Source Serial Cmd: Default: Options: 1 = RS-232 on QX Hawk Connector B 0 = RS-232 on QX Hawk Connector A 1 = RS-232 on QX Hawk Connector B 2 = RS-422 on QX Hawk Connector B 4 = Ethernet TCP Port 1 5 = Ethernet TCP Port 2 Daisy Chain ID Status Serial Cmd: Default: Options:
Serial Commands Read Cycle Trigger / Trigger Filter Duration Serial Trigger Character External Trigger State End of Read Cycle Decodes Before Output Multisymbol Serial Trigger Start Character Serial Trigger Stop Character Capture Mode Capture Time Store No Read Image Image Processing Timeout Number of Symbols in Field of View
Appendices External Trigger State Serial Cmd: Default: Options: 1 = Positive 0 = Negative 1 = Positive End of Read Cycle End of Read Cycle Mode Serial Cmd: Default: Options: 0 = Timeout 0 = Timeout 1 = New Trigger 2 = Timeout or New Trigger 3 = Last Frame 4 = Last Frame or New Trigger Read Cycle Timeout Serial Cmd: Default: Options: 100 (x10 ms = 1 second) 1 to 65535 Decodes Before Output Deco
Serial Commands Multisymbol Separator Serial Cmd: Default: , (comma) Options: Any 7-bit ASCII character Start Trigger Start Character (Non-Delimited) Serial Cmd: Default: Options: NULL (0x00) Two hex digits representing any ASCII character except <, >, XON, and XOFF.
Appendices Configuration Database Number of Active Indexes Load Current Setting from Configuration Database Request Database Index Setting Request All Database Settings Database Mode Number of Active Indexes
Serial Commands Symbologies Composite Aztec Micro QR Code Postal Symbologies Code 39 Codabar Interleaved 2 of 5 UPC/EAN Code 128 / EAN 128 Code 93 PDF417 Pharmacode Data Matrix QR Code BC412 DataBar Omnidirectional DataBar Limited DataBar Expanded MicroPDF417
Appendices Separator (Composite) Serial Cmd: Default: Options: , (comma) Any 7-bit ASCII character Code 39 Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Check Character Status (Code 39) Serial Cmd:
Serial Commands Fixed Symbol Length (Code 39) Serial Cmd: Default: Options: 10 1 to 128 Full ASCII Set (Code 39) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Codabar Serial Cmd:
Appendices Fixed Symbol Length Status (Codabar) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Symbol Length (Codabar) Serial Cmd: Default: Options: 10 1 to 128 Check Ch
Serial Commands Check Character Status (Interleaved 2 of 5) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Check Character Output Status (Interleaved 2 of 5) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1
Appendices EAN Status Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Supplementals Status (UPC/EAN) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled 2 = Required Separator Status (UPC/EAN) Serial Cmd: Default: Opt
Serial Commands Code 128/EAN 128 Serial Cmd: Default: Options: 3 = Both Standard and Edge-to-Edge 0 = Disabled 1 = Standard 2 = Edge-to-Edge 3 = Both Standard and Edge-to-Edge Fixed Symbol Length Status (Code 128/EAN 128) Serial Cmd: Default: Options:
Appendices Application Record Separator Status (Code 128/EAN 128) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Application Record Separator Character (Code 128/EAN 128) Serial Cmd: Default: Options:
Serial Commands Code 93 Serial Cmd: Default: Options: 3 = Both Standard and Edge-to-Edge 0 = Disabled 1 = Standard 2 = Edge-to-Edge 3 = Both Standard and Edge-to-Edge Fixed Symbol Length Status (Code 93) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Symbol Length (Code 93) Serial Cmd: Default: Options: 10 1 to 128 PD
Appendices Pharmacode Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Fixed Symbol Length Status (Pharmacode) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Fixed Symbol Length (Pharmacode) Serial Cmd: Default: Options:
Serial Commands GS1 DataBar (RSS) DataBar Omnidirectional (RSS-14) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled DataBar Limited (RSS Limited) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled DataBar Expanded (RSS Expanded) Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Fixed Symbol Length Status (DataBar Expanded) Serial Cmd: Default: Options:
Appendices Camera Setup Window of Interest Focus Distance Illumination Camera Settings Sub-Sampling Morphological Pre-Processing Morphological Operations I/O Parameters Calibration Options Serial Verification Beeper Quality Output Symbol Data Output Read Duration Output Global Symbol Quality
Serial Commands Diagnostics Output 3 Symbol Quality Output 1 Symbol Quality Output 2 Symbol Quality Output 3 Output 1 Parameters Output 2 Parameters Output 3 Parameters
Appendices Quality Output Separator Serial Cmd: Default: Options: , (comma) Any 7-bit ASCII character Decodes per Trigger Status Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Symbol Data Output Symbol Data Output Status Serial Cmd: Default: Options:
Serial Commands No Read Message No Read Message Status Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled No Read Message Serial Cmd: Default: Options: NOREAD Any valid ASCII string up to 128 characters Input 1 Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Reset Counts 2 = Unlatch Output Active State Serial Cmd: Default: Options:
Appendices Status Indicators Serial Cmd: Default: Options: 1 = PHY Activity 0 = Disabled 1 = PHY Activity 2 = Protocol Activity Bar Graph Serial Cmd: Default: Options: 1 = Read Rate / Good Read 0 = Disabled 1 = Read Rate / Good Read I/O 1 Serial Cmd: Default: Options: 1 = Output Active 0 = Disabled 1 = Output Active 2 = Input Active I/O 2 Serial Cmd: Default: Options:
Serial Commands EZ Button Global Status Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled 2 = Trigger 3 = Unlatch Outputs 4 = Parameter Switch Default on Power-On Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled EZ Button Modes Serial Cmd: Options: 0 = Disabled 1 = Enabled Single Beep 0 = Disabled 1 = Read Rate 2 = Calibrate 3 = Save
Appendices Trigger Evaluation Period Serial Cmd: Default: Options: 0 0 to 255 Number to Output On Serial Cmd: Default: Options: 0 0 to 255 Decodes per Trigger Threshold Serial Cmd: Default: Options:
Serial Commands Output 1 Parameters Output On Serial Cmd: Default: Options: Mismatch or No Read 0 = Mismatch or No Read 1 = Match or Good Read 2 = Mismatch 3 = No Read 4 = Trend Analysis 5 = Validation 6 = Diagnostic Warning 7 = In Read Cycle 8 = Read Cycle Data Valid Output State Serial Cmd: Default: Options: 0 = Normally Open 0 = Normally Open 1 = Normally Closed Pulse Width Serial Cmd: Default
Appendices Matchcode Matchcode Master Symbol Database Size New Master Pin Master Symbol Match Replace Mismatch Replace Matchcode Type Serial Cmd: Default: Options:
Serial Commands Wild Card Character Serial Cmd: Default: Options: * (asterisk) Any 7-bit ASCII character Sequence on No Read Serial Cmd: Default: Options: 1 = Enabled 0 = Disabled 1 = Enabled Sequence on Mismatch Serial Cmd: Default:
Appendices Replacement String Serial Cmd: Default: Options: MATCH Any valid ASCII string up to 128 characters Mismatch Replace Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Replacement String Serial Cmd: Default: Options: MISMATCH Any valid ASCII string up to 128 characters QX Hawk Industrial Imager User’s Manual A-63
Serial Commands Diagnostics Hours Since Reset (Read-only) Service Message User-Defined Name (returns: hours,minutes) Hours Since Reset (Read-only) Hours Serial Cmd: 16-bit counter (0 to 65535) Minutes Serial Cmd: 16-bit counter (0 to 60) Service Message Serial Cmd: Default: Options: 0 = Disabled 0 = Disabled 1 = Enabled Serv
Appendices Output Format Format Extract Format Insert Format Assign Output Format Status Output Filter Configuration Output Filter Enable Format Extract Output Index Serial Cmd: Options: 1 to 100 Start Location Seri
Serial Commands Length Specifies the length of the user-defined character string that will be inserted. This function is limited to 4 characters per output index, so multiple indexes must be entered in order to insert longer character sequences. For example, to insert a 10-character sequence in user-defined output, three commands with consecutive index numbers would be required, where the first two character sequence lengths were 4 and the third was 2.
Appendices Format Assign Symbol Number Serial Cmd: Options: 1 to 10 1 = Formatted output status for symbol # 1. 2 = Formatted output status for symbol # 2. ... ... 10 = Formatted output status for symbol # 10. Status Serial Cmd: Default: 0 = Disabled Options: 0 = Disabled 1 = Enabled (Assign parameters to specified symbol.
Serial Commands Symbology Type Serial Cmd: Default: 0 Options: 0 = Any type 1 = Interleaved 2 of 5 2 = Code 39 3 = Code 128 4 = Codabar 5 = UPC 6 = PDF417 7 = EAN 128 8 = Code 93 9 = Pharmacode 10 = GS1 DataBar (RSS) 12 = Composite 13 = BC412 14 = Data Matrix 15 = QR Code Length Serial Cmd: Default: 0
Appendices Data Serial Cmd: Default: NULL (0x00) Options: Any ASCII input in the form of a pair of hex characters Decode Direction Serial Cmd: Default: 0 = Any Direction Options: 0 = Any Direction 1 = Forward 2 = Reverse Database Index Serial Cmd:
Serial Commands Serial Utility Commands Type Bar Code Configuration Calibration Counters Default/Reset/Save Command <@CAL> <@OPTIC> Device Control Firmware/Checksum A-70 <#> <#a> <#b> <#d> <#k> <#s> <#.> <#a.> <#b.> <#d.> <#k.
Appendices Firmware/Checksum Imager Status Learn Master Database Read Rate Reboot System Static Validation Targeting Temperature Y-Modem Transfer Options <@TEMP> QX Hawk Industrial Imager User’s Manual Display Application Code Code Checksum Display DSP Code Checksum Roll Back Application Code Imager Status Req
Protocol Commands Appendix F — Protocol Commands Communication Protocol Command Table Protocol Command (Mnemonic displayed on menu) Control Characters (Entered in menu or serial command) Hex Value Effect of Command RES ^D 04 Reset REQ ^E 05 Request EOT ^D 04 Reset STX ^B 02 Start of Text ETX ^C 03 End of Text ACK ^F 06 Acknowledge NAK ^U 15 Negative Acknowledge XON ^Q 11 Begin Transmission XOFF ^S 13 Stop Transmission A-72 QX Hawk Industrial Imager User’s Manual
Appendices ACK/NAK Data Flow Examples Setup 1 RES REQ STX ETX ACK NAK LRC 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x06 0x15 disabled Transfer 1 HOST_TX imager_TX ‘ACK’ Transfer 2 HOST_TX imager_TX imager_TX HOST_TX ‘ACK’ ‘ACK’ Error Condition Transfer 1 imager_TX HOST_TX imager_TX HOST_TX symbol data ‘NAK’ (host rejects) symbol data (resend data) ‘ACK’ (transaction complete) Transfer 2 HOST_TX imager_TX ‘ACK’ imager_TX timeout reach
Protocol Commands Setup 2 RES REQ STX ETX ACK NAK LRC 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x06 0x15 enabled Transfer 1 HOST_TX imager_TX a ‘ACK’ Transfer 2 HOST_TX imager_TX imager_TX HOST_TX B ‘ACK’ a ‘ACK’ Error Condition Transfer 1 HOST_TX imager_TX HOST_TX imager_TX A-74 x (BAD LRC) ‘NAK’ a (GOOD LRC) ‘ACK’ QX Hawk Industrial Imager User’s Manual
Appendices Setup 3 RES REQ STX ETX ACK NAK LRC 0x00 (disabled) 0x00 (disabled) 0x28 ‘(‘ 0x29 ‘)’ 0x06 0x15 enabled Transfer 1 HOST_TX imager_TX ()H ‘ACK’ Transfer 2 HOST_TX imager_TX imager_TX HOST_TX ()k ‘ACK’ ()w ‘ACK’ QX Hawk Industrial Imager User’s Manual A-75
Protocol Commands Setup 4 RES REQ STX ETX ACK NAK LRC 0x21 ‘!’ 0x3D ‘=’ 0x28 ‘(‘ 0x29 ‘)’ 0x06 0x15 enabled Transfer 1 HOST_TX imager_TX ()H ‘ACK’ Transfer 2 HOST_TX imager_TX HOST_TX imager_TX HOST_TX imager_TX ()n ‘ACK’ ‘!’ ()X ‘ACK’ ‘!’ Error Condition Transfer 1 HOST_TX ()H imager_TX ‘ACK’ HOST_TX ()n imager_TX ‘ACK’ HOST_TX ‘!’ imager_TX ()X timeout reached... imager_TX ‘=’ timeout reached... imager_TX ‘=’ timeout reached...
Appendices Polling Mode Data Flow Examples Setup 1 Address RES REQ STX ETX ACK NAK LRC 0x01 (translates to) Poll Req @ ‘0x1C’, Unit Select @ ‘0x1D’ 0x04 0x05 0x02 0x03 0x06 0x15 disabled Transfer 1 HOST_TX imager_TX HOST_TX imager_TX HOST_TX ‘RES’ ‘0x1D’ ‘REQ’ (Select Unit 1 to receive data) ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘STX’ ‘ETX’ ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘RES’ (Terminate Transfer 2) Transfer 2 HOST_TX imager_TX HOST_TX imager_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit
Protocol Commands Error Condition 2 HOST_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data) imager_TX ‘0x1C’ ‘STX’ ‘ETX’ HOST_TX ‘Nothing’ (Host should ‘ACK’ here) timeout reached... imager_TX ‘REQ’ (Unit requests an ‘ACK’ again) HOST_TX ‘NAK’ (Host rejects data frame) (Retry Event) imager_TX ‘0x1C’ ‘STX’ ‘ETX’ (Unit sends again) HOST_TX ‘ACK’ (Host receives data) imager_TX ‘RES’ (Terminate Transfer 1) The protocol makes 3 retry attempts before data is flushed and transfer is aborted.
Appendices Setup 2 Address RES REQ STX ETX ACK NAK LRC 0x01 (translates to) Poll Req @ ‘0x1C’, Unit Select @ ‘0x1D’ 0x04 0x05 0x02 0x03 0x06 0x15 enabled Transfer 1 HOST_TX imager_TX HOST_TX imager_TX HOST_TX ‘RES’ ‘0x1D’ ‘REQ’ (Select Unit 1 to receive data) ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘STX’ ‘ETX’ ‘LRC’ ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘RES’ (Terminate Transfer 2) Transfer 2 HOST_TX imager_TX imager_TX HOST_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data) ‘0x1C’ ‘STX’ <
Protocol Commands Error Condition 2 HOST_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data) imager_TX ‘0x1C’ ‘STX’ ‘ETX’ ‘LRC’ HOST_TX ‘Nothing’ (Host should ‘ACK’ here) timeout reached...
Appendices Appendix G — ASCII Table Dec 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 Hex 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F 10 11 12 13 14 15 16 17 18 19 1A 1B 1C 1D 1E 1F Mne NUL SOH STX ETX EOT ENQ ACK BEL BS HT LF VT FF CR SO SI DLE DC1 DC2 DC3 DC4 NAK SYN ETB CAN EM SUB ESC FS GS RS US Ctrl ^@ ^A ^B ^C ^D ^E ^F ^G ^H ^I ^J ^K ^L ^M ^N ^O ^P ^Q ^R ^S ^T ^U ^V ^W ^X ^Y ^Z ^[ ^\ ^] ^^ ^_ Dec 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
Configuring Ethernet TCP/IP Appendix H — Configuring Ethernet TCP/IP When using Ethernet to deploy QX Hawks in an application, the host computer must be in the same IP range as the devices. Network settings are accessible in Windows from the Control Panel. The steps below show how TCP/IP settings can be configured. 1. From the Windows Start Menu, open Control Panel and double-click Network Connections. 2. The Network Connections dialog will appear.
Appendices Configuring Ethernet TCP/IP (cont.) 3. The Local Area Connection Status dialog will appear. To check the host computer’s connection settings, click Details on the Support tab. To verify connection status: On the Support tab, click the Details button to bring up a list of Network Connection Details. 4. A connected QX Hawk’s default address information can be verified in ESP by clicking the Search button in the Connection Wizard.
Configuring Ethernet TCP/IP Configuring Ethernet TCP/IP (cont.) 5. To change the host computer’s connection settings, click Properties on the General tab. To change TCP/IP settings: On the General tab, click the Properties button to bring up a list of items being used by the current connection. On the Local Area Connection Properties dialog, double-click Internet Protocol (TCP-IP). 6. The Internet Protocol (TCP/IP) Properties dialog will appear.
Appendices Appendix I — Using EtherNet/IP This Appendix describes the Microscan QX Object Model. Throughout this document, this port will referred to as the “EIP”. Overview The EIP interface will be identified as a Generic Device (0x00). The interface is designed to support remote serial transmit and receive using explicit unconnected messaging.
Using EtherNet/IP Data Types Microscan Data Type AB PLC U8 SINT U32 DINT STRING32 STRING ODVA CIP EDS USINT UDINT Description Unsigned, 8 bit Unsigned, 32 bit A 32 bit length field, followed by UDINT and BYTE[] 8 bit ASCII characters QX Hawk Small IN Assembly 0x64, 100 decimal (IN = QX Hawk -> PLC) Field # 0 1 2 Data Type U32 U32 (32 bit flags) U32 (32 bit flags) 3 U32 4 STRING 32 Size (# of Data Type Elements 1 1 1 1 U32 + U8[64] Field Name User-Defined Tag Echo Echo from asm OUT 0xC6 Command
Appendices QX Hawk Big IN Assembly 0x65, 101 decimal (IN = QX Hawk -> PLC) Field # 0 1 2 3 4 5 Data Type U32 U32 (32 bit flags) U32 (32 bit flags) U32 (32 bit flags) U32 (32 bit flags) U32 (32 bit flags) Size (# of Data Type Elements 1 1 1 Field Name User-Defined Tag Echo Echo from asm OUT 0xC6 Command Echo Echo from asm OUT 0xC6 Output Control Echo Echo from asm OUT 0xC6 1 External Input Status (Physical Pin State) 1 External Output Status (Physical Pin State) 1 Device Status 6 U32 1 7 8 9 10
Using EtherNet/IP User Defined Tag Echo, Command Echo, Output Control Echo These are a direct echo of the equivalent fields in the OUT assembly. They provide the PLC programmer with a method of verifying that the OUT data has been received by QX Hawk.
Appendices Read Cycle Sequence Counter When this value changes, it indicates a new read cycle report is present. Read cycle report data is only valid when Sequence is not 0. Read cycle reports are only output during normal read cycles: continuous, serial, and triggered. Read cycle reports are not output during bar code configuration, read rate, auto-calibration, or ESP “Setup” mode. Read Cycle Report: Trigger, Decode/Match, Mismatch, No Read Count These are the historical read cycle result counters.
Using EtherNet/IP Command Bit # 0 1 2-7 8 9-15 16 17 18-31 Action Trigger New Master Disable Scanning Reserved Clear Read Cycle Report and Counters Unlatch Outputs Reserved The PLC programmer should verify that a Command has been received by QX Hawk by observing the equivalent “echo” field in the IN assemblies. Trigger (0) Edge event-driven. Takes effect when read mode is Serial, Edge, or Level. A transition from 0 to 1 is a rising edge trigger event.
Appendices Clear Read Cycle Report and Counters (16) Trigger, Decode/Match, Mismatch, Noread, Decoded Data string, and Sequence. A transition from 0 to 1 is similar to sending the commands , which clear the historical read cycle counters. Also, the Sequence counter and Decoded Data string will go to 0. Note that if this command is received while a read cycle is active, execution of the command will be delayed until the read cycle has ended, and the read cycle’s information will probably be lost.
Using EtherNet/IP Programming Flow Charts Triggered by PLC, symbol data required, timeout or decode ends read cycle. Setup: Read Cycle Trigger Mode = External Edge or External Level. Symbol Data Output = Enabled globally and for EtherNet/IP. When to Output = As Soon As Possible. End of Read Cycle = Timeout. No Read message = Enabled.
Appendices NET and MOD LED Indicators MOD (Module) Indicator State Summary Steady OFF No power Steady GREEN Device operational Steady RED Major fault Flashing GREEN / Self-test RED Requirement If no power is supplied to the device, the module status indicator will be steady OFF. If the device is operating correctly, the module status indicator will be steady GREEN. If the device has detected a non-recoverable minor fault, the module status indicator will be steady RED.
Allen-Bradley PLC Setup Appendix J — Allen-Bradley PLC Setup Allen-Bradley PLC Setup This section was created and run on the following Allen Bradley/Rockwell components: • RSLogix 5000 Version 16 • ControlLogix 5561 processor • 756-ENBT/A EtherNet/IP interface card. This setup procedure was also followed in RSLogix with a CompactLogix 5332E as the processor, though the final program was not tested with a CompactLogix processor. 1.
Appendices 2. Add QX Hawk by right-clicking on the Ethernet interface, and select “New Module”: 3.
Allen-Bradley PLC Setup 4. Configure the following fields: “Name” = A useful name to remember the unit “IP Address” = The IP Address of QX Hawk “Comm Format” = “Data – DINT” “Input” “Assembly Instance” = Choose either 100 (Small) or 101 (Big) “Input” “Size” = 21 (Small), or 44 (Big) “Output” “Assembly Instance” = 198 “Output” “Size” = 3 “Configuration” “Assembly Instance” = 1 “Configuration” “Size” = 0 (none) 5. Click OK when done.
Appendices Example: For Big IN (Instance 101, Size 44): 6. Configure the “Required Packet Interval (RPI)” and click OK. 20 ms or slower is strongly recommended.
Allen-Bradley PLC Setup 7. Double-click on the “Controller Tags” item, and verify QX Hawk’s :I and :O tags appear in the Controller Tags window: 8.
Appendices 9. Right-click on the top rung and select “Import Rung”: 10. Navigate to the “32-000001-xx.
Allen-Bradley PLC Setup 11. At the “Import Configuration” window, link the first two items to the module name assigned earlier: 12.
Appendices 13. Link “:O” to the output assembly: 14.
Allen-Bradley PLC Setup 15. Select one CPS instruction per rung, the “_small_pt” on the left, or the “_big_pt” on the right. Keep the one that corresponds to the assembly sizes configured for the module, and delete the other: 16.
Appendices In this example, the big assembly set has been kept: For the remainder of this document, the big assembly set is demonstrated. The system is now configured enough to test communication with QX Hawk. 17.
Allen-Bradley PLC Setup 18. Once the program has downloaded, make sure the PLC is in Run Mode: 19.
Appendices 20. Expand the “QXHawk_IO_big_pt” so that the .IN and .OUT structures and values are visible: 21. Change the “.OUT.
Allen-Bradley PLC Setup The “.IN.usertag_echo” will change to match the same value as the “.OUT.usertag”: This confirms that two-way communication with QX Hawk is successful. It is left to the programmer to move or modify the CPS instructions in the Main Program according to the application’s requirements. Operation of the data fields within the assemblies is described in the object model documentation.
Appendices EIPScan Setup This procedure is for the EIPScan simulation tool published by Pyramid Solutions. 1. Right-click on “EIPScan Test Tool”, select “Add Device”: 2.
Allen-Bradley PLC Setup QX Hawk will show up in the main window: 3.
Appendices 4. When the “Add Class1 Connection” dialog pops up, select “Data Size”. 5. Populate “Originator->Target” (OUT) with 12, and “Target->Originator” (Big IN) with 176: Alternately, “Target->Originator” could be set to 84 for the Small IN assembly. 6.
Allen-Bradley PLC Setup 7. Select “Destination”. 8. Populate “Originator->Target” (OUT) with 198, and “Target->Originator” (Big IN) 101: Alternately, “Target->Originator” could be set to 100 for the Small IN assembly. 9. Click OK, and the io data windows will show up in the main area, below QX Hawk. 10.
Appendices EIPScan begins polling the unit, and displays the content of the IN (blue) and OUT (green) assemblies: The order of data displayed in each assembly block corresponds to the object model documentation. For a quick test, we can simulate the PLC setting the “User Tag”, and QX Hawk echoing it back. 11.
Allen-Bradley PLC Setup 12. Change the first byte to non-zero. The first byte (User Tag echo) in the blue area (IN) will change to the same value: In fact, all bytes in the green OUT area will be echoed back in the blue IN area, at the same location relative to the beginning of the assemblies. Each byte, and bit, has a unique purpose. Please consult the object model for a description. Note that all data is displayed in little-endian order.
Appendices Appendix K — Interface Standards Interface Standards, established by the Electronic Industries Association (EIA), specify such things as the signaling voltage levels, maximum cable lengths, and number of drivers. In the QX Hawk, selection of interface is made by pin assignment and, in the case of host communication, by software switching between RS-232 and RS-422/RS-485. RS-232 RS-232 defines an interface between two devices such as, for example, the imager and host.
Glossary of Terms Appendix L — Glossary of Terms Aberration — The failure of an optical lens to produce an exact point-to-point correspondence between the object and its resulting image. Various types are chromatic, spherical, coma, astigmatism and distortion. Absorption — The loss of light of certain wavelengths as it passes through a material and is converted to heat or other forms of energy. (–) Active Illumination — Lighting an area with a light source coordinated with the acquisition of an image.
Appendices Charge-Coupled Device (CCD) — A semiconductor device with an array of light-sensitive elements that converts light images into electrical signals. Check Character — A Modulus 43 or Modulus 10 character that is added to encoded symbol data for additional data integrity. CMOS — See Complementary Metal Oxide Semiconductor. Complementary Metal Oxide Semiconductor (CMOS) — Like CCDs, CMOS imagers include an array of photo-sensitive diodes, one diode within each pixel.
Glossary of Terms Edge Enhancement — Image processing method to strengthen high-spatial frequencies in the image. EPROM — See Erasable Programmable Read-Only Memory. Embedded Memory — Onboard memory device such as EPROM or flash. End of Read Cycle — The time or condition at which the imager stops expecting symbol information to decode. Erasable Programmable Read-Only Memory (EPROM) — A memory chip that retains data when its power supply is turned off; “non-volatile memory”.
Appendices Half Duplex — A communications system in which signals can travel between devices in both directions, but not simultaneously. Histogram — A graphical representation of the frequency of occurrence of each intensity or range of intensities (gray levels) of pixels in an image. The height represents the number of observations occurring in each interval. Host — A computer, PLC, or other device that is used to execute commands and process data and discrete signals.
Glossary of Terms Output — A channel or communications line. Data or discrete signals that are transmitted or displayed by a device. Parity — An error detection routine in which one data bit in each character is set to 1 or 0 so that the total number of 1 bits in the data field is even or odd. Picket Fence Orientation — A linear symbol orientation in which the bars are perpendicular to the symbol’s direction of travel.
Appendices Region — Area of an image. Also called a region of interest for image processing operations. ROM — See Read-Only Memory. Saturation — The degree to which a color is free of white. One of the three properties of color perception, along with hue and value. Scattering — Redirection of light reflecting off a surface or through an object. Skew — Rotation of a linear or 2D symbol around an axis parallel to the symbol height on the substrate. See the illustration under the definition of Pitch.
Glossary of Terms A-126 QX Hawk Industrial Imager User’s Manual
