...
When the HNZ south plugin establishes a new connection wit ha with a HNZ device, it will automatically send the following messages to the device:
...
| Attribute | Description | Expected values | Mandatory | ||
|---|---|---|---|---|---|
| do_type | message type | TS, TM, TC, TVC | YES | ||
| do_station | station address | YES | |||
| do_address | message address | YES | |||
| do_value | value | TM (do_an = TMA): [-127..127] TM (do_an = TM8): [0..255] TM (do_an = TM16): [-32768..32767] TMTS: [0..1] TC: [1..2] (01b = offon, 10b = onoff) TVC: [-255..255] | YES except in quality update readings | ||
| do_valid | validity | valid = 0 or invalid = 1 | YES | ||
| do_an | TM type (analogic / numeric) | "TMA", "TM8", "TM16" | TM only | ||
| do_cg | TS source | CG = 1 or CE = 0 | TS only | ||
| do_tsoutdated | Outdated message (after connection loss) | up to date =0, outdated = 1 | TM and TS only | ||
| do_ts | timestamp | epoch timestamp | timestamp | epoch timestamp in milliseconds | TS CE only |
| do_ts_iv | timestamp invalid | valid = 0 or invalid = 1 (from bit HNV) | TS CE only | ||
| do_ts_c | loss of chronology | lost = 0 1 else = 1 0 (from bit CV) | TS CE only | ||
| do_ts_s | ts not synchronized | synchronized = 0 else = 1 (from bit S) | TS CE only | ||
| do_an | TM type (analogic / numeric) | "TMA", "TM8", "TM16" | TM only |
Example for a TS from CE:
| Code Block | ||
|---|---|---|
| ||
{
"data_object":{
"do_type":"TS",
"do_station":12,
"do_addr":325,
"do_value":1,
"do_valid":0,
"do_cg":0,
"do_tsoutdated":16850194254320,
"do_ts":1685019425432,
"do_ts_iv":0,
"do_ts_c":0,
"do_ts_s":0
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"data_object":{
"do_type":"TS",
"do_station":12,
"do_addr":325,
"do_value":1,
"do_valid":0,
"do_cg":1,
"do_outdated":0
}
} |
Example for a TMATS quality update:
| Code Block | ||
|---|---|---|
| ||
{
"data_object":{
"do_type":"TMTS",
"do_station":12,
"do_addressaddr":71325,
"do_valuevalid":-150,
"do_validcg":0,
"do_anoutdated":"TMA"1,
}
} |
Example for a TMN 8 bits (TM8):
| Code Block | ||
|---|---|---|
| ||
{ "data_object":{ "do_ts":1685019425432, "do_typets_iv":"TM"0, "do_stationts_c":120, "do_ts_addresss":71,0 } } |
Example for a TMA:
| Code Block | ||
|---|---|---|
| ||
{ "dodata_valueobject":42,{ "do_validtype":0"TM", "do_anstation":"TM8"12, } } |
Example for a TMN 16 bits (TM16):
| Code Block | ||
|---|---|---|
| ||
{ "data_object":{ "do_addr":71, "do_typevalue":"TM"-15, "do_stationvalid":120, "do_addressan":71, "do_value":420"TMA", "do_validoutdated":0, "do_an":"TM16" } } |
Example for a TC (after receiving ACKTMN 8 bits (TM8):
| Code Block | ||
|---|---|---|
| ||
{
"data_object":{
"do_type":"TCTM",
"do_station":12,
"do_addressaddr":71,
"do_value":142,
"do_valid":0,
"do_an":"TM8",
"do_outdated":0
}
} |
Example for a
...
TMN 16 bits (TM16):
| Code Block | ||
|---|---|---|
| ||
{
"data_object":{
"do_type":"TVCTM",
"do_station":12,
"do_addressaddr":3171,
"do_value":420,
"do_valid":0,
"do_an":"TM16",
"do_outdated":0
}
} |
Example for a TM quality update:
| Code Block | ||
|---|---|---|
| ||
{
"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):
| Code Block | ||
|---|---|---|
| ||
{
"data_object":{
"do_type":"TC",
"do_station":12,
"do_addr":71,
"do_valid":0
}
} |
Example for a TVC (after receiving ACK):
| Code Block | ||
|---|---|---|
| ||
{ "data_object":{ "do_type":"TVC", "do_station":12, "do_addr":3142, "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.
...
| Order | Attribute | Description | Expected values | Mandatory | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | co_type | message type | TC, TVC | YES | 1 | co_address | message address | YES | _type | message type | TC, TVC | YES |
| 1 | co_addr | message address | [0..255][0..7] (ADO + ADB) for a TC, [0..31] for a TVC | YES | ||||||||
| 2 | co_value | value | [1..2] (01b = on, 10b = off) | YES |
The processing of FLEDGE commands should evolve. Below is an example of JSON format :
Example for a TC:
| Code Block | |||
|---|---|---|---|
| |||
{ "command_object":{ "co_type":"TC", "co_addressaddr":325, "co_value":1 } } |
Example for a TVC:
| Code Block | ||
|---|---|---|
| ||
{
"command_object":{
"co_type":"TVC",
"co_addressaddr":31,
"co_value":1
}
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.
...