Device Template File Properties

The DNP3 Emerson device template files include sections specific only to DNP3 devices. For more information, see the following subsections:

dnp3Support Element

The dnp3Suppport section of the device template file provides information on specific DNP3-related features: point types and automatic polling. Point types supported by the device are grouped in this section. Automatic polling of associated remote devices is defined by IIN flags in this section.

Example

The following example displays a sample dnp3Support structure.

<dnp3Support fragmentSizeToDev="2048" fragmentSizeFromDev="2048">

<ptTypes canGetRange="true">

<!--funcCode for write operations: SelectOperate, DirectOperate-->

<AI/>

<AO hasEvents="false">

<write funcCode="SelectOperate" maxPts="10"/>

</AO>

<BI/>

<BO hasEvents="false">

<write funcCode="SelectOperate" maxPts="10"/>

</BO>

<CT/>

<CTF/>

<STR hasEvents="false"/>

</ptTypes>

<autoPoll enable="false">

<DeviceLoad cmdType="INTEGRTY">

<!--triggered on UIS restart, RD re-enable-->

</DeviceLoad>

<IIN.1 cmdType="DG_F_DEV" dgType="Event">

<uccParms Class1="true"/>

<!--IIN.1 indicates class 1 events are available-->

</IIN.1>

<IIN.2 cmdType="DG_F_DEV" dgType="Event">

<uccParms Class2="true"/>

<!--IIN.2 indicates class 2 events are available-->

</IIN.2>

<IIN.3 cmdType="DG_F_DEV" dgType="Event">

<uccParms Class3="true"/>

<!--IIN.3 indicates class 3 events are available-->

</IIN.3>

<IIN.4 enable="true" cmdType="DG_T_DEV" dgType="DateTime">

<!--IIN.4 indicates needs time-->

</IIN.4>

<IIN.7 cmdType="RESTART">

<!--IIN.7 indicates a device restart-->

</IIN.7>

<IIN.11 cmdType="INTEGRTY">

<!--IIN.11 indicates event overflow-->

</IIN.11>

</autoPoll>

</dnp3Support>

Attributes

The following table lists and describes attributes generally applicable to the dnp3Support element.

Attribute Description

fragmentSizeFromDev

Indicates the maximum size of the fragment sent from the device to CygNet.

  • Valid range: 249-2048

fragmentSizeToDev

Indicates the maximum size of the fragment sent from CygNet to the device.

  • Valid range: 249-2048

ptTypes Element

The ptTypes element contains an entry for each point type supported by the device. In CygNet Explorer, the Single Point and Event parameters dialog boxes will only include point types listed in ptTypes element.

Attributes

The following table lists and describes attributes applicable to the ptTypes element.

Attribute Description

canGetDiscrete

Indicates whether the device will accept messages formatted to have a discrete set of points when requesting data. The flags can be set at the parent (ptTypes) element and inherited for each point type. The default value is false.

canGetRange

Indicates whether the device will accept messages formatted to have a range of points when requesting data. The flags can be set at the parent (ptTypes) element and inherited for each point type. The default value is false.

canSetDiscrete

Indicates whether the device will accept messages formatted to have a discrete set of points when sending data. The flags can be set at the parent (ptTypes) element and inherited for each point type. The default value is false.

canSetRange

Indicates whether the device will accept messages formatted to have a range of points when sending data. The flags can be set at the parent (ptTypes) element and inherited for each point type. The default value is false.

ptTypes Child Elements

The ptTypes element supports the following child elements.

Element Description

point types

Each point type used in devices that support the DNP3 protocol, e.g. AI, AID, AIF, AO, BI, BI2, BO, CT, CTF, IIN, STR is represented as a unique node.

Point Types

The following table lists the point types used in devices that support DNP3 protocol. For more specific information about point types, see the appropriate manufacturer-provided documentation.

Point Type Point Name Description
Analog AI Analog Input
Analog AID Analog Input Deadband
Analog AIF Analog Input Frozen
Analog AO Analog Output
Binary BI Binary Input
Binary BI2 Double-bit Binary Input
Binary BO Binary Output
Counter CT Counter
Counter CTF Counter Frozen
IIN IIN Internal Indications
String STR String

Each point type can contain the following attribute:

  • hasEvents — Indicates whether or not events are supported for the point type. The default value is true.

dataTypes

The dataTypes element enumerates which data types are supported for the point type. If none are listed, all are supported.

write

The write element contains attributes pertaining to sending binary output and analog output values to the device:

  • funcCode — Indicates which function code to use on a write. The default value is SelectOperate. Options are:
    • SelectOperate
    • DirectOperate
  • maxPts — Indicates the maximum number of points that can be sent in a single message. The default value is 1.

Back to top

autoPoll Element

An integrity poll is automatically performed when the autoPoll element is enabled in the dnp3Support element section of the device template file, according to the DNP3 Internal Indication Number (IIN) flags present. IIN.0 to IIN.15 flags are supported and are defined in the "Internal Indications" (IntInd) data group in the device template file. See the for DNP3 EIE and DNP3 Emerson EIE data groups for more information.

When autoPoll is enabled, the EIE automatically performs the associated configured command (cmdType) according to the IIN flags present. The default configuration for a device type is configured in the device template file. Each device instance can be individually enabled in the device template file, or optionally overridden at the device level. To override the template for individual device instances, use the Auto poll button on the Device tab of the remote device editor. See Polling Notes for more information about auto polling.

Elements

The autoPoll element supports the following child elements. See the sample AutoPoll structure above.

Element Description

DeviceLoad

The DeviceLoad element indicates the UIS device load and command. DeviceLoad has the following parameter options:

DeviceLoad attribute

  • cmdtype — the name of a UIS command type to be performed: INTEGRTY, or any UIS command defined in the defUisCmds section of the device template file. A cmdtype attribute is required.

IIN.n flag

The IIN.n elements represent the internal indication (IIN) flags. Each IIN.n flag has the same parameter options:

IIN.n attributes

  • cmdtype — the name of the UIS command type to be performed: DG_F_DEV, DG_T_DEF, INTEGRTY, RESTART, or any UIS command defined in the defUisCmds section of the device template file. Required.
  • dgType — the data group type. If cmdType is DG_F_DEV or DG_T_DEV, the data group type (dgType) attribute must be specified. If that data group requires parameters, they are defined in the uccParms element.

uccParms element

A uccParms element, UIS command component parameters (UCC parameters), is supported if the data group has required parameters:

  • Classn — the class event number available, e.g. Class1, Class2, or Class3, with a value of true if that event type is to be automatically polled.

Back to top

enums Element

The following enumerations identify EFM item numbers used in FMS Configuration and FMS History data group mapping. The EFM item numbers are contained in the enums section of the device template file.

EEfmItemCfg

The EEfmItemCfg enumeration identifies the configuration EFM item number. This set of enumerations was provided by Emerson and is subject to change. Each item in the meter configuration includes an EFM item number. The DEID created for each item in the data group includes the EFM item number (for example, C0001 for EFM item number 1).

Example

The following example displays a sample EEfmItemCfg structure.

<enums>

<EEfmItemCfg>

<e1 value="1-Meter #"/>

<e2 value="2-Meter name"/>

<e3 value="3-Serial #"/>

<e4 value="4-Meter type"/>

<e5 value="5-Power source"/>

…

</EEfmItemCfg>

</enums>

EEfmItemHist

The EEfmItemHist enumeration identifies the history EFM item number. This set of enumerations was provided by Emerson and is subject to change. History configuration items may include history EFM item number.

Example

The following example displays a sample EEfmItemHist structure.

<enums>

<EEfmItemHist>

<e1 value="01-Flow time"/>

<e2 value="02-DP"/>

<e3 value="03-Raw pulses"/>

<e4 value="04-SP"/>

<e5 value="05-Temp"/>

…

</EEfmItemHist>

</enums>

EMtrTypeInst

The EMtrTypeInst enumeration identifies the meter a type/instance number. The "Hist - Station" data groups consist of data elements that are created dynamically based on data read from the device in the History Configuration (HistCfg) data group. History configuration items include a type/instance number identifying the meter to which it applies.

Example

The following example displays a sample EMtrTypeInst structure.

<enums>

<EMtrTypeInst>

<e10 value="010-DP Meter 1"/>

<e11 value="011-DP Meter 2"/>

…

<e110 value="110-Linear Meter 1"/>

<e111 value="111-Linear Meter 2"/>

…

</EMtrTypeInst>

</enums>

Back to top

fmsMaps Element

The fmsMaps section of a device template file allow the following attributes in configItems. This is not a complete list of supported attributes, refer to the device template file.

Attribute Description

deid

The deid attribute represents a data element ID in a native meter configuration (MtrCfgDp, MtrCfgLin, and MtrCfgLiq) data groups or history data group (HistCfg).

efmItem

The efmItem attribute represents an EFM Item in a native history data group (HistCfg).

tag

The tag attribute represents an Emerson point tag. It can include substitution strings for meter (%meter%), station (%station%) or gas composition (%comp%). It is used primarily for events and alarms.

Note: When any of the attributes described above are used in the context of history data, the type/instance number in the History Configuration (HistCfg) data group is used to determine if an item is relevant to the current meter type and number.

when clause

A when clause can be used to limit when an attribute is relative to the current meter. It follows the usual CygNet format. The meter type specified in the FMS Configuration data group properties is cached as MtrType for use in when clauses. Meter types are 0=DP, 1=Linear, 2=Liquid Linear.

Back to top

statusFlags Element

The statusFlags section of a DNP3 device template file is an optional section that indicates how to map flags from the device to point status bits in the PNT. If omitted, none of the flags from the device will be mapped to CygNet status bits. This section contains an element for each flag set by the device. Only the flags that the user is interested in mapping need to be included in the device template file.

Example

The following example displays a sample statusFlags structure.

Copy
<statusFlags>
<statusFlags>
    <online state="false" setUnreliable="true"/>
    <restart state="true" setUnreliable="true"/>
    <commLost state="true" setUnreliable="true"/>
    <remoteForced state="true" setUser13="true"/>
    <localForced state="true" setUser13="true" setUser14="true"/>
    <chatterFilter state="true" setUnreliable="true"/>
    <overRange state="true" setUnreliable="true" setUser15="true"/>
    <discontinuity state="true" setUser16="true"/>
    <referenceErr state="true" setUnreliable="true"/>
</statusFlags>

DNP3 Status Flag Elements

The following table describes the child elements of the statusFlags element, which correspond to the DNP3 status flags. For more information, see the DNP3 documentation.

Property Description

chatterFilter

When set, indicates the value is presently changing values rapidly; applies to binary input and double-bit binary input point types.

commLost

If true, there is a communication failure in the path between the device where the data originates and the reporting device and that the value reported may be stale.

discontinuity

If true, the reported counter value cannot be compared against a prior value to obtain the correct count difference; applies to counter point types.

localForced

If set, indicates the value is overridden by the device that reports this flag as set.

online

A bit value of 1 indicates the point is active; a bit value of 0 indicates the point is inactive, unavailable, or out-of-service.

overRange

If set, indicates that a point’s value exceeds the valid measurement range of the point; applies to analog input point types.

referenceErr

If set, the measurement process determined that the point’s value might not be accurate; applies to analog input point types.

remoteForced

If true, the value is overridden in a downstream reporting device.

restart

When true, indicates the point has not been updated from the field since device reset.

Attributes

The following table lists and describes the attributes applicable to the status flag elements.

Attributes Description

state

The state attribute indicates whether to perform the defined actions when the bit is set (true) or cleared (false).

setUnreliable

setUser1 - setUser16

Each flag may include the following attributes that map to CygNet point status bits in the PNT:

  • setUnreliable
  • setUser1
  • setUser2
  • setUser3
  • setUser4
  • setUser5
  • setUser6
  • setUser7
  • setUser8
  • setUser9
  • setUser10
  • setUser11
  • setUser12
  • setUser13
  • setUser14
  • setUser15
  • setUser16

Indicate whether to set the bit as (true) or cleared (false).

See Point Status Bits for a description of CygNet status bits that can be mapped.