Autom ationDirect ECOM Driver 2020 PTC Inc. All Rights Reserved.

AutomationDirect ECOM Driver2Table of ContentsAutomationDirect ECOM Driver1Table of Contents2AutomationDirect ECOM Driver4Overview4Setup4Channel Properties — General5Channel Properties — Ethernet Communications6Channel Properties — Write Optimizations6Channel Properties — Advanced7Device Properties — General8Operating Mode9Device Properties — Scan Mode10Device Properties — Timing10Device Properties — Auto-Demotion11Device Properties — Tag Generation12Device Properties — Communication Parameters14Device Properties — Tag Import Settings14Device Properties — Redundancy14Automatic Tag Database Generation15Tag Hierarchy15Import File-to-Server Name Conversions15Importing DirectSoft Elements15Import Preparation: DirectSoft Steps15Import Preparation: OPC Server Steps18Optimizing Communications19Data Types Description20Address Descriptions20DL-05 Addressing21DL-06 Addressing22DL-240 Addressing24DL-250(-1) Addressing26DL-260 Addressing27DL-430 Addressing29DL-440 Addressing31DL-450 Addressing32www.

Au tom ation Direct ECOM Driver3Error Descriptions35Missing address35Device address ' address ' contains a syntax error35Address ' address ' is out of range for the specified device or register36Device address ' address ' is not supported by model ' model name '36Data Type ' type ' is not valid for device address ' address '36Device address ' address ' is Read Only36Device ' device name ' not responding37Unable to write to ' address ' on device ' device name '37Winsock initialization failed (OS Error n)38Winsock V1.1 or higher must be installed to use the AutomationDirect ECOM device driver38Bad address in block [ start address to end address ] on device ' device name '38Unable to generate a tag database for device device name . Reason: Low memory resources38Unable to generate a tag database for device device name . Reason: Import file is invalid or corrupt39Index40www.

AutomationDirect ECOM Driver4Aut om at ionDirect ECOM DriverHelp version 1.022CONTENTSOverviewWhat is the AutomationDirect ECOM Driver?Device Set upHow do I configure a device for use with this driver?Aut omat ic Tag Dat abase Generat ionHow can I easily configure tags for theAutomationDirect ECOM Driver?Opt imizing Communicat ionsHow do I get the best performance from the driver?Dat a Types Descript ionWhat data types does this driver support?Address Descript ionsHow do I address a data location on an AutomationDirect device?Error Descript ionsWhat error messages does the AutomationDirect ECOM Driver produce?OverviewThe AutomationDirect ECOM Driver provides a reliable way to connect AutomationDirect ECOM controllersto OPC client applications, including HMI, SCADA, Historian, MES, ERP, and countless custom applications. Itis intended for use with AutomationDirect Programmable Logic Controllers that may be accessed via anECOM Ethernet module.Set upSupported 40DL-450* All PLCs via an Hx-ECOM module.Communication ProtocolEthernet using Winsock V1.1 or higher.Connection Timeoutwww.

Au tom ation Direct ECOM Driver5This property specifies the time that the driver will wait for a connection to be made with a device. Depending on network load, the connect time may vary with each connection attempt. The default setting is 3seconds. The valid range is 1 to 60 seconds.Request TimeoutThis property specifies the time the driver will wait on a response from the device before giving up and goingon to the next request. Longer timeouts only affect performance if a device is not responding. The defaultsetting is 250 milliseconds. The valid range is 50 to 9999 milliseconds.Retry AttemptsThis property specifies the number of times the driver will retry a message before giving up and going on tothe next message. The default setting is 3 retries. The valid range is 1 to 10.Channel and Device LimitsThe maximum number of channels supported by this driver is 100. The maximum number of devices supported by this driver is 1024 per channel. Each device on the channel must be uniquely identified by its ownIP address. In general, the Device ID has the following format: YYY.YYY.YYY.YYY where YYY designates thedevice IP address. Each YYY byte should be in the range of 0 to 255. An ECOM module's IP address can bedetermined using NetEdit, an AutomationDirect device configuration utility. To launch NetEdit, select theDevice ID Wizard button on the General property group in Device Properties.N ote: NetEdit has the ability to query the network, configure network parameters and update firmware forECOM devices.Automatic Tag Database GenerationTag Import Set t ingsChannel Propert ies — GeneralThis server supports the use of simultaneous multiple communications drivers. Each protocol or driver usedin a server project is called a channel. A server project may consist of many channels with the same communications driver or with unique communications drivers. A channel acts as the basic building block of anOPC link. This group is used to specify general channel properties, such as the identification attributes andoperating mode.IdentificationN am e: User-defined identity of this channel. In each server project, each channel name must be unique.Although names can be up to 256 characters, some client applications have a limited display window whenbrowsing the OPC server's tag space. The channel name is part of the OPC browser information. The property is required for creating a channel.For information on reserved characters, refer to "How To. Properly Name a Channel, Device, Tag, and TagGroup" in the server help.www.

AutomationDirect ECOM Driver6Description: User-defined information about this channel.Many of these properties, including Description, have an associated system tag.Driver: Selected protocol / driver for this channel. This property specifies the device driver that was selectedduring channel creation. It is a disabled setting in the channel properties. The property is required for creating a channel.N ote: With the server's online full-time operation, these properties can be changed at any time. Thisincludes changing the channel name to prevent clients from registering data with the server. If a client hasalready acquired an item from the server before the channel name is changed, the items are unaffected. If,after the channel name has been changed, the client application releases the item and attempts to reacquire using the old channel name, the item is not accepted. With this in mind, changes to the propertiesshould not be made once a large client application has been developed. Utilize the User Manager to preventoperators from changing properties and restrict access rights to server features.DiagnosticsDiagnostics Capture: When enabled, this option makes the channel's diagnostic information available toOPC applications. Because the server's diagnostic features require a minimal amount of overhead processing, it is recommended that they be utilized when needed and disabled when not. The default is disabled.N ote: This property is not available if the driver does not support diagnostics.For more information, refer to "Communication Diagnostics" and "Statistics Tags" in the server help.Channel Propert ies — Et hernet Com m unicat ionsEthernet Communication can be used to communicate with devices.Ethernet SettingsN etwork Adapter: Specify the network adapter to bind. When left blank or Default is selected, the operating system selects the default adapter.Channel Propert ies — Writ e Opt im izat ionsAs with any server, writing data to the device may be the application's most important aspect. The serverintends to ensure that the data written from the client application gets to the device on time. Given this goal,the server provides optimization properties that can be used to meet specific needs or improve applicationresponsiveness.Write Optimizationswww.

Au tom ation Direct ECOM Driver7Optim ization Method: Controls how write data is passed to the underlying communications driver. Theoptions are:llWrite All Values for All Tags: This option forces the server to attempt to write every value to thecontroller. In this mode, the server continues to gather write requests and add them to the server'sinternal write queue. The server processes the write queue and attempts to empty it by writing datato the device as quickly as possible. This mode ensures that everything written from the client applications is sent to the target device. This mode should be selected if the write operation order or thewrite item's content must uniquely be seen at the target device.Write Only Latest Value for N on-Boolean Tags: Many consecutive writes to the same value canaccumulate in the write queue due to the time required to actually send the data to the device. If theserver updates a write value that has already been placed in the write queue, far fewer writes areneeded to reach the same final output value. In this way, no extra writes accumulate in the server'squeue. When the user stops moving the slide switch, the value in the device is at the correct value atvirtually the same time. As the mode states, any value that is not a Boolean value is updated in theserver's internal write queue and sent to the device at the next possible opportunity. This can greatlyimprove the application performance.N ote: This option does not attempt to optimize writes to Boolean values. It allows users to optimizethe operation of HMI data without causing problems with Boolean operations, such as a momentarypush button.lWrite Only Latest Value for All Tags: This option takes the theory behind the second optimizationmode and applies it to all tags. It is especially useful if the application only needs to send the latestvalue to the device. This mode optimizes all writes by updating the tags currently in the write queuebefore they are sent. This is the default mode.Duty Cycle: is used to control the ratio of write to read operations. The ratio is always based on one read forevery one to ten writes. The duty cycle is set to ten by default, meaning that ten writes occur for each readoperation. Although the application is performing a large number of continuous writes, it must be ensuredthat read data is still given time to process. A setting of one results in one read operation for every writeoperation. If there are no write operations to perform, reads are processed continuously. This allows optimization for applications with continuous writes versus a more balanced back and forth data flow.N ote: It is recommended that the application be characterized for compatibility with the write optimizationenhancements before being used in a production environment.Channel Propert ies — AdvancedThis group is used to specify advanced channel properties. Not all drivers support all properties; so theAdvanced group does not appear for those devices.N on-N orm alized Float Handling: A non-normalized value is defined as Infinity, Not-a-Number (NaN), or asa Denormalized Number. The default is Replace with Zero. Drivers that have native float handling maydefault to Unmodified. Non-normalized float handling allows users to specify how a driver handles non-normalized IEEE-754 floating point data. Descriptions of the options are as follows:www.

AutomationDirect ECOM Driverll8Replace with Zero: This option allows a driver to replace non-normalized IEEE-754 floating point values with zero before being transferred to clients.Unm odified: This option allows a driver to transfer IEEE-754 denormalized, normalized, non-number, and infinity values to clients without any conversion or changes.N ote: This property is not available if the driver does not support floating point values or if it only supportsthe option that is displayed. According to the channel's float normalization setting, only real-time driver tags(such as values and arrays) are subject to float normalization. For example, EFM data is not affected by thissetting.For more information on the floating point values, refer to "How To . Work with Non-Normalized FloatingPoint Values" in the server help.Inter-Device Delay: Specify the amount of time the communications channel waits to send new requests tothe next device after data is received from the current device on the same channel. Zero (0) disables thedelay.N ote: This property is not available for all drivers, models, and dependent settings.Device Propert ies — GeneralA device represents a single target on a communications channel. If the driver supports multiple controllers,users must enter a device ID for each controller.IdentificationN am e: This property specifies the name of the device. It is a logical user-defined name that can be up to256 characters long, and may be used on multiple channels.N ote: Although descriptive names are generally a good idea, some OPC client applications may have alimited display window when browsing the OPC server's tag space. The device name and channel namebecome part of the browse tree information as well. Within an OPC client, the combination of channel nameand device name would appear as "ChannelName.DeviceName".For more information, refer to "How To. Properly Name a Channel, Device, Tag, and Tag Group" in serverhelp.Description: User-defined information about this device.Many of these properties, including Description, have an associated system tag.Channel Assignm ent: User-defined name of the channel to which this device currently belongs.Driver: Selected protocol driver for this device.www.

Au tom ation Direct ECOM Driver9Model: This property specifies the specific type of device that is associated with this ID. The contents of thedrop-down menu depends on the type of communications driver being used. Models that are not supportedby a driver are disabled. If the communications driver supports multiple device models, the model selectioncan only be changed when there are no client applications connected to the device.N ote: If the communication driver supports multiple models, users should try to match the model selection to the physical device. If the device is not represented in the drop-down menu, select a model that conforms closest to the target device. Some drivers support a model selection called "Open," which allows usersto communicate without knowing the specific details of the target device. For more information, refer to thedriver help documentation.ID: This property specifies the device's driver-specific station or node. The type of ID entered depends onthe communications driver being used. For many communication drivers, the ID is a numeric value. Driversthat support a Numeric ID provide users with the option to enter a numeric value whose format can bechanged to suit the needs of the application or the characteristics of the selected communications driver.The format is set by the driver by default. Options include Decimal, Octal, and Hexadecimal.N ote: If the driver is Ethernet-based or supports an unconventional station or node name, the device'sTCP/IP address may be used as the device ID. TCP/IP addresses consist of four values that are separated byperiods, with each value in the range of 0 to 255. Some device IDs are string based. There may be additionalproperties to configure within the ID field, depending on the driver. For more information, refer to the driver'shelp documentation.Operating M odeData Collection: This property controls the device's active state. Although device communications areenabled by default, this property can be used to disable a physical device. Communications are not attempted when a device is disabled. From a client standpoint, the data is marked as invalid and write operationsare not accepted. This property can be changed at any time through this property or the device system tags.Sim ulated: This option places the device into Simulation Mode. In this mode, the driver does not attempt tocommunicate with the physical device, but the server continues to return valid OPC data. Simulated stopsphysical communications with the device, but allows OPC data to be returned to the OPC client as valid data.While in Simulation Mode, the server treats all device data as reflective: whatever is written to the simulateddevice is read back and each OPC item is treated individually. The item's memory map is based on the groupUpdate Rate. The data is not saved if the server removes the item (such as when the server is reinitialized).The default is No.N otes:1. This System tag ( Simulated) is read only and cannot be written to for runtime protection. The Systemtag allows this property to be monitored from the client.2. In Simulation mode, the item's memory map is based on client update rate(s) (Group Update Rate forOPC clients or Scan Rate for native and DDE interfaces). This means that two clients that referencethe same item with different update rates return different data.Simulation Mode is for test and simulation purposes only. It should never be used in a production environment.www.

AutomationDirect ECOM Driver10Device Propert ies — Scan M odeThe Scan Mode specifies the subscribed-client requested scan rate for tags that require device communications. Synchronous and asynchronous device reads and writes are processed as soon as possible;unaffected by the Scan Mode properties.Scan Mode: Specifies how tags in the device are scanned for updates sent to subscribing clients. Descriptions of the options are:lllllRespect Client-Specified Scan Rate: This mode uses the scan rate requested by the client.Request Data N o Faster than Scan Rate: This mode specifies the value set as the maximum scanrate. The valid range is 10 to 99999990 milliseconds. The default is 1000 milliseconds.N ote: When the server has an active client and items for the device and the scan rate value isincreased, the changes take effect immediately. When the scan rate value is decreased, the changesdo not take effect until all client applications have been disconnected.Request All Data at Scan Rate: This mode forces tags to be scanned at the specified rate for subscribed clients. The valid range is 10 to 99999990 milliseconds. The default is 1000 milliseconds.Do N ot Scan, Dem and Poll Only: This mode does not periodically poll tags that belong to thedevice nor perform a read to get an item's initial value once it becomes active. It is the client'sresponsibility to poll for updates, either by writing to the DemandPoll tag or by issuing explicit devicereads for individual items. For more information, refer to "Device Demand Poll" in server help.Respect Tag-Specified Scan Rate: This mode forces static tags to be scanned at the rate specifiedin their static configuration tag properties. Dynamic tags are scanned at the client-specified scanrate.Initial Updates from Cache: When enabled, this option allows the server to provide the first updates fornewly activated tag references from stored (cached) data. Cache updates can only be provided when thenew item reference shares the same address, scan rate, data type, client access, and scaling properties. Adevice read is used for the initial update for the first client reference only. The default is disabled; any time aclient activates a tag reference the server attempts to read the initial value from the device.Device Propert ies — Tim ingThe device Timing properties allow the driver's response to error conditions to be tailored to fit the application's needs. In many cases, the environment requires changes to these properties for optimum performance. Factors such as electrically generated noise, modem delays, and poor physical connections caninfluence how many errors or timeouts a communications driver encounters. Timing properties are specificto each configured device.Communications Timeoutswww.

Au tom ation Direct ECOM Driver11Connect Tim eou