deviceDefinition

The deviceDefinition element is the root element in a CygNet device template file. Its attributes define features of a field device and/or protocol as well as the CygNet interface engine used with the defined field device and/or protocol. Element contents nested between the deviceDefinition start and end tags define most particulars of a remote device. These element contents include things like data group definitions and command parameters.

This element is:

Case sensitive
Required in every CygNet device template file
Used 1 time per CygNet device template file

To learn about how this element relates to other elements in a CygNet device template file, see Device Template File Hierarchy.

Example

Attributes

The following table lists and describes attributes generally applicable to this element. However, not all of the attributes listed here are applicable to all EIEs. Additionally, some attributes are required for use in every device template file of a certain EIE, but others may be used on a case-by-case or device-by-device basis, depending on your specific needs. All attributes in templates are case sensitive; but the case sensitivity of attribute values is based on context.

Note: Occasionally, device template files for different EIEs use attributes of the same name that do different things. Efforts are made in this document to highlight cases where an attribute by one name does different things in different EIEs.

Attribute	Description
alternateSOM	alternateSOM is only used in eProdRPC EIE device template files. This optional attribute directs the driver to look first for the start-of-message (SOM) character of 0x0A, and if that fails, to look for the alternate SOM character defined in the device template file. Value options are integers from 0 to 255.
category	category is a special identifier that identifies an EIE as a templated EIE. Value: Almost always the number 4098. Legacy templates might require the number 10.
CIP_Protocol	CIP_Protocol is only used in Allen Bradley CIP EIE device template files. It identifies the specific Common Industrial Protocol (CIP) type used by an EIE. Value: Native PCCC_SLC See manufacturer documentation for more information.
class	class identifies a template as belonging to a particular categorization of templates. Value: POC: Indicates that a template is for a pump-off control device type. This value is required for a Modbus template that includes a dynagraph card data group. Others
customerVersion	customerVersion is a user-defined template version identifier. It helps ensure that users can differentiate versions of modified templates. Value: Any user-defined string.
cygnetVersion	cygnetVersion identifies a template's released version. It helps users ensure that they have the latest available CygNet template. Value: Default value is in the format #.#.#.#, as in 9.8.0.1000.
desc	desc identifies the device type supported by a template. It appears in the DDS editor Select a Device Type... dialog that appears when you right-click in the DDS pane and select New Remote Device. Value: Any applicable string, up to 32 characters.
deviceType	deviceType uniquely identifies a template. This is the Device Type property that displays in the DDS pane. If you edit a device template file and don’t want the changes to affect existing remote device configurations in the system, assign a new unique value to the deviceType attribute. If you do not change deviceType, the new edits apply to all remote device configurations that use that template. Also assign a unique value to the desc attribute, because this is what is listed in the Select a Device Type menu that displays available EIE device types. Value: Any applicable string, up to 20 characters. Alphabetical characters only. No spaces.
eieType	eieType identifies the CygNet EIE type associated with a template; it links a device driver with a template. It typically refers to the name of the protocol according to which an EIE conforms. Value: CygNet-defined string, up to 20 characters. Alphabetical characters only. No spaces. Default value is supplied in the template; do not change it, typically.
externalConsumer	externalConsumer specifies that an application other than CygNet may use the applicable device template file. Value: Any applicable string.
hostGroup	hostGroup is only used in Emerson ROC EIE and Emerson ROCPlus EIE device template files. It is used in conjunction with hostUnit to make up a unique host identifier. hostGroup corresponds to the Emerson ROCLINK Host Group setting. Value: Integer value only. Default value is 0; do not change it, typically. See manufacturer documentation for more information.
hostUnit	hostUnit is only used in Emerson ROC EIE and Emerson ROCPlus EIE device template files. It is used in conjunction with hostGroup to make up a unique host identifier. hostUnit corresponds to the Emerson ROCLINK Host Address setting. Value: Integer value only. Default value is 1; do not change it, typically. See manufacturer documentation for more information.
mfg	mfg identifies the manufacturer of the applicable field device. Value: Any applicable string, up to 32 characters.
model	model identifies the field device model(s) supported by the template. Value: Any applicable string, up to 32 characters
series	series is used to identify TotalFlow G3 and G4 devices. If series is not defined, it assumed that the applicable device is either Totalflow G1 or G2. Value: G3 G4
supportAltAddr	supportAltAddr is used in the Modbus Realflo EIE device template file to identify whether the Realflo device supports an alternate address. The alternate address concept is generic to CygNet’s Enron Modbus implementation. Value: Must be a Boolean value true or false.