Enron Events Data Group

The "Enron Events" (EnrEvents) data group is used to read events from a field device using the protocol described in the Enron Modbus specification. This data group is typically the source of event and alarm data for FMS. The "Enron Events" data group's names are not constrained, but the dgCat attribute must be set to enronEvents. Enron events are read from register number 32.

Enron specifications dictate the format of the fields in this data group, as well as the register from which to read data. It is not meter-run specific; all events reported for the field device are contained in a single event log.

Per Enron specification, events are cleared from the field device after they’ve been acknowledged. Events are acknowledged only when the Acknowledge flag is set in the UIS command and the communication device is in Master mode. Polls initiated from the data group editor never acknowledge events. Polls initiated from FMS always acknowledge events.

Note: When changing the transaction retention settings for this data group type, you will be prompted to confirm the change. CygNet recommends that data be retained for at least 40 days to be available for CygNet Measurement. Either change the transaction retention settings to retain more data, or accept the settings, which may cause CygNet to lose data that cannot be retrieved again.

For more information, see the following subsections:

For more information about working with device template files, see Device Template Files.

Example

<EnrEvents niceName="Enron Events" dgCat="enronEvents">

<dgElements byteOrder="bigEndian" secLev="4">

<EvtFlags desc="Event Flags" type="ui2" off="0" dMask="0x%04.4x"/>

<CfgChg desc="Cfg Change" ref="EvtFlags" type="boolean" bPos="9"/>

<EvtReg desc="Event Register" type="ui2" off="2"/>

<HistTime desc="Time" type="r4" off="4" hidden="true"/>

<HistDate desc="Date" type="r4" off="8" hidden="true"/>

<DateTime desc="DateTime" type="r8"/>

<AsFound desc="As Found" type="r4" off="12"/>

<AsLeft desc="As Left" type="r4" off="16"/>

</dgElements>

<uccRecvParms>

<Ack required="false" desc="Acknowledge/Clear Events" type="boolean"/>

</uccRecvParms>

</EnrEvents>

Structure and Components

<!--AsFound represents a value prior to an event. AsLeft represents a value after an event. CfgChg represents a reference to a single bit of the Event Flags data group element. It is true when the event is a configuration change and false when it is an alarm. DateTime represents a standard timestamp (COleDateTime) calculated from the HistDate and HistTime data group elements. EvtFlags represents event flags per Enron specification. EvtReg defines the register number of the event origination. HistDate represents the event date. HistTime represents the event time. Ack prevents unintended event acknowledgment. -->

<EnrEvents niceName="Enron Events" dgCat="enronEvents">

<dgElements>

<EvtFlags off=""/>

<CfgChg/>

<EvtReg off=""/>

<HistTime off=""/>

<HistDate off=""/>

<DateTime/>

<AsFound off=""/>

<AsLeft off=""/>

</dgElements>

<uccRecvParms>

<Ack/>

</uccRecvParms>

</EnrEvents>

To Create a Data Group

  1. Using a text editor or XML editor, open the device template file to which you want to add data groups.
  2. Define a new data group that uses the dgCat attribute value enronEvents.
    1. Define a dgElements element.
    2. Define all data group elements required by you to make up your data group. See above for the specific set.
    3. Define a uccRecvParms element in the data group.
    4. Define one or more RecParmName elements. See above for the specific set.
  3. Define any other required data groups.
  4. Validate and load your template.

Back to top