Module description

The gateway south service receives measured values from the AP (south protocol). The station is responsible for the cyclical renewal of the measured valuesstation cyclically according to a predefined period.

The cycling verification period is configurable (30 seconds by default 30 seconds). A measured value is detected as not renewed when if it has not been received during the cycling verification period.

Following the detection of its non-renewal, it is positioned to "questionable" and the "OldData" detail is positioned in the gateway flag is to true and sent to the controlling centers only once through the north protocolsservice.

When the a new measured value is cycled received again , its new value and its associated quality erase the non-renewal fault. The from the station, the measured value is then sent with its new values. 

It's the reception of the first message for a measured value that triggers the non-renewal monitoring functionality.

Configuration

A number of parameters must be configured in the module. The configuration is transmitted by PowerConf. 

...

Parameters

...

Description

...

Default value

...

Value range

value with the corresponding quality and timestamp.

Measured values cycling OK:

Image AddedRenewal of measured values ok

Measured values cycling failed:

Image Added

Configuration

Configuration JSON structure

...

Cyclic period

...

Period when cycling is expected.

0=cyclic check is disabled

...

30 seconds

[0..3600]

The module does not need the list of measured values, it only monitors the ones it receives. When a measured value is received for the first time the module triggers the monitoring of its non renewal. Only measured values with a TOC of "cyclic" are monitored.

Format

{
   "plugincheck_stackperiod":{
      "namedescription":"measured_values_cycling_check check period in seconds.",
      "cyclic_period" :30
   }
}

Pivot model interaction

This module is designed to work on values measured in pivot format. The other types of information are not affected by this module. Outside the detection period of the non-renewal fault, the measured values pass through the module without modification.

Input

type":"integer",
      "default":"30",
      "order":"1",
      "displayName":"Check period"
   }
}

Filtering rules

R1: The measured values cycling check applies only after receiving a first measured value.

R2: The measured values cycling check applies only to measured values with a "cyclical" cause of transmission.

R3: Outside the scope defined by R1 and R2, readings are passed through without any check or change.

Data processing

Input

This filter plugin expects readings to be a pivot model measured values datapoints.

It The module uses the identification (attribute "PIVOTTMPIVOT.GTIM.Identifier") of the data datapoint to obtain the context of the measured value in the module order to :

• Update the date of reception of the measured value,
• Know which measured value to read again in order to send the non-renewal message at the end of the timer.

The module uses the data PIVOTTM PIVOT.GTIM.Cause.stVal (at "cyclic") to determine if the measured value is configured as cyclic. If it is, the module performs the monitoring processing, otherwise the message is ignored.

Output

In case of non-renewal detection, the last measured value received by the module is re-read and the following values are overwritten :

• PIVOTTMPIVOT.GTIM.MvTyp.q.DetailQuality.oldData = True is set to "true"
• PIVOTPIVOTTM.GTIM.MvTyp.q.Validity = is set to "questionable"
• PIVOTTMPIVOT.GTIM.MvTyp.q.Source = is set to "substituted"
• PIVOTTMPIVOT.GTIM.MvTyp.t.SecondSinceEpoch = timestamp of non-renewal detection is set to current gateway timestamp
• PIVOTPIVOTTM.GTIM.MvTyp.t.TimeQuality.clockFailure = if the time source is unreliable (optional)
• PIVOTTM.GTIM.MvTyp.t.TimeQuality.clockNotSynchronized = if not synchronized (optional)
• PIVOTTM.GTIM.TmOrg = "substituted" 
• PIVOTTM.GTIM.TmValidity = Quality of the timestamp of the gateway
• FractionOfSecond is set the fraction of the current gateway second
• PIVOT.GTIM.TmOrg is set to "substituted"
• PIVOT.GTIM.TmValidity.stVal is set to "valid"
• PIVOT.GTIM.Cause.stVal is set to "3" (Spontaneous)

If the timestamp of the gateway is unreliable then:

• PIVOT.GTIM.MvTyp.t.TimeQuality.clockFailure is set to "true"
• PIVOT.GTIM.TmValidity is set to "invalid"

If the timestamp of the gateway is is not synchronized with the external UTC time then:

• PIVOT.GTIM.MvTyp.t.TimeQuality.clockNotSynchronized is set to "true"
• PIVOT.GTIM.TmValidity is set to "invalid"PIVOTTM.GTIM.Cause.stVal = "3" (Spontaneous)