2.2.51. Humidity Control Setpoint Command Class, version 1-2

The Humidity Control Setpoint Command Class is used for humidity control setpoint handling.

2.2.51.1. Humidity Control Setpoint Set Command

This command is used to set the humidity control setpoint in the device.

Table 2.286 Humidity Control Setpoint Set Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_SET (0x01)

Reserved

Setpoint Type

Precision

Scale

Size

Value 1

…

Value N

Reserved

The reserved field is for future use. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

Setpoint Type (4 bits)

The Setpoint Type field MUST specify the humidity control setpoint to be set in the humidity control device. The encoding of the Setpoint Type field MUST be according to Table 2.287.

Table 2.287 Setpoint Type

Setpoint Type

Description

Version

1

Humidifier

1

2

De-humidifier

1

3

Auto

2

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

Precision (3 bits)

The precision field MUST specify the precision of the setpoint value. The number indicates the number of decimals. As an example, the decimal value 1025 with precision two (2) is equal to 10.25.

Scale (2 bits)

The Scale field MUST specify the humidity scale used. The encoding of the Scale field MUST be according to Table 2.288.

Table 2.288 Scale Values

Scale

Description

Version

0

Percentage value

1

1

Absolute humidity (g/m3)

1

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

Size (3 bits)

The Size field MUST specify the number of bytes used for the Value field. The encoding of the Size field MUST be according to Table 2.289.

Table 2.289 Size Values

Size

Description

Version

1

Value field is 1 byte long

1

2

Value field is 2 bytes long

1

4

Value field is 4 bytes long

1

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

Value (N bytes)

The value is a signed field. The field MAY be one, two, or four bytes in size as specified by the Size field. Value 1 is the most significant byte.

2.2.51.2. Humidity Control Setpoint Get Command

This command is used to request the given humidity control setpoint type in a device.

The Humidity Control Setpoint Report 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 2.290 Humidity Control Setpoint Get Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_GET (0x02)

Reserved

Setpoint Type

Reserved

The reserved field is for future use. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

Setpoint Type (4 bits)

This field MUST indicate which humidity control setpoint MUST be returned by the supporting node. The encoding of the Setpoint Type field MUST be according to Table 2.287.

2.2.51.3. Humidity Control Setpoint Report Command

This command is used to report the value of the humidity control setpoint type in the device.

Table 2.291 Humidity Control Setpoint Report Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_REPORT (0x03)

Reserved

Setpoint Type

Precision

Scale

Size

Value 1

…

Value N

Reserved

The reserved field is for future use. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

For fields’ description, refer to Section 2.2.51.1 Humidity Control Setpoint Set Command

2.2.51.4. Humidity Control Setpoint Supported Get Command

This command is used to request the humidity control setpoint types supported by the device.

The Humidity Control Setpoint Supported Report Command MUST be returned in response to a 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 2.292 Humidity Control Setpoint Supported Get Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_SUPPORTED_GET (0x04)

2.2.51.5. Humidity Control Setpoint Supported Report Command

This command is used to report the humidity control setpoint types supported by the device.

Table 2.293 Humidity Control Setpoint Supported Report Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_SUPPORTED_REPORT (0x05)

Bit Mask 1

…

Bit Mask N

Bit Mask (N bytes)

The Bit Mask fields MUST advertise the humidity control setpoint types supported by the device.The encoding of the Size field MUST be according to Table 2.294.

Table 2.294 Humidity Control Setpoint Supported Report values

Field

Bit

Support for Setpoint Type

Version

Bit Mask 1

0

Reserved

1

Bit Mask 1

1

1 (Humidifier)

1

Bit Mask 1

2

2 (De-humidifier)

1

Bit Mask 1

3

3 (Auto)

2

All Bit Mask fields and bits not specified above are reserved. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

For each individual bit, The value ‘0’ MUST signify that the actual Setpoint Type is not supported.

The value ‘1’ MUST signify that the actual Setpoint Type is supported.

A sending node MAY omit trailing Bit Mask fields if they are not needed. The number of Bit Mask fields MUST be determined from the length field in the frame.

2.2.51.6. Humidity Control Setpoint Scale Supported Get Command

This command is used to retrieve the supported scales of the humidity control setpoints in the device.

The Humidity Control Scale Supported Report Command MUST be returned in response to this command.

Table 2.295 Humidity Control Setpoint Scale Supported Get Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_SCALE_SUPPORTED_GET (0x06)

Reserved

Setpoint Type

Reserved

The reserved field is for future use. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

Setpoint Type (4 bits)

Refer to the description under the Section 2.2.51.1 Humidity Control Setpoint Set Command.

2.2.51.7. Humidity Control Setpoint Scale Supported Report Command

This command indicates the supported scales of the humidity control setpoint in a bit mask format.

Table 2.296 Humidity Control Setpoint Scale Supported Report Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_SCALE_SUPPORTED_REPORT (0x07)

Reserved

Scale Bit Mask

Reserved

The reserved field is for future use. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

Scale Bit Mask (4 bits)

Refer to the description under Section 2.2.51.1 Humidity Control Setpoint Set Command.

2.2.51.8. Humidity Control Setpoint Capabilities Get Command

This command is used to request the minimum and maximum setpoint values for a given humidity control Setpoint Type.

The Humidity Control Setpoint Capabilities 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 2.297 Humidity Control Setpoint Capabilities Get Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_CAPABILITIES_GET (0x08)

Reserved

Setpoint Type

Reserved

The reserved field is for future use. Reserved bits MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

Setpoint Type (4 bits)

Refer to the description under Section 2.2.51.1 Humidity Control Setpoint Set Command.

2.2.51.9. Humidity Control Setpoint Capabilities Report Command

This command is used to report the minimum and maximum values of the requested humidity control setpoint type.

Table 2.298 Humidity Control Setpoint Capabilities Report Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_HUMIDITY_CONTROL_SETPOINT (0x64)

Command = HUMIDITY_CONTROL_SETPOINT_CAPABILITIES_REPORT (0x09)

Reserved

Setpoint Type

Precision

Scale

Size

Minimum Value 1

…

Minimum Value N

Precision

Scale

Size

Maximum Value 1

…

Maximum Value N

Refer to the description under Section 2.2.51.1 Humidity Control Setpoint Set Command for other parameter/field descriptions.