...
The pivot object model is based on 61850 semantic.
PIVOTTM PIVOT TM model, representation of a tele measurement
Attribute | Description | Expected values | Mandatory | ||
---|---|---|---|---|---|
PIVOTTMPIVOT.GTIM.Beh.stVal | ? | ||||
PIVOTTMPIVOT.GTIM.Cause.stVal | Cause of transmission | COT Cause of Transmission - FledgePower - LF Energy | Yes | ||
PIVOTTMPIVOT.GTIM.ChgValCnt.stVal | ? | ||||
PIVOTTMPIVOT.GTIM.ComingFrom | Source protocol name | IEC103, IEC104, TASE.2, OPCUA, 61850, etc... | Yes | ||
PIVOTTMPIVOT.GTIM.Confirmation.stVal | ? | Indicates positive or negative confirmation of activation | true, false, DEFAULT=false | ||
PIVOTPIVOTTM.GTIM.Identifier | Unique identifier of the pivot object | Any non-empty string | Yes | ||
PIVOTTMPIVOT.GTIM.{CDC} | Common Data Class representing the information object | MVTyp | Yes | ||
PIVOTTMPIVOT.GTIM.NormalSrc.stVal | ? | ||||
PIVOTTMPIVOT.GTIM.NormalVal.stVal | ? | ||||
PIVOTTMPIVOT.GTIM.TmOrg.stVal | Timestamp origin, genuine = source otherwise substituted | genuine, substituted, DEFAULT = genuine | Yes | ||
PIVOTTMPIVOT.GTIM.TmValidity.stVal | Timestamp validity | valid, invalid, DEFAULT = valid | Yes |
...
Code Block | ||
---|---|---|
| ||
{ "@xmlns:xs": "http://www.w3.org/2001/XMLSchema", "PIVOTTMPIVOT": { "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, "test": true }, "t": { "FractionOfSecond": 1, "SecondSinceEpoch": 1, "TimeQuality": { "clockFailure": true, "clockNotSynchronized": true, "leapSecondKnown": true, "timeAccuracy": 1 } } }, "NormalSrc": { "stVal": "TELEMETERED" }, "NormalVal": { "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": "String", "t": { "FractionOfSecond": 1, "SecondSinceEpoch": 1, "TimeQuality": { "clockFailure": true, "clockNotSynchronized": true, "leapSecondKnown": true, "timeAccuracy": 1 } } }, "TmOrg": { "stVal": "genuine" }, "TmValidity": { "stVal": "VALID" } } } } |
Example of a pivot model instance representing a Tele Signal:
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 | 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 | ||
---|---|---|
| ||
{
"@xmlns:xs": "http://www.w3.org/2001/XMLSchema",
"PIVOT": {
"GTIS": {
"Beh": {
"stVal": "on"
},
"Cause": {
"stVal": 1
},
"ChgValCnt": {
"stVal": 1
},
"ComingFrom": "String",
"Confirmation": {
"stVal": true
},
"DpsTyp": {
"q": {
"DetailQuality": { | ||
Code Block | ||
| ||
{ "@xmlns:xs": "http://www.w3.org/2001/XMLSchema", "PIVOTTS": { "GTIS": { "Beh": { "stVal": "on" }, "Cause": { "stVal": 1 }, "ChgValCnt": { "stVal": 1 }, "ComingFrom": "String", "Confirmation": { "stVal": true }, "DpsTyp": { "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": { "clockFailure": true, "clockNotSynchronizedbadReference": true, "leapSecondKnownfailure": true, "timeAccuracyinconsistent": 1true, }"innacurate": true, } }"oldData": true, "Identifieroscillatory": "String"true, "NormalSrcoutOfRange": {true, "stValoverflow": "TELEMETERED"true }, "NormalValSource": {"process", "stValValidity": "NORMALgood", }, "OriginoperatorBlocked": {true, "qtest": {true }, "DetailQualitystVal": { "intermediate-state", "badReferencet": true,{ "failureFractionOfSecond": true1, "inconsistentSecondSinceEpoch": true1, "innacurateTimeQuality": true,{ "oldDataclockFailure": true, "oscillatoryclockNotSynchronized": true, "outOfRangeleapSecondKnown": true, "overflowtimeAccuracy": true1 } }, }, "SourceIdentifier": "processString", "NormalSrc": { "ValiditystVal": "goodTELEMETERED", }, "operatorBlockedNormalVal": true,{ "teststVal": true"NORMAL" }, "stValOrigin": "String",{ "tq": { "FractionOfSecondDetailQuality": 1,{ "SecondSinceEpochbadReference": 1true, "TimeQualityfailure": {true, "clockFailureinconsistent": true, "clockNotSynchronizedinnacurate": true, "leapSecondKnownoldData": true, "timeAccuracyoscillatory": 1true, } "outOfRange": true, } "overflow": true }, "SpsTypSource": {"process", "qValidity": {"good", "DetailQualityoperatorBlocked": {true, "badReferencetest": true, }, "failurestVal": true"String", "inconsistentt": true,{ "innacurateFractionOfSecond": true1, "oldDataSecondSinceEpoch": true1, "oscillatoryTimeQuality": true,{ "outOfRangeclockFailure": true, "overflowclockNotSynchronized": true, }"leapSecondKnown": true, "SourcetimeAccuracy": "process",1 "Validity": "good", } } "operatorBlocked": true}, "testSpsTyp": true },{ "stValq": true,{ "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 }, } } } |
Example of a pivot model instance representing a Tele Command:
Code Block | ||
---|---|---|
| ||
{ "@xmlns:xs": "http://www.w3.org/2001/XMLSchema", "PIVOTTC "stVal": true, "t": { "GTICFractionOfSecond": {1, "BehSecondSinceEpoch": {1, "stValTimeQuality": "on"{ }, "CauseclockFailure": {true, "stValclockNotSynchronized": 1true, }, "ComingFromleapSecondKnown": "String"true, "DevIdtimeAccuracy": {1 "name": "String"} }, "DevSt": { }, "qTmOrg": { "DetailQualitystVal": {"genuine" }, "badReferenceTmValidity": true,{ "failurestVal": true, "inconsistent": 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 | 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 | 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 | ||
---|---|---|
| ||
{ "@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 "innacurate": true, "oldData": true, "oscillatory": true, "outOfRange": true, "overflow": true }, "Source": "process", "Validity": "good", "operatorBlocked": true, "test": 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": { "FractionOfSecondbadReference": 1true, "SecondSinceEpochfailure": 1true, "TimeQualityinconsistent": {true, "clockFailureinnacurate": true, "clockNotSynchronizedoldData": true, "leapSecondKnownoscillatory": true, "timeAccuracyoutOfRange": 1true, } "overflow": true }, }, "IdentifierSource": "Stringprocess", "QuValidity": { "stVal": 1"good", }, "ServiceTypeoperatorBlocked": {true, "stValtest": "select"true }, "SpcTyp": { "ctlValstVal": true, "qt": { "DetailQualityFractionOfSecond": {1, "badReferenceSecondSinceEpoch": true1, "failureTimeQuality": true,{ "inconsistentclockFailure": true, "innacurateclockNotSynchronized": true, "oldDataleapSecondKnown": true, "oscillatorytimeAccuracy": true,1 "outOfRange": true, } } "overflow": true }}, "SourceDpcTyp": "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", }, "TagValidity": {"good", "stValoperatorBlocked": "NO-TAG" true, }, "TagClasstest": {true }, "qstVal": { "intermediate-state", "DetailQualityt": { "badReferenceFractionOfSecond": true1, "failureSecondSinceEpoch": true1, "inconsistentTimeQuality": true,{ "innacurateclockFailure": true, "oldDataclockNotSynchronized": true, "oscillatoryleapSecondKnown": true, "outOfRangetimeAccuracy": true,1 } "overflow": true } }, "SourceIdentifier": "processString", "ValidityQu": "good", { "stVal": 1 }, "operatorBlockedServiceType": true,{ "teststVal": true"select" }, "SpcTyp": { "stValctlVal": true, "tq": { "FractionOfSecondDetailQuality": 1,{ "SecondSinceEpochbadReference": 1true, "TimeQualityfailure": {true, "clockFailureinconsistent": true, "clockNotSynchronizedinnacurate": true, "leapSecondKnownoldData": true, "timeAccuracyoscillatory": 1true, } "outOfRange": true, } "overflow": true }, "TaggedReasonSource": "Stringprocess", "TmOrgValidity": {"good", "stValoperatorBlocked": "genuine"true, }, "TmStamptest": {true }, "qstVal": {true, "DetailQualityt": { "badReferenceFractionOfSecond": true1, "failureSecondSinceEpoch": true1, "inconsistentTimeQuality": true,{ "innacurateclockFailure": true, "oldDataclockNotSynchronized": true, "oscillatoryleapSecondKnown": true, "outOfRangetimeAccuracy": true,1 } "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", "FractionOfSecondValidity": 1"good", "SecondSinceEpochoperatorBlocked": 1true, "TimeQualitytest": {true }, "clockFailurestVal": true, "clockNotSynchronizedt": true,{ ""FractionOfSecond": 1, "SecondSinceEpoch": 1, "TimeQuality": { "clockFailure": true, "clockNotSynchronized": true, "leapSecondKnown": true, "timeAccuracy": 1 } } }, } } } |
Protocol translation process
...
Protocol translation configuration
Code Block | ||
---|---|---|
| ||
{
"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
...
"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 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 | ||
---|---|---|
| ||
{
"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"
}
]
}, |
Configuration JSON structure
Code Block | ||
---|---|---|
| ||
{ "exchanged_data":{ "name":"SAMPLE", "version":"1.0", "datapoints":[ { "label":"TS1TM1", "pivot_id":"ID114562ID99876", "pivot_type":"SpsTypMVTyp", "protocolstfid":[ "square_root", "params":[ { 2.0, "name":"iec104", 49.5 "address":"45-672"], "deadband":[ "typeid":"M_SP_TB_1", -0.02, "gi_groups":"station" 0.02 }], {"protocols":[ "name":"tase2",{ "addressname":"S_114562iec104", "typeidaddress":"Data_StateQTimeTagExtended45-984", "gi_groupstypeid":"stationM_ME_NA_1" }, ] }, { { "labelname":"TM1tase2", "pivot_idaddress":"ID99876S_114562", "pivot_typetypeid":"DpsTypData_RealQ", "protocols":[ }, { "name":"iec104opcua", "address":"45-984ID99876", "typeid":"M_ME_NA_1opcua_mvf" }, { "name":"tase2iec61850", "address":"S_114562simpleIOGenericIO/GGIO1.AnIn1", "typeid":"Data_RealQMV" } ] } ] } } |
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. |