5.2.13. Z/IP Command Class, version 5

5.2.13.1. Compatibility considerations

Z/IP Packet Command Class, version 5 is backwards compatible with the Z/IP Packet Command Class, version 4.

A device supporting Z/IP Packet Command Class, version 5 MUST support Z/IP Packet Command Class, version 4.

All fields and commands not described in this version MUST remain unchanged from version 4.

5.2.13.2. List of defined Z/IP Packet Options

The list of defined Z/IP Packet Option Types is listed in Table 5.166 and each type is defined in the following subsections.

\requirement{CC:0023.00.02.11.001}{0}

A sending node using a given option MUST support as a minimum the version indicated in Table 5.166 for the Z/IP Command Class.

Table 5.162 Z/IP Packet Option types

Option Type

Type value

Class

Version

Expected delay

1

Elective

2

Installation and Maintenance Get

2

Elective

2

Installation and Maintenance Report

3

Elective

2

Encapsulation Format Information

4

Critical

3

Z-Wave Multicast Addressing

5

Elective

4

\requirement{CC:0023.00.02.11.002}{0}

All other values are reserved and MUST NOT be used by a sending node. Reserved values MUST be ignored by a receiving node.

\requirement{CC:0023.00.02.11.003}{0}

A receiving node MUST accept supported options in any order.

5.2.13.2.1. Expected Delay Option

This option is used to advertise an expected delay when issuing a Z/IP Packet command with ”NAck+Waiting” indication.

Table 5.163 Expected Delay Option

7

6

5

4

3

2

1

0

Critical = 0

Option Type = ZIP_OPTION_EXPECTED_DELAY = 1

Option Length = 3

Seconds 1 (MSB)

Seconds 2

Seconds 3 (LSB)

Critical (1 bit)

\requirement{CC:0023.00.02.11.004}{0}

The Critical field MUST be set to 0.

Option Type (7 bits)

\requirement{CC:0023.00.02.11.005}{0}

The Option Type field MUST be set to 0x01 to indicate the Expected Delay Option.

Option Length (8 bits)

\requirement{CC:0023.00.02.11.006}{0}

The Option Length field MUST indicate the length of the Seconds field.

Seconds (24 bits)

\requirement{CC:0023.00.02.11.007}{0}

The Seconds field MUST indicate the expected time in seconds before issuing a new Z/IP Packet Command with a new status.

5.2.13.2.2. Installation and Maintenance Get Option

This option is used to request a receiving node to return a Z/IP Packet Command containing the Installation and maintenance Report Option.

\requirement{CC:0023.00.02.11.008}{0}

In order to trigger an Installation and Maintenance Report to be returned, a sending node MUST:

  • Add this Option in the Z/IP Packet Command

  • Add a Z-Wave Command in the Z/IP Packet Command (NOP Command Class MAY be used if the sending node does not have any other Z-Wave Command to transmit)

  • Set the Ack Request flag to 1 in the Z/IP Packet Command

\requirement{CC:0023.00.02.11.009}{0}

A receiving node MUST:

  • Return a Z/IP Packet Command containing the Installation and Maintenance Report Z/IP Option after the transmission of the contained Z-Wave Command to the destination.

  • If returned, the Installation and Maintenance Report Z/IP Option MUST advertise the statistics associated to the Z-Wave Command transmission.

\requirement{CC:0023.00.02.13.001}{0}

A receiving MAY ignore the request for an Installation and Maintenance Report if it does not support this Option.

Table 5.164 Installation and Maintenance Get Option

7

6

5

4

3

2

1

0

Critical = 0

Option Type = INSTALLATION_MAINTENANCE_GET = 2

Option Length = 0

5.2.13.2.3. Installation and Maintenance Report Option

This option is used to advertise Z-Wave transmission data about the communication between the Z/IP Gateway and a Z-Wave device in the network.

The Installation and Maintenance Report Option is used for data relating to the transmission of an actual frame. Statistical data may be accessed via the Network Management Installation and Maintenance Command Class.

Table 5.165 Installation and Maintenance Report Option

7

6

5

4

3

2

1

0

Critical = 0

Option Type = INSTALLATION_MAINTENANCE_REPORT = 3

Option Length

IME - Type 1

IME - Length 1

IME - Value 1, 1

…

IME - Value L, 1

…

IME - Type N

IME - Length N

IME - Value 1, N

…

IME - Value L, N

Critical (1 bit)

\requirement{CC:0023.00.02.11.00A}{0}

The Critical field MUST be set to 0.

Option Length (1 byte)

\requirement{CC:0023.00.02.11.00B}{0}

This field MUST indicate the combined length (in bytes) of the following IME-TLV fields.

IME - Type / Length / Value (TLV) (variable)

\requirement{CC:0023.00.02.11.00C}{0}

This field is used to carry values advertising Z-Wave transmission statistics. Each TLV block MUST be encoded according to one of the Types defined in Table 5.170 and in the following subsections.

\requirement{CC:0023.00.02.11.00D}{0}

A sending node using a given TLV MUST support as a minimum the version indicated in Table 5.170 for the Z/IP Command Class.

\requirement{CC:0023.00.02.13.002}{0}

The Z/IP Gateway MAY send any combination of the IME TLVs when using this Z/IP Packet Option.

Table 5.166 Z/IP Packet::IME-Type/Length/Value encoding

IME - Type

Name

IME - Length

Version

0x00

Route Changed

1 byte

2

0x01

Transmission Time (TT)

2 bytes

2

0x02

Last Working Route (LWR)

5 bytes

2

0x03

Incoming RSSI

5 bytes

4

0x04

ACK channel

1 byte

4

0x05

Transmit channel

1 byte

4

0x06

Routing scheme

1 byte

4

0x07

Routing attempts

1 byte

4

0x08

Last failed link

2 bytes

4

0x09

Tx Power

2 bytes

5

0x0A

Measured Noise Floor

2 bytes

5

0x0B

Outgoing RSSI

5 bytes

5

All other values are reserved and MUST NOT be used by a sending node. Reserved values MUST be ignored by a receiving node.

5.2.13.2.3.1. Route Changed (3 bytes)

Table 5.167 Route Changed

7

6

5

4

3

2

1

0

IME - Type = 0x00

IME - Length = 1

IME - Value = Route Changed

Route Changed (8 bits)

This field is used to indicate if the last working route was changed for the current transmission.

\requirement{CC:0023.00.02.11.00E}{0}

If the last working route was changed, this field MUST be set to 0x01.

If the last working route was not changed, this field MUST be set to 0x00.

5.2.13.2.3.2. Transmission Time (4 bytes)

Table 5.168 Transmission Time

7

6

5

4

3

2

1

0

IME - Type = 0x01

IME - Length = 2

IME - Value = Transmission Time 1 (MSB)

IME - Value = Transmission Time 2 (LSB)

Transmission Time (16 bits)

\requirement{CC:0023.00.02.11.00F}{4}

This field is used to indicate the time it took to send the command until the reception of an Ack. The value MUST be encoded using unsigned representation and MUST be specified using the ms (milliseconds) unit.

5.2.13.2.3.3. Last Working Route (7 bytes)

Table 5.169 Last Working Route

7

6

5

4

3

2

1

0

IME - Type = 0x02

IME - Length = 5

IME - Value = Repeater 1

IME - Value = Repeater 2

IME - Value = Repeater 3

IME - Value = Repeater 4

IME - Value = Speed

\requirement{CC:0023.00.02.11.010}{4}

This TLV is used to advertise the last used Working Route. If multiple Last Working Routes exist, this MUST be the one used to transmit the frame.

Repeater 1-4 (4 bytes)

This field contains the NodeID of the repeaters used for the last working route.

\requirement{CC:0023.00.02.11.011}{0}

The value 0 MUST indicate that the actual repeater was not used.

Values in the range 1..232 MUST indicate an actual NodeID used as repeater.

\requirement{CC:0023.00.02.11.012}{0}

The first Repeater byte set to 0 MUST indicate that no more repeaters were used for the transmission. If the first Repeater byte is set to 0, it means that the Last Working Route (LWR) is a direct transmission.

Speed (8 bits)

\requirement{CC:0023.00.02.11.013}{0}

This field is used to advertise the transmission speed used to reach the destination node. This field MUST be encoded according to Table 5.170.

Table 5.170 IME Speed Encoding

Value

Protocol

Speed

0x01

Z-Wave

9.6 kbit/sec

0x02

Z-Wave

40 kbit/sec

0x03

Z-Wave

100 kbit/sec

0x04

Z-Wave Long Range

100 kbit/sec

All other values are reserved and MUST NOT be used by a sending node. Reserved values MUST be ignored by a receiving node.

Incoming RSSI (7 bytes)

Table 5.171 Incoming RSSI

7

6

5

4

3

2

1

0

IME - Type = 0x03

IME - Length = 5

IME - Value = RSSI hop 1

IME - Value = RSSI hop 2

IME - Value = RSSI hop 3

IME - Value = RSSI hop 4

IME - Value = RSSI hop 5

The IME - Values advertise the RSSI value measured in the incoming direction (back towards the source of the message).

RSSI Hop (5 bytes)

\requirement{CC:0023.00.02.11.014}{0}

The RSSI values MUST be encoded as using signed representation in the dBm unit and according to Table 5.172.

Table 5.172 RSSI Encoding

Value (signed)

Description

0x7F (127)

RSSI_NOT_AVAILABLE This value is returned for unused hops or if no RSSI measurement is available.

0x7E (126)

RSSI_MAX_POWER_SATURATED This value is returned if the measured RSSI is above the maximum power.

0x7D (125)

RSSI_BELOW_SENSITIVITY This value is returned if the measured RSSI is below the receiver’s sensitivity

0x7E…0xE1 (124..-31)

Reserved

0xE0 (-32)

-32 dBm

0xDF (-33)

-33 dBm

…

…

0x80 (-128)

-128 dBm

5.2.13.2.3.4. ACK channel (3 bytes)

Table 5.173 ACK Channel

7

6

5

4

3

2

1

0

IME - Type = 0x04

IME - Length = 1

IME - Value = ACK channel

ACK channel (8 bits)

This value reports the RF channel on which the ACK for this frame was received.

5.2.13.2.3.5. Transmit channel (3 bytes)

Table 5.174 Transmit Channel

7

6

5

4

3

2

1

0

IME - Type = 0x05

IME - Length = 1

IME - Value = Transmit channel

Transmit channel (8 bits)

This value reports the RF channel on which the Z-Wave Command was transmitted.

5.2.13.2.3.6. Routing scheme (3 bytes)

Table 5.175 Routing Scheme

7

6

5

4

3

2

1

0

IME - Type = 0x06

IME - Length = 1

IME - Value = Routing scheme

Routing scheme (8 bits)

This value reports the routing scheme that was used to find the successful route for delivering the Z-Wave Command.

\requirement{CC:0023.00.02.11.015}{0}

The Routing scheme value MUST encoded according to Table 5.176.

Table 5.176 Routing Scheme IME::Routing Scheme encoding

Value

Description

0x00

Idle

0x01

Direct transmission (no routing)

0x02

Application static route

0x03

Last working route

0x04

Next to last working route

0x05

Return route or controller auto route

0x06

Direct resort

0x07

Explorer frame

All other values are reserved and MUST NOT be used by a sending node. Reserved values MUST be ignored by a receiving node.

5.2.13.2.3.7. Routing attempts (3 bytes)

Table 5.177 Routing Attempts

7

6

5

4

3

2

1

0

IME - Type = 0x07

IME - Length = 1

IME - Value = Routing attempts

Routing attempts (8 bits)

This TLV reports the number of routing attempts that were performed before successfully delivering the Z-Wave Command.

5.2.13.2.3.9. Tx Power (2 bytes)

This TLV is used to report the Tx Power (in dBm) used during the transmissions with the remote node.

Table 5.179 Tx Power

7

6

5

4

3

2

1

0

IME - Type = 0x09

IME - Length = 2

IME - Value = Local Node Tx Power

IME - Value = Remote Node Tx Power

Local Node Tx Power (8 bits)

This field is used to indicate the Tx Power (in dBm) used for the transmission from the local node.

This field MUST be encoded as using signed representation in the dBm unit.

The value 0x7F (127) MUST indicate that the measurement is not available.

All other values MUST represent the actual Tx Power setting, in dBm.

Remote Node Tx Power (8 bits)

This field is used to indicate the Tx Power (in dBm) used by the remote node for the transmission.

This field MUST be encoded as using signed representation in the dBm unit.

The value 0x7F (127) MUST indicate that the measurement is not available.

All other values MUST represent the actual Tx Power setting, in dBm.

5.2.13.2.3.10. Measured Noise Floor (2 bytes)

This TLV is used to report the Measured Noise Floor (in dBm) used during the transmissions with the remote node.

Table 5.180 Measured Noise Floor

7

6

5

4

3

2

1

0

IME - Type = 0x0A

IME - Length = 2

IME - Value = Local Node Measured Noise Floor

IME - Value = Remote Node Measured Noise Floor

Local Node Measured Noise Floor (8 bits)

This field is used to indicate the Measured Noise Floor (in dBm) by the local node during the transmission.

This field MUST be encoded as using signed representation and MUST be encoded according to Table 5.181.

Table 5.181 Noise Floor Encoding

Value (signed)

Description

0x7F (127)

NOT_AVAILABLE. This value is returned for unused hops or if no RSSI measurement is available.

0x7E (126)

MAX_POWER_SATURATED This value is returned if the measured RSSI is above the maximum power.

0x7D (125)

BELOW_SENSITIVITY. This value is returned if the measurement is below the receiver’s sensitivity.

0x7D (125).. 0x80 (-128)

This value represents the measurement in dBm

Remote Node Measured Noise Floor (8 bits)

This field is used to indicate the Measured Noise Floor (in dBm) by the remote node during the transmission.

This field MUST be encoded as using signed representation and MUST be encoded according to Table 5.181.

5.2.13.2.3.11. Outgoing RSSI (7 bytes)

Table 5.182 Outgoing RSSI

7

6

5

4

3

2

1

0

IME - Type = 0x0B

IME - Length = 5

IME - Value = Outgoing RSSI hop 1

IME - Value = Outgoing RSSI hop 2

IME - Value = Outgoing RSSI hop 3

IME - Value = Outgoing RSSI hop 4

IME - Value = Outgoing RSSI hop 5

The IME - Values advertise the RSSI value measured in the outgoing direction (from our local node to the remote node).

Outgoing RSSI Hop (5 bytes)

The RSSI values MUST be encoded as using signed representation in the dBm unit and according to Table 5.172.

5.2.13.2.4. Encapsulation Format Information Option

The Encapsulation Format Information Option is used to carry information about the Z-Wave encapsulations that were or must be used to communicate between the Z-Wave node and the sending host (e.g. a Z/IP Gateway).

The purpose of this Option is to preserve the encapsulation between a Z-Wave node and a host (e.g. Z/IP Gateway).

\requirement{CC:0023.00.02.11.016}{0}

A Z/IP Gateway MUST use the encapsulation indicated in the Encapsulation Format Information Option when transmitting Z/IP Commands over in a Z-Wave Network.

\requirement{CC:0023.00.02.11.017}{0}

A Z/IP Gateway receiving a Z-Wave Command that must be forwarded over an IP network MUST indicate in the Encapsulation Format Information Option what the Z-Wave encapsulation was.

\requirement{CC:0023.00.02.11.018}{0}

If a Z/IP client receives this Option and the Z-Wave Command requires to return a response, the Z/IP client MUST apply the encapsulation indicated by the Option when sending a reply.

\requirement{CC:0023.00.02.13.003}{0}

A Z/IP client MAY use this Option to dictate the encapsulation format when sending unsolicited messages.

Table 5.183 Encapsulation Format Information Option

7

6

5

4

3

2

1

0

Critical = 1

Option Type = ENCAPSULATION_FORMAT_INFO = 4

Option Length = 2

Security 2 Security Class

Reserved

CRC16

Critical (1 bit)

\requirement{CC:0023.00.02.11.019}{0}

This field indicates that the whole frame MUST be discarded if the extension is not supported.

This field MUST be set to 1 when using the Encapsulation Format Info Option.

Option Type (7 bits)

\requirement{CC:0023.00.02.11.01A}{0}

The Type field MUST be set to 4 for the Encapsulation Format Information Option.

Option Length (8 bits)

\requirement{CC:0023.00.02.11.01B}{0}

The Option Length field MUST indicate the length of the Option Data fields, which is currently defined as 2 bytes long.

Security 2 Security Class (1 byte)

\requirement{CC:0023.00.02.11.01C}{0}

This Security 2 Security Class field indicates which Security 2 Security Class MUST be used for communication with the target node.

\requirement{CC:0023.00.02.11.01D}{0}

A receiving node MUST replace previous information about a node’s secure capabilities with the information contained in this field and attempt subsequent communication with the target node using the highest security key contained in this command.

\requirement{CC:0023.00.02.11.01E}{0}

This field MUST be encoded as a bit field and according to Table 5.184.

Table 5.184 Security Class Field Encoding

Bit set to 1

Security 2 - Security Class

None

NON_SECURE

0

S2_UNAUTHENTICATED

1

S2_AUTHENTICATED

2

S2_ACCESS_CONTROL

7

S0

CRC16 (1 bit)

The CRC16 field indicates whether communication with the target node use CRC16 encapsulation or not.

\requirement{CC:0023.00.02.11.01F}{0}

The value 1 MUST indicate that CRC16 encapsulation is used and MUST be used for subsequent communication with the Z-Wave node.

\requirement{CC:0023.00.02.11.020}{0}

The value 0 MUST indicate that CRC16 encapsulation is not used and MUST NOT be used for subsequent communication with the Z-Wave node.

\requirement{CC:0023.00.02.11.021}{0}

The CRC16 field MUST NOT be set to 1 if the Security 2 Security Class field is different than ”NON_SECURE”

5.2.13.2.5. Z-Wave Multicast Addressing Option

This option is used to advertise if Multicast Addressing has been used by the sending node in the Z-Wave network.

\requirement{CC:0023.00.02.12.002}{0}

A Z/IP Client SHOULD NOT use this option when sending a Z/IP Packet Command.

\requirement{CC:0023.00.02.11.022}{0}

A Z/IP Gateway supporting Z/IP Command version 4 or newer MUST use this option in a Z/IP Packet Command if forwarding a command that has been received using Multicast addressing from a Z-Wave node.

The Z-Wave Multicast frame, the broadcast NodeID and the Multi Channel multi-End Point destination are all considered multicast addressing methods.

Table 5.185 Z-Wave Multicast Addressing Option

7

6

5

4

3

2

1

0

Critical = 0

Option Type = ZWAVE_MULTICAST_ADDRESSING = 5

Option Length = 0

Critical (1 bit)

\requirement{CC:0023.00.02.11.023}{0}

The Critical field MUST be set to 0.

Option Type (7 bits)

\requirement{CC:0023.00.02.11.024}{0}

The Option Type field MUST be set to 0x05 to indicate the Z-Wave Multicast Addressing Option.

Option Length (8 bits)

\requirement{CC:0023.00.02.11.025}{0}

The Option Length field MUST indicate the length of the Option Data field.

\requirement{CC:0023.00.02.11.026}{0}

No Option Data is currently defined for this option; this field MUST be set to 0 and the Option Data field MUST be omitted.