2.2.34. Configuration Command Class, version 4

The Configuration Command Class, version 4 introduces the support of read-only parameters, parameters requiring network re-inclusion and advanced parameters as well as allows optional support for Bulk Commands.

A read-only parameter can be accessed with Get commands but cannot be modified with Set Commands. A parameter requiring re-inclusion is typically a parameter altering the node capabilities, which requires performing the inclusion again in order to have the controller to learn about the node capabilities once more. A parameter may be advertised as “advanced” to indicate to the controlling application that the actual parameter is intended only for advanced use, e.g. calibration.

The following commands are modified in version 4:

  • Configuration Set Command

  • Configuration Bulk Set Command

  • Configuration Properties Report Command

The following new command is introduced:

  • Configuration Default Reset Command

All commands not mentioned in this version remain unchanged from previous versions.

2.2.34.1. Compatibility considerations

Configuration Command Class, version 4 is backwards compatible with the previous versions of Configuration Command Class.

\requirement{CC:0070.04.00.21.001}{0}

A device supporting Configuration Command Class, version 4 MUST support Configuration Command Class, version 3.

2.2.34.1.1. Multi Channel Consideration

\requirement{CC:0070.04.00.12.001}{0}

Multi Channel End Points SHOULD NOT support the Configuration Command Class.

2.2.34.1.2. “Default” flag

Refer to Section 2.2.31.1.1.

\requirement{CC:0070.04.00.21.002}{0}

From version 4 and onwards, a node MUST NOT reset all Configuration Parameters when receiving a Set or Bulk Set Command with the default flag set to 1.

2.2.34.1.3. Configuration Properties Report

Refer to Section 2.2.33.1.2.

The recommendation given in version 3 does not apply to version 4 supporting nodes as new fields are appended at the end of the Configuration Properties Report Command in version 4.

2.2.34.1.4. “Altering capabilities” flag

\requirement{CC:0070.04.00.21.003}{4}

Configuration parameters modifying a node’s and/or (non-dynamic) Multi Channel End Point capabilities MUST be advertised as “Altering capabilities”.

\requirement{CC:0070.04.00.21.004}{0}

When such a parameter is modified:

  • A Z-Wave or Z-Wave Plus node MUST NOT advertise the new and/or Multi Channel End Point capabilities before being excluded from its current network.

  • A Z-Wave Plus version 2 node MUST advertise its new capabilities immediately.

2.2.34.1.5. “Advanced” flag

The difference between normal and advanced parameters lies on the controlling node side.

\requirement{CC:0070.04.00.23.001}{0}

A parameter MAY be advertised as “advanced” in order to simplify the configuration of a node by normally not showing such a parameter to the end user.

\requirement{CC:0070.04.00.22.001}{0}

Advanced parameters SHOULD be presented to the user only when an [Advanced] option is selected in the controller user interface.

2.2.34.1.6. Parameters value and network inclusion/exclusion

\requirement{CC:0070.04.00.21.005}{0}

From version 4 and onwards, a node MUST NOT modify or reset any configuration parameter when being included or excluded of a Z-Wave network.

\requirement{CC:0070.04.00.21.006}{0}

A node MUST reset all its configuration parameters if either:

  • It is manually reset to factory default

  • It receives a Configuration Default Reset Command.

\requirement{CC:0070.04.00.21.007}{0}

A node MUST NOT reset all its configuration parameters in any other case.

2.2.34.1.7. Bulk commands support

\requirement{CC:0070.04.00.22.002}{0}

A node supporting Configuration Command Class, version 4 MAY elect to ignore the following Commands:

  • Configuration Bulk Set Command

  • Configuration Bulk Get Command

  • Configuration Bulk Report Command

\requirement{CC:0070.04.00.21.008}{0}

If it is the case, the node MUST:

  • Return an Application Rejected Request Command when receiving one of the ignored commands (if received without Supervision encapsulation)

  • Advertise that it ignores the Bulk Commands in the Configuration Properties Report

\requirement{CC:0070.04.00.21.009}{0}

If Bulk Commands are supported, they MUST be supported for all parameters. If Bulk Commands are ignored, they MUST be ignored for all parameters.

2.2.34.2. Configuration Set Command

This command is used to set the value of a configuration parameter.

Table 2.172 Configuration Set Command, version 4

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_CONFIGURATION (0x70)

Command = CONFIGURATION_SET (0x04)

Parameter Number

Default

Reserved

Size

Configuration Value 1

Configuration Value N

\requirement{CC:0070.04.04.11.001}{0}

A receiving node MUST ignore this command if the specified parameter is advertised as a Read-only parameter.

All fields not specified below are unchanged from version 2 Configuration Set Command.

Default (1 bit)

This field is used to specify if the default value is to be restored for the specified configuration parameter.

\requirement{CC:0070.04.04.11.002}{0} \requirement{CC:0070.04.04.11.003}{4}

The value 1 MUST indicate that default factory settings must be restored for the specified Parameter Number. In this case, the Configuration value field MUST be ignored and any other parameters MUST NOT be reset by a receiving node.

\requirement{CC:0070.04.04.11.004}{0}

The value 0 MUST indicate that the specified Parameter Number MUST assume the value specified by the Configuration Value field.

Configuration Value (N bytes)

\requirement{CC:0070.04.04.11.005}{0}

This field carries the value to be assigned. The size of the field MUST comply with the size advertised by the Size field.

\requirement{CC:0070.04.04.11.006}{0}

The configuration value MUST be encoded according to the Format field advertised in the Configuration Properties Report Command for the parameter number.

2.2.34.3. Configuration Bulk Set Command

This command is used to set the value of one or more configuration parameters.

Table 2.173 Configuration Bulk Set Command, version 4

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_CONFIGURATION (0x70)

Command = CONFIGURATION_BULK_SET (0x07)

Parameter Offset 1 (MSB)

Parameter Offset 2 (LSB)

Number of Parameters

Default

Hand- shake

Reserved

Size

Parameter 1 - Configuration Value 1 (MSB)

Parameter 1 - Configuration Value N (LSB)

Parameter M - Configuration Value 1 (MSB)

Parameter M - Configuration Value N (LSB)

\requirement{CC:0070.04.07.11.001}{0}

A receiving node MUST ignore this command for parameters that are advertised as Read-only parameters.

All fields not specified below are unchanged from version 2 Configuration Bulk Set Command.

Default (1 bit)

This field is used to specify if the default value is to be restored for the specified configuration parameters.

\requirement{CC:0070.04.07.11.002}{0} \requirement{CC:0070.04.07.11.003}{8}

The value 1 MUST indicate that default factory settings must be restored for all the Parameter Numbers defined by the Parameter Offset and Number of Parameters fields. In this case, the Configuration Value field MUST be ignored and any other parameters MUST NOT be reset by a receiving node.

\requirement{CC:0070.04.07.11.004}{0}

The value 0 MUST indicate that the specified Parameter Numbers MUST assume the value specified by the Configuration Value field.

Parameter -Configuration Value (M*N bytes)

\requirement{CC:0070.04.07.11.005}{0}

These fields carry the parameter values to be assigned. Each parameter value field MUST have the same size. The size of each field MUST comply with the size advertised by the Size field.

\requirement{CC:0070.04.07.11.006}{0}

The values MUST be encoded according to the Format field advertised in the Configuration Properties Report Command for each parameter number.

2.2.34.4. Configuration Properties Report Command

This command is used to advertise the properties of a configuration parameter.

Table 2.174 Configuration Properties Report Command, version 4

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_CONFIGURATION (0x70)

Command = CONFIGURATION_PROPERTIES_REPORT (0x0F)

Parameter Number 1 (MSB)

Parameter Number 2 (MSB)

Altering capabilities

Read- only

Format

Size

Min Value 1 (MSB)

Min Value N (LSB)

Max Value 1 (MSB)

Max Value N (LSB)

Default Value 1 (MSB)

Default Value N (LSB)

Next Parameter Number 1 (MSB)

Next Parameter Number 2 (LSB)

Reserved

No Bulk support

Advanced

All fields not specified below are unchanged from version 3 Configuration Properties Report Command.

Read-only (1 bit)

This field is used to indicate if the parameter is read-only.

\requirement{CC:0070.04.0F.11.001}{0}

The value 1 MUST indicate that the advertised parameter is read-only.

\requirement{CC:0070.04.0F.11.002}{0}

The value 0 MUST indicate that the advertised parameter is not read-only.

Altering capabilities (1 bit)

This field is used to indicate if the advertised parameter triggers a change in the node’s capabilities.

\requirement{CC:0070.04.0F.11.003}{0}

The value 1 MUST indicate that the advertised parameter alters the node capabilities when being changed.

\requirement{CC:0070.04.0F.11.004}{0}

The value 0 MUST indicate that the advertised parameter does not alter the node capabilities when being changed.

Refer to Section 2.2.34.1.4 “Altering capabilities” flag.

Advanced (1 bit)

This field is used to indicate if the advertised parameter is to be presented in the “Advanced” parameter section in the controller GUI.

\requirement{CC:0070.04.0F.11.005}{0}

The value 1 MUST indicate that the advertised parameter is an Advanced parameter.

\requirement{CC:0070.04.0F.11.006}{0}

The value 0 MUST indicate that the advertised parameter is not an Advanced parameter.

No Bulk support (1 bit)

This field is used to advertise if the sending node supports Bulk Commands.

\requirement{CC:0070.04.0F.11.007}{0}

The value 1 MUST indicate that the Bulk Commands will be ignored by the sending node.

\requirement{CC:0070.04.0F.11.008}{0}

The value 0 MUST indicate that the Bulk Commands are supported by the sending node

\requirement{CC:0070.04.0F.11.009}{0}

A sending node MUST always advertise the same value in this field, regardless of the parameter number.

2.2.34.5. Configuration Default Reset Command

This command is used to reset all configuration parameters to their default value.

Table 2.175 Configuration Default Reset Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_CONFIGURATION (0x70)

Command = CONFIGURATION_DEFAULT_RESET (0x01)

\requirement{CC:0070.04.01.11.001}{0}

A node receiving this command MUST reset all its Configuration Parameters to their default value.