DataMan Communications andProgramming Guide
Legal NoticesThe software described in this document is furnished under license, and may be used or copied only in accordance withthe terms of such license and with the inclusion of the copyright notice shown on this page. Neither the software, thisdocument, nor any copies thereof may be provided to, or otherwise made available to, anyone other than the licensee.Title to, and ownership of, this software remains with Cognex Corporation or its licensor. Cognex Corporation assumesno responsibility for the use or reliability of its software on equipment that is not supplied by Cognex Corporation.Cognex Corporation makes no warranties, either express or implied, regarding the described software, itsmerchantability, non-infringement or its fitness for any particular purpose.
The information in this document is subject to change without notice and should not be construed as a commitment byCognex Corporation. Cognex Corporation is not responsible for any errors that may be present in either this document orthe associated software.
Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this documentmay be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, nortransferred to any other media or language without the written permission of Cognex Corporation.
Copyright 2017. Cognex Corporation. All Rights Reserved.
Portions of the hardware and software provided by Cognex may be covered by one or more U.S. and foreign patents, aswell as pending U.S. and foreign patents listed on the Cognex web site at: http://www.cognex.com/patents.
The following are registered trademarks of Cognex Corporation:
Cognex, 2DMAX, Advantage, AlignPlus, Assemblyplus, CheckitwithChecker, Checker, CognexVisionforIndustry,CognexVSOC, CVL, DataMan, DisplayInspect, DVT, EasyBuilder, Hotbars, IDMax, In-Sight, LaserKiller, MVS-8000,OmniView, PatFind, PatFlex, PatInspect, PatMax, PatQuick, SensorView, SmartView, SmartAdvisor, SmartLearn,UltraLight, VisionSolutions, VisionPro, VisionView
The following are trademarks of Cognex Corporation:
The Cognex logo, 1DMax, 3D-Locate, 3DMax, BGAII, CheckPoint, CognexVSoC, CVC-1000, FFD, iLearn, In-Sight(design insignia with cross-hairs), In-Sight2000, InspectEdge, Inspection Designer, MVS, NotchMax, OCRMax,PatMaxRedLine, ProofRead, SmartSync, ProfilePlus, SmartDisplay, SmartSystem, SMD4, VisiFlex, Xpand
Other product and company trademarks identified herein are the trademarks of their respective owners.
Table of ContentsLegal Notices 2Table of Contents 3Symbols 5About This Manual 6Networking 7Connecting Your DataMan to the Network 7Connecting Your Corded DataManReader to the Network 7Connecting Your DataMan Intelligent Base Station to the Network 7Direct Connection to Your Computer 8
Connecting Your Reader Across Subnets 14Connecting Your DataMan to the Network Wirelessly 14Troubleshooting a Network Connection 17
Industrial Network Protocols 18EtherNet/IP 18DMCC 18Reader Configuration Code 18Setup Tool 19Getting Started 19Object Model 22Rockwell ControlLogix Examples 33Rockwell CompactLogix Examples 46
SLMP Protocol 56DMCC 56Reader Configuration Code 56Setup Tool 57SLMP Protocol Scanner 57Getting Started 57Network Configuration 58Data Block Configuration 59Interface 60Examples 68
ModbusTCP 72DMCC 72Reader Configuration Code 72Setup Tool 73Modbus TCP Handler 73Getting Started 73Network Configuration 74Data Block Configuration 75Interface 76Operation 80Examples 84
PROFINET 88DMCC 88Reader Configuration Code 88
Table of Contents
Setup Tool 89Getting Started 89Modules 93Operation 98Siemens Examples 100
Industrial Protocols for the Wireless DataMan 109Protocol Operation 109Ethernet Address 109PLC Triggering 109Soft Events 109DMCC 109
Offline Buffering 110Status of Industrial Protocols 110
DataMan Application Development 112DMCC Overview 112Command Syntax 112CommandHeader Syntax 112Header Examples 112
DMCC Application Development 114DataMan SDK Contents 114Using the SDK 114Helper Utilities 118Using the Helper Utilities 119
Script-Based Data Formatting 119DMCC Support 119
Error Management 122Formatting Script 122
Output 140Code Completion and Snippets 142Custom Communication Protocol API 144Event Callback 164Event Types 164Examples 165
Table of Contents
SymbolsThe following symbols indicate safety precautions and supplemental information.
WARNING: This symbol indicates the presence of a hazard that could result in death, serious personal injury orelectrical shock.
CAUTION: This symbol indicates the presence of a hazard that could result in property damage.
Note: Notes provide supplemental information about a subject.
Tip: Tips provide helpful suggestions and shortcuts that may not otherwise be apparent.
About This ManualThe DataMan Communications and Programming Guide provides information on how to integrate DataMan readers intoyour particular environment, including:
l Network configuration
l Industrial network protocols
l Integration with PLCs
l DataMan Control Commands (DMCC) API
The DataMan reader connected to a network can be triggered to acquire images by several methods. It can be done by:
l the DataMan Setup Tool,
l itcan be triggered by
l trigger bits
l manipulating objects through/by industrial protocols
l or through a DMCC command.
This document provides a detailed description on how to do each.
About This Manual
NetworkingYou can connect your DataMan device via a simple Ethernet connection. You can either set the IP address and subnetmask of your DataMan device manually or let them be configured automatically using DHCP.
Connecting Your DataMan to the Network
Connecting Your Corded DataMan Reader to the NetworkSupply power to the reader using a Power over Ethernet (PoE) injector. Cognex recommends the following connectionsequence:
1. Connect the PoE injector to the Ethernet network (both ends of the patch cable).
2. Connect the power cord (AC 230V/110V) to the PoE injector.
3. Connect the reader to the PoE injector.
To disconnect the reader:
1. Disconnect the reader from the PoE injector.
2. Disconnect the power cord from the PoE injector.
3. Disconnect the PoE injector from the Ethernet network.
Connecting Your DataMan Intelligent Base Station to the Network1. If you use DMA-IBASE-00, power up your base station using one of these two options:
l If you want to connect the Ethernet cable directly to the network or your PC, power up the base stationusing a 24V power supply.
l If you want to use a Power Over Ethernet (POE) adapter, that will power up your base station. If you usethe DMA-IBASE-BT-01 base station, use direct connection with a 24V power supply. DMA-IBASE-BT-01offers a 3-pin terminal block:
Pin # Signal
Note: Never connect the terminal block and barrel connector power supply at the same time.
2. Connect your base station to your PC with an Ethernet cable.
3. The base station becomes visible as connected through Ethernet, and it routes data through the wireless (WiFi orBluetooth) interface to the reader.
Direct Connection to Your ComputerWhen connecting a DataMan device directly to an Ethernet port on a PC, both the PC and the DataMan device must beconfigured for the same subnet. This can be done automatically though Link Local Addressing or you can manually
configure your reader and your PC.
Link Local Addressing automatically requests and assigns an IP address. In the DataMan Setup Tool, this correspondsto the DHCP Server communication option. This is the default, you do not have to make any changes.
You can also manually configure your DataMan device to reside on the same subnet as the PC or the other way round:configure your PC to reside on the same subnet as your DataMan. These options are detailed in the following sections.
Configuring the DataMan to Reside on the Same Subnet as the PCPerform the following steps to configure your DataMan device:
1. Use the ipconfig utility to determine the IP Address and subnet mask of your PC. In the Start menu, click Run
2. In the Open field, type cmd and click OK.
3. In the command prompt window, type ipconfig and press Enter. A listing of all network adaptors on the PC isshown.
4. Record your PCs IP Address and Subnet Mask. In this example,
l IPAddress is 169.254.3.215
l Subnet Mask is 255.255.0.0
5. Go to Reader Maintenance in the DataMan SetupTool, select the device to be used from the list, and use theNetwork Settings dialog to manually configure the network settings on the target DataMan reader.
6. To force the network settings on your DataMan:
a. Select Use Static IP Address.
b. Enter an IP Address and Subnet Mask that will be on the same subnet as the PC. Make sure this IPaddress is not yet in use (for example, test by pinging it).
l Example IP Address: 169.254.135.200
l Subnet Mask:255.255.0.0
Note: The default Subnet Mask is 255.255.255.0. You can set it back to default by scanning theReset Scanner to Factory Defaults Configuration Code.
Authentication should be left blank unless Authentication has been enabled on the DataMan.Authentication is disabled by default.