...
| 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 |
| connections | array of connections | Yes | |
| connections.srv_ip | IP address to remote HNZ server | IP address | Yes |
| connections.port | port number to remote HNZ server | default = 6001 | No |
| remote_station_addr | remote server station address | 6 bits | Yes |
| Inacc_timeout | timeout before declaring the remote server unreachable (DF.GLOB.TS) | default = 180 (seconds) | No |
| max_sarm | max number of SARM messages before handing over to the passive path (A/B) | default = 30 | No |
| repeat_path_A | max number of authorized repeats for path A | default = 3 | No |
| repeat_path_B | max number of authorized repeats for path B | default = 3 | No |
| repeat_timeout | time allowed for the receiver to acknowledge a frame, after this time, the sender repeats the frame. | default = 3000 | No |
| anticipation_ratio | number of frames allowed to be received without acknowledgement | default = 3 | No |
| test_msg_send | test message code in sending direction | default = 1304 | No |
| test_msg_receive | test message code in receiving direction | default = 1304 | No |
| gi_schedule | scheduled time for General Interrogation sending | default = 99:99 (disabled) | No |
| gi_repeat_count | repeat GI for this number of times in case it is incomplete | default = 3 | No |
| gi_time | time to wait for General Interrogation (GI) completion | default = 255 (seconds) | No |
| c_ack_time | time to wait before receving a acknowledgement for a control command | default = 10 (seconds) | No |
cmd_recv_timeout | time to wait for bytes when receiving data from the HNZ device | default = 100000 (microseconds) | No |
| south_monitoring.asset | asset name used to send the connection and gi status information to the north | default = "CONNECTION-1" | No |
Configuration JSON structure
| Code Block | ||
|---|---|---|
| ||
{
"protocol_stack":{
"name":"hnzclient",
"version":"1.0",
"transport_layer":{
"connections":[
{
"srv_ip":"192.168.0.10",
"port":6001
},
{
"srv_ip":"192.168.0.11",
"port":6002
}
]
},
"application_layer":{
"remote_station_addr":12,
"inacc_timeout":180,
"max_sarm":30,
"repeat_path_A":3,
"repeat_path_B":3,
"repeat_timeout":3000,
"anticipation_ratio":3,
"test_msg_send":"1304",
"test_msg_receive":"1304",
"gi_schedule":"99:99",
"gi_repeat_count":3,
"gi_time":255,
"c_ack_time":10,
"cmd_recv_timeout":100000
},
"south_monitoring":{
"asset":"CONNECTION-1"
}
}
} |
HNZ datapoint representation
...
NB: if an attribute is not required, then it is not put in the output data object, which means that the output object structure always fits the protocol model object type.
HNZ south event representation
South events are special messages used to communicate information about the state of the connection and GI requests between south and north plugins.
Their behivior and structure is defined here.
Path exploration
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.