draw.io Diagram

border	true

diagramName	protocol_conversion_process
simpleViewer	false
width
links	auto
tbstyle	top
lbox	true
diagramWidth	1421
revision	32

Pivot object model

The pivot object model is based on 61850 semantic.

Pivot model representing a Tele Measurement:

PIVOT TM model, representation of a tele measurement

Attribute	Description	Expected values	Mandatory
PIVOT.GTIM.Beh.stVal	?
PIVOT.GTIM.Cause.stVal	Cause of transmission	COT Cause of Transmission - FledgePower - LF Energy	Yes
PIVOT.GTIM.ChgValCnt.stVal	?
PIVOT.GTIM.ComingFrom	Source protocol name	IEC103, IEC104, TASE.2, OPCUA, 61850, etc...	Yes
PIVOT.GTIM.Confirmation.stVal	Indicates positive or negative confirmation of activation	true, false, DEFAULT=false
PIVOT.GTIM.Identifier	Unique identifier of the pivot object	Any non-empty string	Yes
PIVOT.GTIM.{CDC}	Common Data Class representing the information object	MVTyp Common Data Classes - FledgePower - LF Energy	Yes
PIVOT.GTIM.NormalSrc.stVal	?
PIVOT.GTIM.NormalVal.stVal	?
PIVOT.GTIM.TmOrg.stVal	Timestamp origin, genuine = source otherwise substituted	genuine, substituted, DEFAULT = genuine	Yes
PIVOT.GTIM.TmValidity.stVal	Timestamp validity	valid, invalid, DEFAULT = valid	Yes

Example of a pivot model instance representing a Tele Measurement:

Code Block

language	js

{
	"@xmlns:xs": "http://www.w3.org/2001/XMLSchema",
	"PIVOT": {
		"GTIM": {
			"Beh": {
				"stVal": "on"
			},
			"Cause": {
				"stVal": 1
			},
			"ChgValCnt": {
				"stVal": 1
			},
			"ComingFrom": "String",
			"Confirmation": {
				"stVal": true
			},
			"Identifier": "String",
			"MvTyp": {
				"mag": {
					"f": 0.1

Code Block

language	js

{
	"@xmlns:xs": "http://www.w3.org/2001/XMLSchema",
	"PIVOTTM": {
		"GTIM": {
			"Beh": {
				"stVal": "on"
			},
			"Cause": {
				"stVal": 1
			},
			"ChgValCnt": {
				"stVal": 1
			},
			"ComingFrom": "String",
			"Confirmation": {
				"stVal": true
			},
			"Identifier": "String",
			"MvTyp": {
				"mag": {
					"f": 0.1,
					"i": 1
				},
				"q": {
					"DetailQuality": {
						"badReference": true,
						"failure": true,
						"inconsistent": true,
						"innacurate": true,
						"oldData": true,
						"oscillatory": true,
						"outOfRange": true,
						"overflow": true
					},
					"Source": "process",
					"Validity": "good",
					"operatorBlocked": true,
					"testi": true1
				},
				"tq": {
					"FractionOfSecondDetailQuality": 1,{
						"SecondSinceEpochbadReference": 1true,
						"TimeQualityfailure": {true,
						"clockFailureinconsistent": true,
						"clockNotSynchronizedinnacurate": true,
						"leapSecondKnownoldData": true,
						"timeAccuracyoscillatory": 1true,
					}
				}"outOfRange": true,
			},
			"NormalSrcoverflow": {true
				"stVal": "TELEMETERED"
			},
					"NormalValSource": {"process",
					"stValValidity": "NORMALgood",
			},
			"OriginoperatorBlocked": {true,
					"qtest": {true
				},
				"DetailQualityt": {
						"badReferenceFractionOfSecond": true1,
						"failureSecondSinceEpoch": true1,
						"inconsistentTimeQuality": true,{
						"innacurateclockFailure": true,
						"oldDataclockNotSynchronized": true,
						"oscillatoryleapSecondKnown": true,
						"outOfRangetimeAccuracy": true,1
					}
		"overflow": true
		}
			},
					"SourceNormalSrc": "process",{
					"ValiditystVal": "goodTELEMETERED",
			},
			"operatorBlockedNormalVal": true,{
					"teststVal": true"NORMAL"
				},
				"stValOrigin": "String",{
				"q": {
					"tDetailQuality": {
						"FractionOfSecondbadReference": 1true,
						"SecondSinceEpochfailure": 1true,
						"TimeQualityinconsistent": {true,
						"clockFailureinnacurate": true,
						"clockNotSynchronizedoldData": true,
						"leapSecondKnownoscillatory": true,
						"timeAccuracyoutOfRange": 1true,
					}
	"overflow": true
					},
			},
			"TmOrgSource": {"process",
					"stValValidity": "genuinegood",
			},
			"TmValidityoperatorBlocked": {true,
					"stValtest": "VALID"true
				},
		}
	}
}

Pivot model representing a Tele Signal:

Code Block

language	js

{
	"@xmlns:xs	"stVal": "http://www.w3.org/2001/XMLSchemaString",
				"PIVOTTSt": {
					"GTISFractionOfSecond": {1,
					"BehSecondSinceEpoch": {1,
					"stValTimeQuality": "on"{
			},
			"CauseclockFailure": {true,
						"stValclockNotSynchronized": 1true,
			},
			"ChgValCntleapSecondKnown": {true,
						"stValtimeAccuracy": 1
			},
			"ComingFrom": "String",}
			"Confirmation": {
				"stVal": true	}
			},
			"DpsTypTmOrg": {
				"qstVal": {
					"DetailQuality": {"genuine"
						"badReference": true},
						"failureTmValidity": true,{
						"inconsistentstVal": true,
						"innacurate": true,"VALID"
			}
		}
	}
}

PIVOT TS model, representation of a tele signal

Attribute	Description	Expected values	Mandatory
PIVOT.GTIS.Beh.stVal	?
PIVOT.GTIS.Cause.stVal	Cause of transmission	COT Cause of Transmission - FledgePower - LF Energy	Yes
PIVOT.GTIS.ChgValCnt.stVal	?
PIVOT.GTIS.ComingFrom	Source protocol name	IEC103, IEC104, TASE.2, OPCUA, 61850, etc...	Yes
PIVOT.GTIS.Confirmation.stVal	Indicates positive or negative confirmation of activation	true, false, DEFAULT=false
PIVOT.GTIS.Identifier	Unique identifier of the pivot object	Any non-empty string	Yes
PIVOT.GTIS.{CDC}	Common Data Class representing the information object	SPSTyp, DPSTyp, BSCTyp Common Data Classes - FledgePower - LF Energy	Yes
PIVOT.GTIS.NormalSrc.stVal	?
PIVOT.GTIS.NormalVal.stVal	?
PIVOT.GTIS.TmOrg.stVal	Timestamp origin, genuine = source otherwise substituted	genuine, substituted, DEFAULT = genuine	Yes
PIVOT.GTIS.TmValidity.stVal	Timestamp validity	valid, invalid, DEFAULT = valid	Yes

Example of a pivot model instance representing a Tele Signal:

Code Block

language	js

{
	"@xmlns:xs": "http://www.w3.org/2001/XMLSchema",
	"PIVOT": {
		"GTIS": {
			"Beh": {
				"stVal": "on"
			},
			"Cause": {
				"stVal": 1
			},
			"ChgValCnt": {
				"stVal	"oldData": true,
						"oscillatory": true,
						"outOfRange": true,
						"overflow": true
					},
					"Source": "process",
					"Validity": "good",
					"operatorBlocked": true,
					"test": true
				},
				"stVal": "intermediate-state",
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				}
			},
			"IdentifierComingFrom": "String",
			"NormalSrcConfirmation": {
				"stVal": "TELEMETERED"true
			},
			"NormalValDpsTyp": {
				"stVal": "NORMAL"
			},
			"Origin": {
				"q": {
					"DetailQuality": {
						"badReference": true,
						"failure": true,
						"inconsistent": true,
						"innacurate": true,
						"oldData": true,
						"oscillatory": true,
						"outOfRange": true,
						"overflow": true
					},
					"Source": "process",
					"Validity": "good",
					"operatorBlocked": true,
					"test": true
				},
				"stVal": "Stringintermediate-state",
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				}
			},
			"SpsTypIdentifier": {"String",
				"qNormalSrc": {
					"DetailQualitystVal": {"TELEMETERED"
			},
			"badReferenceNormalVal": true,{
						"failurestVal": true,"NORMAL"
			},
			"inconsistentOrigin": true,{
						"innacurateq": true,{
						""DetailQuality": {
						"badReference": true,
						"failure": true,
						"inconsistent": true,
						"innacurate": true,
						"oldData": true,
						"oscillatory": true,
						"outOfRange": true,
						"overflow": true
					},
					"Source": "process",
					"Validity": "good",
					"operatorBlocked": true,
					"test": true
				},
				"stVal": true"String",
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				}
			},
			"TmOrgSpsTyp": {
				"stValq": "genuine"{
			},
			"TmValidityDetailQuality": {
						"stValbadReference": "VALID"true,
			}
		}
	}
}

Pivot model representing a Tele Command:

Code Block

language	js

{
	"@xmlns:xs": "http://www.w3.org/2001/XMLSchema",
	"PIVOTTC": {
		"GTIC": {
			"Beh": {	"failure": true,
						"inconsistent": true,
						"innacurate": true,
						"oldData": true,
						"stValoscillatory": "on"true,
			},
			"CauseoutOfRange": {true,
						"stValoverflow": 1true
					},
					"ComingFromSource": "Stringprocess",
					"DevIdValidity": {"good",
					"nameoperatorBlocked": "String"true,
			},
			"DevSttest": {true
				},
				"qstVal": {true,
					"DetailQualityt": {
						"badReferenceFractionOfSecond": true1,
						"failureSecondSinceEpoch": true1,
						"inconsistentTimeQuality": true,{
						"innacurateclockFailure": true,
						"oldDataclockNotSynchronized": true,
						"oscillatoryleapSecondKnown": true,
						"outOfRangetimeAccuracy": true,1
					}
		"overflow": true
		}
			},
					"SourceTmOrg": "process",{
					"ValiditystVal": "goodgenuine",
			},
			"operatorBlockedTmValidity": true,{
					"teststVal": true"VALID"
				},
		}
	}
}

PIVOT TC model, representation of a tele command

Attribute	Description	Expected values	Mandatory
PIVOT.GTIC.Beh.stVal	defines different behaviours of a control object: - Direct control with normal security: dct-ctl-wns - Direct control with enhanced security: dct-ctl-wes - SBO (Select Before Operate) control with normal security: sbo-ctl-wns - SBO (Select Before Operate) control with enhanced security: sbo-ctl-wes	enum: dct-ctl-wns, dct-ctl-wes, sbo-ctl-wns, sbo-ctl-wes, DEFAULT = dct-ctl-wes	No
PIVOT.GTIC.Cause.stVal	Cause of transmission	COT Cause of Transmission - FledgePower - LF Energy	No
PIVOT.GTIC.ComingFrom	Source protocol name	IEC103, IEC104, TASE.2, OPCUA, 61850, etc...	Yes
PIVOT.GTIC.DevId.name	?		No
PIVOT.GTIC.{CDC}	Common Data Class representing the information object	SPCTyp, DPCTyp, INCTyp, APCTyp, BSCTyp Common Data Classes - FledgePower - LF Energy	Yes
PIVOT.GTIC.Identifier	Unique identifier of the pivot object	Any non-empty string	Yes
PIVOT.GTIC.Qu.stVal	?		No
PIVOT.GTIC.ServiceType.stVal	?		No
PIVOT.GTIC.Tag.stVal	?		No
PIVOT.GTIC.TagClass	?		No
PIVOT.GTIC.TaggedReason	?		No
PIVOT.GTIC.TmOrg	Timestamp origin, genuine = source otherwise substituted	genuine, substituted, DEFAULT = genuine	No
PIVOT.GTIC.TmStamp	Timestamp		No

Example of a pivot model instance representing a Tele Command:

Code Block

language	js

{
	"@xmlns:xs": "http://www.w3.org/2001/XMLSchema",
	"PIVOT": {
		"GTIC": {
			"Beh": {
				"stVal": "dct-ctl-wes"
			},
			"Cause": {
				"stVal": 1
			},
			"ComingFrom": "String",
			"DevId": {
				"name": "String"
			},
			"DevSt": {
				"q": {
					"DetailQuality": {
						"badReference": true,
						"failure": true,
						"inconsistent": true,		"stVal": true,
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				}
			},
			"DpcTyp": {
				"ctlVal": true,
				"q": {
					"DetailQuality": {
						"badReference": true,
						"failure": true,
						"inconsistent": true,
						"innacurate": true,
						"oldData": true,
						"oscillatory": true,
						"outOfRange": true,
						"overflow": true
					},
					"Source": "process",
					"Validity": "good",
					"operatorBlocked": true,
					"test": true
				},
				"stVal": "intermediate-state",
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailureinnacurate": true,
						"clockNotSynchronizedoldData": true,
						"leapSecondKnownoscillatory": true,
						"timeAccuracyoutOfRange": 1true,
					}
	"overflow": true
					},
			},
			"IdentifierSource": "Stringprocess",
					"QuValidity": {"good",
					"stValoperatorBlocked": 1true,
			},
			"ServiceTypetest": {true
				},
				"stVal": "select"true,
			},
			"SpcTypt": {
					"ctlValFractionOfSecond": true1,
					"qSecondSinceEpoch": {1,
					"DetailQualityTimeQuality": {
						"badReferenceclockFailure": true,
						"failureclockNotSynchronized": true,
						"inconsistentleapSecondKnown": true,
						"innacuratetimeAccuracy": true,1
						"oldData": true,}
				}
			},
			"oscillatoryDpcTyp": true,{
						"outOfRangectlVal": true,
						"overflowq": true{
					},
"DetailQuality": {
						"SourcebadReference": "process"true,
						"Validityfailure": "good"true,
						"operatorBlockedinconsistent": true,
						"testinnacurate": true,
				},
				"stValoldData": true,
						"toscillatory": {true,
						"FractionOfSecondoutOfRange": 1true,
						"SecondSinceEpochoverflow": 1,true
					"TimeQuality": {},
						"clockFailureSource": true"process",
						"clockNotSynchronizedValidity": true"good",
						"leapSecondKnownoperatorBlocked": true,
						"timeAccuracytest": 1true
					},
				}"stVal": "intermediate-state",
			},
			"Tagt": {
					"stValFractionOfSecond": "NO-TAG"1,
			},
				"TagClassSecondSinceEpoch": {1,
					"qTimeQuality": {
						"DetailQualityclockFailure": {true,
						"badReferenceclockNotSynchronized": true,
						"failureleapSecondKnown": true,
						"inconsistenttimeAccuracy": true,1
						"innacurate": true,}
				}
			},
			"oldDataIdentifier": true"String",
			"Qu": {
				"oscillatorystVal": true,1
			},
			"outOfRangeServiceType": true,{
						"overflowstVal": true"select"
					},
					"SourceSpcTyp": "process",{
					"ValidityctlVal": "good"true,
					"operatorBlockedq": true,{
					"testDetailQuality": true{
				},
				"stValbadReference": true,
				"t": {
					"FractionOfSecondfailure": 1true,
						"SecondSinceEpochinconsistent": 1true,
						"TimeQualityinnacurate": {true,
						"clockFailureoldData": true,
						"clockNotSynchronizedoscillatory": true,
						"leapSecondKnownoutOfRange": true,
						"timeAccuracyoverflow": 1true
					},
				}	"Source": "process",
			},
			"TaggedReasonValidity": "Stringgood",
					"TmOrgoperatorBlocked": {true,
					"stValtest": "genuine"true
				},
				"TmStampstVal": {true,
				"qt": {
					"DetailQualityFractionOfSecond": {1,
						"badReferenceSecondSinceEpoch": true1,
						"failureTimeQuality": true,{
						"inconsistentclockFailure": true,
						"innacurateclockNotSynchronized": true,
						"oldDataleapSecondKnown": true,
						"oscillatorytimeAccuracy": true,1
						"outOfRange": true,}
						"overflow": true
	}
				},
					"SourceTag": "process",{
					"ValiditystVal": "goodNO-TAG",
			},
			"operatorBlockedTagClass": true,{
					"testq": true{
				},
				"stValDetailQuality": {
						"FractionOfSecondbadReference": 1true,
						"SecondSinceEpochfailure": 1true,
						"TimeQualityinconsistent": {true,
						"clockFailureinnacurate": true,
						"clockNotSynchronizedoldData": true,
						"leapSecondKnownoscillatory": true,
						"timeAccuracyoutOfRange": 1true,
						}"overflow": true
					},
					"tSource": {"process",
					"Validity": "good",
					"operatorBlocked": true,
					"test": true
				},
				"stVal": true,
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				}
			},
		}
	}
}

Protocol translation process

draw.io Diagram

border	true
diagramName	protocols_conversion_process
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1061
revision	6

Protocol translation configuration

Code Block

language	js

{
   "protocol_translation":{
      "name":"SAMPLE",
      "version":"1.0",
      "mapping_rules":[
         {
            "input_type":"M_SP_TB_1",
            "output_type":"SpsTyp",
            "mapping_rule":"104toP_1"
         },
         {
            "input_type":"M_DP_TB_1",
            "output_type":"DpsTyp",
            "mapping_rule":"104toP_2"
         },
         {
            "input_type":"M_ME_NA_1",
            "output_type":"MvTyp",
            "mapping_rule":"104toP_3"
         },
         {
            "input_type":"M_ME_NC_1",
            "output_type":"MvTyp",
            "mapping_rule":"104toP_4"
         },
         {
            "input_type":"SpsTyp",
            "output_type":"M_SP_TB_1",
            "mapping_rule":"Pto104_1"
         },
         {
            "input_type":"DpsTyp",
            "output_type":"M_DP_TB_1",
            "mapping_rule":"Pto104_2"
         },
         {
            "input_type":"MvTyp",
            "output_type":"M_ME_NA_1",
            "mapping_rule":"Pto104_3"
         },
         {
            "input_type":"MvTyp",
            "output_type":"M_ME_NC_1",
            "mapping_rule":"Pto104_4"
         },
         {
            "input_type":"SpsTyp",
            "output_type":"Data_StateQTimeTagExtended",
            "mapping_rule":"PtoT2_1"
         },
         {
            "input_type":"DpsTyp",
            "output_type":"Data_DiscreteQTimeTagExtended",
            "mapping_rule":"PtoT2_2"
         },
         {
            "input_type":"MvTyp",
            "output_type":"Data_RealQ",
            "mapping_rule":"PtoT2_3"
         }
      ]
   }
}

Exchanged data configuration

In this chapter we will describe the configuration of the exchanged data. This configuration allow to specify a list of supported data objects. The protocol plugin is expected to make some controls against each entry of the configuration to check:

if CA of ASDU is known otherwise throw an error message.
if IOA is known otherwise throw an error message.
if type of ASDU is known otherwise an error message.
The label attribute shall be used to populate the Fledge's DataPoint Asset Name attribute.

Attributes definition

...

Configuration JSON structure

Code Block

language	js

{
   "exchanged_data":{
      "name":"SAMPLE",
      "version":"1.0",
      "datapoints":[
         {
            "label":"TS1",
            "pivot_id":"ID114562",
            "pivot_type":"SpsTyp",
            "protocols":[
               {
                  "name":"iec104",
                  "address":"45-672",
                  "typeid":"M_SP_TB_1"
               },
               {
                  "name":"tase2",
                  "address":"S_114562",
                  "typeid":"Data_StateQTimeTagExtended"
               }
            ]
         },
         {
            "label":"TM1",
            "pivot_id":"ID99876",
            "pivot_type":"DpsTyp",
            "protocols":[
               {
                  "name":"iec104",
                  "address":"45-984",
                  "typeid":"M_ME_NA_1"
               },
               {
                  "name":"tase2",
                  "address":"S_114562",
                  "typeid":"Data_RealQ"
               }
            ]
         }
      ]
   }
}

IEC 104 south plugin (client/master)

IEC 104 Protocol stack configuration

The IEC 104 protocol stack configuration specifies communication parameters and is a collection of entries containing information about OSI Transport and OSI Application layers objects.

Each entry is comprised of attributes that describe the object. All the configuration data are structured using JSON.

Each entry shall be mapped with the corresponding configuration function in the chosen implementation protocol library.

Attributes definition

...

IP address, machine's default IP for a given interface

...

maximum ASDU size in transmission direction, if set to "0" => maximum possible value is automatically used.

...

remove, process, default = remove

remove: the time stamp will be removed from the information object

process: the time stamp will be processed on regular basis and additionally marked as 'not synchronized'

...

	"TaggedReason": "String",
			"TmOrg": {
				"stVal": "genuine"
			},
			"TmStamp": {
				"q": {
					"DetailQuality": {
						"badReference": true,
						"failure": true,
						"inconsistent": true,
						"innacurate": true,
						"oldData": true,
						"oscillatory": true,
						"outOfRange": true,
						"overflow": true
					},
					"Source": "process",
					"Validity": "good",
					"operatorBlocked": true,
					"test": true
				},
				"stVal": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				},
				"t": {
					"FractionOfSecond": 1,
					"SecondSinceEpoch": 1,
					"TimeQuality": {
						"clockFailure": true,
						"clockNotSynchronized": true,
						"leapSecondKnown": true,
						"timeAccuracy": 1
					}
				}
			}
		}
	}
}

Protocol translation process

draw.io Diagram

border	true

diagramName	protocols_conversion_process
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1061
revision	11

Exchanged data configuration

In this chapter we will describe the configuration of the exchanged data. This configuration allow to specify a list of supported data objects. The protocol plugin is expected to make some controls against each entry of the configuration to check:

if protocol message address or reference is known otherwise throw an error message.
if protocol type of message is known otherwise throw an error message.
The label attribute shall be used to populate the Fledge's DataPoint Asset Name attribute.

Attributes definition

Attribute	Description	Expected values	Mandatory
name	this identifies the exchanged data configuration		Yes
version	this is the version number of the configuration	x.y where x represents a major version and y a minor change	Yes
datapoints	array of datapoints that needs to be managed by the instance of the gateway		Yes
datapoints.label	label of the datapoint	any non empty string	Yes
datapoints.pivot_id	unique identifier of the datapoint, this is used to create a pivot object	any non empty string	Yes
datapoints.pivot_type	type of Common Data Class (CDC), this is used to create a pivot object	enum SpsTyp \| DpsTyp \| MvTyp \| SpcTyp \| DpcTyp \| ...	Yes
datapoints.pivot_subtypes	array of additional types of the pivot object	[transient, ...]	No
datapoints.tfid	identifies the math function to transform the input value	enum "normal" \| "square_root" \| "quadratic" \| "transparent"	No
datapoints.params	array of parameters for the math function	array of float 32 [a, b, c, ...]	No
datapoints.deadband	band of input values where the output is zero	array of 2 float 32 [min, max]	No
datapoints.protocols	array of protocols that needs to be managed for a datapoint		Yes
datapoints.protocols.name	name of the protocol	enum "iec104" \| "iec103" \| "tase2" \| "hnz" \| "61850" \| "opcua" \| ...	Yes
datapoints.protocols.address	address of the datapoint in the given protocol	any non empty string	Yes
datapoints.protocols.typeid	type id of the datapoint in the given protocol	any non empty string representing a valid protocol type id	Yes
datapoints.protocols.gi_groups	GI request status for north plugins, if "station" then datapoint is send for south plugins, it determines whether a datapoint is expected in the GI response	enum station \| 1 \| 2 \| ...	No
datapoints.protocols.alternate_mapping_rule	Alternate mapping rule to convert datapoint from protocol model to pivot or pivot to protocol model, if not specified then default conversion rule is applied	any non empty string representing a function name	No
datapoints.operations	array of operations applied to produce a value for the current datapoint out of one or more input datapoints		No
datapoints.operations.operation	type of operation to perform	enum "or"	No
datapoints.operations.input	array of Pivot ID of datapoints to use as inputs for the operation	array of Pivot ID strings	No

Configuration JSON structure

Code Block

language	js

{
   "exchanged_data":{
      "name":"SAMPLE",
      "version":"1.0",
      "datapoints":[
         {
            "label":"TS1",
            "pivot_id":"ID114562",
            "pivot_type":"SpsTyp",
            "pivot_subtypes":[
               "transient"
            ],
			"operations":[
				{
              		"operation":"or",
					"input":[
						"ID114562",
						"ID114563"
					]
				}
            ],
            "protocols":[
               {
                  "name":"iec104",
                  "address":"45-672",
                  "typeid":"M_SP_TB_1",
                  "gi_groups":"station",
                  "alternate_mapping_rule":"func_name_1"
               },
               {
                  "name":"tase2",
                  "address":"S_114562",
                  "typeid":"Data_StateQTimeTagExtended"
               },
               {
                  "name":"opcua",
                  "address":"ID114562",
                  "typeid":"opcua_sps"
               },
               {
                  "name":"iec61850",
                  "address":"simpleIOGenericIO/GGIO1.Ind1",
                  "typeid":"SPS"
               }
            ]
         },
         {
            "label":"TM1",
            "pivot_id":"ID99876",
            "pivot_type":"MVTyp",
            "tfid":"square_root",
            "params":[
               2.0,
               49.5
            ],
            "deadband":[
               -0.02,
               0.02
            ],
            "protocols":[
               {
                  "name":"iec104",
                  "address":"45-984",
                  "typeid":"M_ME_NA_1"

Configuration JSON structure

Code Block

language	js

{
   "protocol_stack":{
      "name":"iec104client",
      "version":"1.0",
      "transport_layer":{
         "connection":{
            "path":[
               {
                  "srv_ip":"192.168.0.10",
                  "clt_ip":"",
                  "port":2404
               },
               {
                  "srv_ip":"192.168.0.11",
                  "clt_ip":"",
                  "port":2404
               }
            ],
            "tls":false
         },
         "k_value":12,
         "w_value":8,
         "t0_timeout":10,
         "t1_timeout":15,
         "t2_timeout":10,
         "t3_timeout":20,
         "conn_all":true,
         "start_all":false,
         "conn_passv":false
      },
      "application_layer":{
         "orig_addr":0,
         "ca_asdu_size":2,
         "ioaddr_size":3,
         "startup_time":180,
         "asdu_size":0,
         "gi_time":60,
         "gi_cycle":false,
         "gi_all_ca":false,
         "gi_repeat_count":2,
         "disc_qual":"NT",
         "send_iv_time":0,
         "tsiv":"REMOVE",
         "utc_time":false,
         "comm_wttag":false,
         "comm_parallel":0,
         "exec_cycl_test":false,
         "startup_state":true,
         "reverse":false,
         "time_sync":false
      }
   }
}

IEC 104 datapoint representation

This is the Datapoint representation of an IEC 104 ASDU.

Code Block

language	js

{
   "data_object":{
      "do_type":"type_id",
      "do_ca":"ca",
      "do_oa":"oa",
      "do_cot":"cot",
      "do_test":"istest",
      "do_negative":"isnegative",
      "do_ioa":"ioa",
      "do_value":"value",
      "do_quality":"quality_desc",
      "do_ts":"time_marker",
      "do_ts_qual":"isinvalid",
      "do_ts_sum_time":"isSummerTime"
   }
}

Path exploration

draw.io Diagram

border	true
diagramName	fp_path_exploring
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	343
revision	3

In redundant network configuration or generally in cases where several communication paths exist between one client and one server, the path checking exploration mechanism allows the client to try all the paths one by one without making any difference between them. The client uses the first available path. On disconnection this procedure starts again from the beginning.

TLS configuration

The CS 104 standard can also be used with TLS to realize secure and authenticated connections.

3 parameters are needed to set up the TLS secured connection:

private key file
server certificate
root certificate (CA)

Fledge's certificate store allows certificates to be stored and used by the south plugins.

Code Block

language	js

{
  "tls_conf:": {
    "private_key": "server-key.pem",
    "server_cert": "server.cer",
    "ca_cert": "root.cer"
  }
}

IEC 104 north plugin (server/slave)

IEC 104 redundancy server modes

Multiple redundancy groups

The MZ Automation lib60870 server provides 3 different modes regarding the support of redundant connections and events queue handling:

The default mode (CS104_MODE_SINGLE_REDUNDANCY_GROUP) allows only a single active client connection.
The second mode (CS104_MODE_CONNECTION_IS_REDUNDANCY_GROUP) allows multiple active client connections.
The third mode (CS104_MODE_MULTIPLE_REDUNDANCY_GROUPS) allows multiple active client connections while preserving events when no client is connected.

In the case of this design, the south plugin will be implemented with CS104_MODE_MULTIPLE_REDUNDANCY_GROUPS server mode.

This mode allows multiple active client connections while preserving events when no client is connected. In this mode clients can be assigned to specific redundancy groups. The assignment is based on the IP address of the client. A redundancy group can have multiple simultaneous connections but only one of these connections can be active. The number of activated connections is restricted by the number of redundancy groups. Each redundancy group has a dedicated event queue.

It can be set with the CS104_Slave_setServerMode function:

Code Block

language	cpp

CS104_Slave_setServerMode(slave, CS104_MODE_MULTIPLE_REDUNDANCY_GROUPS);

Multiple redundancy groups example

draw.io Diagram

border	true
diagramName	fp_multi_redundancy_groups
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	601
revision	3

In this example, 2 control centers, center A and B, are establishing communication with the server.

Both centers have an active and a stand-by gateway for failover management.

Center A has two simultaneous connections, one active and one stand-by, assigned to redundancy group 1.

Center B has only one active connection, assigned to redundancy group 2.

IEC 104 Protocol stack configuration

The IEC 104 protocol stack configuration specifies communication parameters and is a collection of entries containing information about OSI Transport and OSI Application layers objects.

Each entry is comprised of attributes that describe the object. All the configuration data are structured using JSON.

Each entry shall be mapped with the corresponding configuration function in the chosen implementation protocol library.

Attributes definition

...

maximum ASDU size in transmission direction, if set to "0" => maximum possible value is automatically used.

...

ignore, process, default = ignore

ignore: the time stamp quality 'not synchronized' will be ignored and the time stamp will be processed on regular basis. IV-bit will remain 0

process: the time stamp will be send with IV-bit set to 1

...

Configuration JSON structure

Code Block

language	js

{
   "protocol_stack":{
      "name":"iec104server",
      "version":"1.0",
      "transport_layer":{
         "bind_on_ip":false,
         "srv_ip":"0.0.0.0",
         "port":2404,
         "tls":false,
         "k_value":12,
         "w_value":8,
         "t0_timeout":10,
         "t1_timeout":15,
         "t2_timeout":10,
         "t3_timeout":20
      },
      "application_layer":{
         "orig_addr":"0",{
         "ca_asdu_size":2,
         "ioaddr_sizename":3"tase2",
         "asdu_size":0,
         "time_syncaddress":false,
         "comm_exec_timeout":20000,
 "S_114562",
        "comm_recv_timeout":5000,
          "tsivtypeid":"IGNOREData_RealQ",
          "reset":false     },
         "filter_orig":false,      {
         "filter_list":[
         "name":"opcua",
   {
               "orig_addraddress":1"ID99876",
            },      "typeid":"opcua_mvf"
            {
   },
            "orig_addr":2
   {
         }
         ]"name":"iec61850",
      }
   }
}

IEC 104 datapoint representation

This is the Datapoint representation of an IEC 104 ASDU for a command.

Code Block

language	js

{
   "command_object":{
      "co_typeaddress":"type_idsimpleIOGenericIO/GGIO1.AnIn1",
      "co_ca":"ca",
      "co_oa":"oa",
      "co_cottypeid":"cotMV",
      "co_test":"istest",
         "co_negative":"isnegative",}
      "co_ioa":"ioa",
      "co_value":"value",]
      "co_qu":"pulse",
   }
    "co_se":"Select/Execute",
	  "co_ts":"time_marker"  ]
   }
}

Warning
Do not use the name "IEC104Command" as a datapoint name in the exchanged data configuration. Doing so could potentially lead to conflicts when trying to read readings from both the South and Dispatcher components.

Page tree

Versions Compared

Old Version 95

New Version Current

Key

Pivot object model

PIVOT TM model, representation of a tele measurement

Example of a pivot model instance representing a Tele Measurement:

PIVOT TS model, representation of a tele signal

Example of a pivot model instance representing a Tele Signal:

PIVOT TC model, representation of a tele command

Example of a pivot model instance representing a Tele Command:

Protocol translation process

Protocol translation configuration

Exchanged data configuration

Attributes definition

Configuration JSON structure

IEC 104 south plugin (client/master)

IEC 104 Protocol stack configuration

Attributes definition

Protocol translation process

Exchanged data configuration

Attributes definition

Configuration JSON structure

Configuration JSON structure

IEC 104 datapoint representation

Path exploration

TLS configuration

IEC 104 north plugin (server/slave)

IEC 104 redundancy server modes

Multiple redundancy groups

Multiple redundancy groups example

IEC 104 Protocol stack configuration

Attributes definition

Configuration JSON structure

IEC 104 datapoint representation

Page tree

Page History

Versions Compared

Old Version 95

New Version Current

Key

Pivot object model

PIVOT TM model, representation of a tele measurement

Example of a pivot model instance representing a Tele Measurement:

PIVOT TS model, representation of a tele signal

Example of a pivot model instance representing a Tele Signal:

PIVOT TC model, representation of a tele command

Example of a pivot model instance representing a Tele Command:

Protocol translation process

Protocol translation configuration

Exchanged data configuration

Attributes definition

Configuration JSON structure

IEC 104 south plugin (client/master)

IEC 104 Protocol stack configuration

Attributes definition

Protocol translation process

Exchanged data configuration

Attributes definition

Configuration JSON structure

Configuration JSON structure

IEC 104 datapoint representation

Path exploration

TLS configuration

IEC 104 north plugin (server/slave)

IEC 104 redundancy server modes

Multiple redundancy groups

Multiple redundancy groups example

IEC 104 Protocol stack configuration

Attributes definition

Configuration JSON structure

IEC 104 datapoint representation