...
- 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
| 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 | Yes | |
| datapoints.pivot_id | unique identifier of the datapoint, this is used to create a pivot object | Yes | |
| datapoints.pivot_type | type of Common Data Class (CDC), this is used to create a pivot object | SpsTyp, DpsTyp, MvTyp, SpcTyp, DpcTyp, etc... | Yes |
| datapoints.protocols | array of protocols that needs to be managed for a datapoint | Yes | |
| datapoint.protocols.name | name of the protocol | iec104, tase2, hnz, 61850, opcua, etc... | Yes |
| datapoint.protocols.address | address of the datapoint in the given protocol | Yes | |
| datapoint.protocols.typeid | type id of the datapoint in the given protocol | Yes |
Configuration JSON structure
| Code Block | ||
|---|---|---|
| ||
{
"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"
}
]
}
]
}
} |
...
Each entry shall be mapped with the corresponding configuration function in the chosen implementation protocol library.
Attributes definition
| Attribute | Description | Expected values | Mandatory |
|---|---|---|---|
| name | this identifies the protocol stack | iec104client, iec104server, tase2client, tase2server, 61850client, 61850server, etc... | Yes |
| version | version number of the configuration file | 2 digits x.y => x = major change, y = minor change | Yes |
| connection.path | array of connection paths | ||
| connection.path.srv_ip | IP address to remote IEC 104 server | IP address | Yes |
| connection.path.clt_ip | client IP in case of multiple network interfaces server access | IP address, machine's default IP for a given interface | No |
| connection.path.port | port number to remote IEC 104 server | default = 2404 | No |
| tls | activation of TLS (see tls configuration chapter for details) | TRUE, FALSE, default = FALSE | No |
| k_value | Maximum number of outstanding (unacknowledged) APDU's at a given time | default = 12 | No |
| w_value | Acknowledge the reception latest after this number of APDU's | default = 8 | No |
| t0_timeout | time out of connection establishment | default = 10 | No |
| t1_timeout | time out for send or test APDU's | default = 15 | No |
| t2_timeout | time out for acknowledges in case of no data messages (t2 < t1) | default = 10 | No |
| t3_timeout | time out for sending test frames | default = 20 | No |
| conn_all | establish all paths within one connection at the same time (=TRUE) or only one (=FALSE) | TRUE, FALSE, default = FALSE | No |
| start_all | start communication on all established paths at the same time (=TRUE) or on only one (=FALSE) | TRUE, FALSE, default = FALSE | No |
| conn_passv | establish connection even in passive mode (=TRUE) or not (=FALSE) | TRUE, FALSE, default = FALSE | No |
| orig_addr | Originator Address | default = 0 | No |
| ca_asdu_size | size of "Common Address of ASDU" | default = 2 (byte) | No |
| ioaddr_size | size of 'Information Object Address' | default = 3 (byte) | No |
| startup_time | time to wait for startup completion | default = 180 (seconds) | No |
| asdu_size | maximum ASDU size in transmission direction, if set to "0" => maximum possible value is automatically used. | default = 0 (byte) | No |
| gi_time | time to wait for General Interrogation (GI) completion | default = 0 (seconds) | No |
| gi_cycle | send General Interrogation (GI) cyclically | TRUE, FALSE, default = FALSE | No |
| gi_all_ca | send a separate GI request to every CA; otherwise a broadcast GI request is used | TRUE, FALSE, default = FALSE | No |
| gi_repeat_count | repeat GI for this number of times in case it is incomplete | default = 2 | No |
| disc_qual | information object quality in case of interrupted connection | IV = Invalid, NT = Not Topical, default = NT | No |
| send_iv_time | time delay before infos are sent as invalid (0 = deactivated) | default = 0 | No |
| tsiv | specifies what to do with a time stamp marked as 'invalid' | 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' | No |
| utc_time | UTC timezone (=TRUE) or local timezone (=FALSE) for time conversion | TRUE, FALSE, default = FALSE | No |
| comm_wttag | use commands with time tag (=TRUE) or without time tag (=FALSE) | TRUE, FALSE, default = FALSE | No |
| comm_parallel | maximum number of commands to be executed at in parallel (0 = unlimited) | default = 0 | No |
| exec_cycl_test | execute cyclical test requests (C_TS_NA_1/C_TS_TA_1) in monitoring direction (=TRUE) or not (=FALSE) | TRUE, FALSE, default = FALSE | No |
| startup_state | startup in active mode (=TRUE) or in passive mode (=FALSE) | TRUE, FALSE, default = TRUE | No |
| reverse | allow transmission of information objects in reverse direction (=TRUE) or only in standard direction (=FALSE) | TRUE, FALSE, default = FALSE | No |
| time_sync | perform time synchronization (=TRUE) | TRUE, FALSE, default = FALSE | No |
Configuration JSON
...
structure
| Code Block | ||
|---|---|---|
| ||
{
"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
}
}
} |
...
Each entry shall be mapped with the corresponding configuration function in the chosen implementation protocol library.
Attributes definition
| Attribute | Description | Expected values | Mandatory |
|---|---|---|---|
| name | this identifies the protocol stack | iec104client, iec104server, tase2client, tase2server, 61850client, 61850server, etc... | Yes |
| version | version number of the configuration file | 2 digits x.y => x = major change, y = minor change | Yes |
| bind_on_ip | bind on a dedicated local IP address | TRUE, FALSE, default = FALSE | No |
| srv_ip | Server IP address | IP address, machine's default IP for a given interface | No |
| port | This defines the TCP/IP port to be used by the server. | default = 2404 | No |
| tls | activation of TLS (see tls configuration chapter for details) | TRUE, FALSE, default = FALSE | No |
| k_value | Maximum number of outstanding (unacknowledged) APDU's at a given time | default = 12 | No |
| w_value | Acknowledge the reception latest after this number of APDU's | default = 8 | No |
| t0_timeout | time out of connection establishment | default = 10 | No |
| t1_timeout | time out for send or test APDU's | default = 15 | No |
| t2_timeout | time out for acknowledges in case of no data messages (t2 < t1) | default = 10 | No |
| t3_timeout | time out for sending test frames | default = 20 | No |
| orig_addr | Originator Address | default = 0 | No |
| ca_asdu_size | size of "Common Address of ASDU" | default = 2 (byte) | No |
| ioaddr_size | size of 'Information Object Address' | default = 3 (byte) | No |
| asdu_size | maximum ASDU size in transmission direction, if set to "0" => maximum possible value is automatically used. | default = 0 (byte) | No |
| time_sync | If set on "TRUE" this parameter allows to synchronize the clock of the local computer by the server. If set on "FALSE", the clock is not synchronized. | TRUE, FALSE, default = FALSE | No |
| comm_exec_timeout | Defines the command execution monitoring timeout in milliseconds. The default setting is 20 seconds. | default = 20 seconds (20 000 ms) | No |
| comm_recv_timeout | This parameter defines the highest allowable deviation of received command time tag and local clock. If the difference is too big, command is ignored. | default = 0 (disabled) | No |
| tsiv | specifies what to do with a time stamp marked as 'invalid' | 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 | No |
| reset | reset/restart the system on C_RP_NA_1 ASDU (=TRUE) or not (=FALSE) | TRUE, FALSE, default = FALSE | No |
| filter_orig | accept commands only originated from an authorized originator (=TRUE) or accept all originators (=FALSE) | TRUE, FALSE, default = FALSE | |
| filter_list | List of Authorized Originators | No |
Configuration JSON
...
structure
| Code Block | ||
|---|---|---|
| ||
{
"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_size":3,
"asdu_size":0,
"time_sync":false,
"comm_exec_timeout":20000,
"comm_recv_timeout":5000,
"tsiv":"IGNORE",
"reset":false,
"filter_orig":false,
"filter_list":[
{
"orig_addr":1
},
{
"orig_addr":2
}
]
}
}
} |
...