...

The filter implements the Fledge Filter plugin interface (see filter_plugins).

Common rules

Filter configuration

See Plugins configuration design for examples and details.

The "config" parameter of  "plugin_init" call shall include :

• A "exchanged_data" category with the same content as provided to the IEC104 south plugin. This section is mandatory so that the filter plugin can convert the PIVOT type from IEC 104 type.
  

Notes :

• All types not listed in this table are not supported in current version.
• The current implementation provides a default mapping rule for each known type, but some new rules might be added in the future and configured using the "alternate_mapping_rule" option in its parameters.

Filter interface

The "plugin_ingest" call will convert each "reading" of "reading_set" as follow:

• The Reading fields "id", "TimeStamp" and "userTimestamp" are unchanged.
• The "asset_name" field shall be mapped with "exchanged_data.datapoints.label"
• The Reading field "reading" is updated with a JSON object {'<Root> key' : {...}} . The content of object under '<Root> key' is given below.

The <Root> key of PIVOT object

...

is:

In the following table: <type> is equal to

...

<type> conversion table:

Converting monitoring data types

...

The content under <Root> will convert the IEC 104 data objet to a pivot object as follow:

Key	Type	Default Value	iec104.data_object.<...>	Note
<Root>.Cause.stVal	Integer

Mandatory

		do_cot	See Cause of Transmission
<Root>.Confirmation.stVal	Boolean	false	do_

confirmation

negative
<Root>.ComingFrom	String

Mandatorydo_comingfromAny protocol name ("iec104" ,"opcua", ...)

		This plugin should always use the value "iec104" when converting to pivot
<Root>.Identifier	String

Mandatory

do_id

do_type

do_id = PIVOT ID

do_type = "opcua_sps" | "opcua_dps" | "opcua_mvi" | "opcua_mvf".

		The plugin will populate the "exchanged_data.datapoints.pivot_id" using the CA-IOA from the input iec104 data object and the "datapoints.protocols.address" from the exchanged_data configuration
<Root>.<type>	{CDC}		do_type	The plugin will populate the "exchanged_data.datapoints.pivot_type" using the ASDU type from the input iec104 data object and the "datapoints.protocols.typeid" from the exchanged_data configuration (see <type> conversion table above)

Other types not supported in current version.

<Root>.<type>.q.

DetailsQuality

Validity = "questionable" <Root>.<type>.q

.test

.DetailQuality.overflow = true	Boolean	false	do_quality_ov = true
<Root>.<type>.q.

operatorBlocked

test

PIVOT : Object
OPCUA : Integer

0do_detail

OR-Mask of following values:

0x0001 = badReference 
0x0002 = failure
0x0004 = inconsistent
0x0008 = innaccurate
0x0010 = oldData
0x0020 = oscillatory
0x0040 = outOfRange
0x0080 = overflow
0x1000 = test
0x2000 = operator blocked

Boolean	false	do_test
<Root>.<type>.

t

q.

TimeQuality

operatorBlocked

Integer

Boolean

0

false

do_

ts

quality_

quality

OR-Mask of following values:

0x01 = clockFailure
0x02 = clockNotSynch
0x04 = leapSecondKnown

bl
<Root>.<type>.q.Source = "substituted"	String	"process"

 

do_quality_

source

sb = true	"process" | "substituted"
<Root>.<type>.q.Validity = "invalid"	String

Mandatory

"good"

do_

value

quality_

quality

iv = true	"good" | "invalid" | "reserved" | "questionable"
<Root>.<type>.t.SecondSinceEpoch	Integer

0

		do_ts
<Root>.TmOrg.stVal	String

Mandatory

	do_ts_org	"genuine" |  "substituted"
<Root>.TmValidity.stVal = "invalid"	String

Mandatory

"good"

do_ts_

validity

iv = true	"good" | "invalid" | "reserved" | "questionable"
<Root>.<type>.q.Validity = "questionable" <Root>.<type>.q.DetailQuality.oldData = true	String	"false"	do_quality_nt = true
<Root>.<type>.q.Validity = "questionable" <Root>.<type>.q.DetailQuality.overflow = true	String	"false"	do_quality_ov = true
<Root>.<type>.q.Validity = "questionable" <Root>.<type>.q.DetailQuality.inconsistent = true	String	"false"	do_quality_iv = true
<Root>.<type>.q.Validity = "questionable" <Root>.<type>.q.DetailQuality.inaccurate = true	String	"false"	do_quality_iv = true
<Root>.SpsTyp.stVal	Boolean

Mandatory 

	do_value
<Root>.DpsTyp.stVal	String

Mandatory 

do_value

See CDC double point status (DPSTyp)

intermediate-state | off | on | bad-state
<Root>.MvTyp.mag.f	Float

Mandatory 

	do_value	Float 32
<Root>.MvTyp.mag.i	Integer		do_value	Int 32
<Root>.BscTyp.valWTr.posVal	Integer

Mandatory do_value

		do_value	Int 8
<Root>.BscTyp.valWTr.transInd	Boolean		do_value	Boolean

Filter rules

STATION => (ASDU) IEC104 SOUTH => (IEC104 DP) IEC104TOPIVOT =>(PIVOT DP) PIVOTTOIEC104 => (IEC104 DP) IEC104 NORTH => (ASDU) CENTER

Rule 1: if the incoming IEC104 data object has not the attribute or has the default value then we don't have to create the corresponding attribute in the pivot object.

Rule 2: If the received pivot object has not an expected attribute then we create the attribute of the protocol specific datapoint with default value.

Rule 3: Case when ASDU timestamp is not received:

A the IEC104TOPIVOT step:
If the received ASDU is without timestamp Then
    We create a pivot object With timestamp = current system time
    And <>.TmOrg.stVal = substituted

On the PIVOTTOIEC104 step:
We create an IEC104 datapoint with timestamp and do_ts_sub = true

IEC104 NORTH step:
If the Datapoint configured in the exchanged data has not IEC104 timestamp typeid
Then we create an ASDU with a typeid with no timestamp
If the Datapoint configured in the exchanged data has IEC104 timestamp typeid
Then we create an ASDU with a timestamp typeid, ASDU timestamp = do_ts And subtituted = do_ts_sub

Converting commands data types

The content under <Root> will convert the IEC 104 command objet to a pivot object as follow:

Filter rules

CENTER => (ASDU) IEC104 NORTH => (IEC104 DP) IEC104TOPIVOT =>(PIVOT DP) PIVOTTOIEC104 => (IEC104 DP) IEC104 SOUTH=> (ASDU) STATION

Rule 1: if the incoming IEC104 command object has not the attribute or has the default value then we don't have to create the corresponding attribute in the pivot object.

Rule 2: If the received pivot object has not an expected attribute then we create the attribute of the protocol specific command with default value.

Rule 3: the timestamp of the original command issued by the Center must be transmitted as is to the Station.

Rule 4: Case when IEC104 command object timestamp is not received for ASDU type with timestamp, then IEC104 command object is rejected with error message.

Rule 5: Case when IEC104 command object for ASDU type without timestamp is received then:

A the IEC104TOPIVOT step:
If the received ASDU is without timestamp Then We create a pivot object With timestamp = current system time