3.2.28. Indicator Command Class, version 4

3.2.28.1. Compatibility Considerations

The Indicator Command Class, version 4 is backwards compatible with the Indicator Command Class, version 3. All commands and fields not mentioned in this version MUST remain unchanged from the Indicator Command Class, version 3.

This version introduces 2 new commands used to request the detailed information, appearance and use of manufacturer defined Indicator IDs.

  • Indicator Description Get Command

  • Indicator Description Report Command

Supporting nodes supporting Indicator IDs in the range 0x80..0x9F (manufacturer defined indicators) MUST have a description available that can be requested via the version 4 commands.

Indicator IDs in the range 0x80..0x9F that are supported by a node MUST NOT replace or be achievable by any combination of Indicator IDs defined in [25].

3.2.28.2. Indicator Description Get Command

This command is used to request a detailed description of the appearance and use of an Indicator ID

The Indicator Description Report Command MUST be returned in response to this command.

This command MUST NOT be issued via multicast addressing.

A receiving node MUST NOT return a response if this command is received via multicast addressing. The Z-Wave Multicast frame, the broadcast NodeID and the Multi Channel multi-End Point destination are all considered multicast addressing methods.

Table 3.114 Indicator Description Get Command, version 4

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_INDICATOR (0x87)

Command = INDICATOR_DESCRIPTION_GET (0x06)

Indicator ID

Indicator ID (8 bits)

This field is used to specify the actual indicator resource.

A supporting node MUST return a report for the Indicator ID value specified in this field.

This field MUST be in the range 0x80..0x9F.

A supporting node receiving this command for an Indicator ID outside the 0x80..0x9F range MUST return an Indicator Description Report with the Description Length set to 0.

3.2.28.3. Indicator Description Report Command

This command is used to advertise appearance and use of an indicator ID resource.

Table 3.115 Indicator Description Report Command, version 4

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_INDICATOR (0x87)

Command = INDICATOR_DESCRIPTION_REPORT (0x07)

Indicator ID 1

Description Length

Description 1

…

Description N

Indicator ID (8 bits)

This field is used to specify the actual indicator resource for which the description is being advertised.

Description Length (1 byte)

This field indicates the length in bytes of the Description field.

The value 0 MUST indicate that no description is available for the Indicator ID.

Description (N bytes)

This field is used to advertise the appearance and use of the Indicator ID.

It MUST replace the “Appearance and use” column information from [25] for manufacturer defined Indicator IDs.

The length of this field in bytes MUST comply with the advertised value in the Description Length field.

This field MUST be omitted if the Description Length field is set to 0.

This field MUST be encoded in UTF-8 format.