Page History

HNZ connexion initialization

When the HNZ south plugin establishes a new connection with a HNZ device, it will automatically send the following messages to the device:

• A set date and a set time: Those two messages will synchronize the date and time of the device with the one from the south plugin machine.
• A CG request: This message will request all TS to be sent by the device in CG format (equivalent of GI request of iec104).

HNZ Protocol stack configuration

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

...

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

The present specification corresponds to the HNZ B1/TR mode working on a TCP/IP connection.

Attributes definition

Configuration JSON structure

{
   "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,
         "local_station_addr":12inacc_timeout":180,
         "max_sarm":30,
         "remoterepeat_addr_in_local_station":0path_A":3,
         "repeat_path_B":3,
         "inaccrepeat_timeout":1803000,
         "maxanticipation_sarmratio":303,
         "totest_msg_socketsend":1"1304",
         "repeattest_pathmsg_Areceive":3"1304",
         "repeat_path_B":3gi_schedule":"99:99",
         "gi_repeat_timeoutcount":30003,
         "anticipationgi_time":3255,
         "defaultc_msgack_periodtime":010,
         "Testcmd_msgrecv_sendtimeout":"1304",100000
      },
      "south_monitoring":{
         "Test_msg_receiveasset":"1304CONNECTION-1"
      }
    }
}

HNZ datapoint representation

This is the Datapoint representation of an HNZ message.

Example for a TS from CE:

{
    "data_object":{
        "do_type":"M_SP_TB_1",
       "do_ca":18325"TS",
        "do_station":12,
        "do_addr":325,
        "do_value":1,
        "do_valid":0,
        "do_cg":0,
        "do_outdated":0, 
        "do_ts":1685019425432,
        "do_ts_oaiv":0,
        "do_cotts_c":30,
        "do_test":false,
_ts_s":0
    }
 }

Example for a TS from CG:

{
    "data_object":{
        "do_type":"TS",
        "do_negativestation":false12,
        "do_ioaaddr":6468178325,
        "do_value":1,
        "do_quality_iv":truevalid":0,
        "do_cg":1,
        "do_outdated":0
    }
 }

Example for a TS quality update:

{
    "data_object":{
        "do_type":"TS",
 _bl":false,
       "do_quality_ov":falsestation":12,
        "do_addr":325,
        "do_quality_sb":falsevalid":0,
        "do_cg":0,
        "do_quality_nt":false,
outdated":1, 
        "do_ts":1685019425432,
        "do_ts_iv":16534843302390,
        "do_ts_ivc":true0,
        "do_ts_su":false_s":0
    }
 }

Example for a TMA:

{
    "data_object":{
        "do_type":"TM",
        "do_station":12,
        "do_addr":71,
        "do_value":-15,
        "do_valid":0,
        "do_an":"TMA",
        "do_outdated":0
    }
}

Example for a TMN 8 bits (TM8):

{
    "data_object":{
        "do_type":"TM",
        "do_station":12,
        "do_addr":71,
        "do_value":42,
        "do_valid":0,
        "do_an":"TM8",
        "do_outdated":0
    }
}

Example for a TMN 16 bits (TM16):

{
    "data_object":{
        "do_type":"TM",
        "do_station":12,
        "do_addr":71,
        "do_value":420,
        "do_valid":0,
        "do_an":"TM16",
        "do_outdated":0
    }
}

Example for a TM quality update:

{
    "data_object":{
        "do_type":"TM",
        "do_station":12,
        "do_addr":71,
        "do_valid":0,
        "do_an":"TMA",
        "do_outdated":1
    }
}

Example for a TC (after receiving ACK):

{
    "data_object":{
        "do_type":"TC",
        "do_station":12,
        "do_addr":71,
        "do_valid":0
     }
 }

Example for a TVC (after receiving ACK):

{
    "data_object":{
        "do_type":"TVC",
        "do_station":12,
        "do_addr":31,
       "do_ts_sub":false
    }
 } "do_valid":0
     }
 }

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 command representation

This is the command representation of an HNZ message.

The processing of FLEDGE commands should evolve. Below is an example of JSON format :

Example for a TC:

{
    "co_type":"TC",
    "co_addr":325,
    "co_value":1
}

Example for a TVC:

{
    "co_type":"TVC",
    "co_addr":31,
    "co_value":42
}

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.