2.2.38. Door Lock Command Class, version 1-2

The Door Lock Command Class is used to operate and configure a door lock device.

The Door Lock Command Class is an actuator control command class. Refer to Section 2.1.6.

2.2.38.1. Compatibility considerations

A device supporting Door Lock CC, Version 2 MUST support Door Lock CC, version 1.

\requirement{CC:0062.02.00.21.001}{0}

The Door Lock Command Class, version 2 adds the “unknown” state to the Door Lock Operation Report Command.

\requirement{CC:0062.01.00.21.001}{0}

A supporting node MAY implement a subset of the features represented by the Door Lock Mode, Door Handles Mode and Door Condition fields which are provided by the commands of this Command Class.

2.2.38.2. Door Lock Operation Set Command

This command is used to set the operation mode of a supporting door lock device.

Table 2.190 Door Lock Operation Set Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_DOOR_LOCK (0x62)

Command = DOOR_LOCK_OPERATION_SET (0x01)

Door Lock Mode

Door Lock Mode (8 bits)

The Door Lock Mode field is used to specify the operation mode of the door lock device.

\requirement{CC:0062.01.01.11.001}{0}

The encoding of this field MUST be according to Table 2.191.

Table 2.191 Door Lock Operation Set::Mode

Mode

Description

Version

0x00

Door Unsecured 1)

1

0x01

Door Unsecured with timeout 2)

1

0x10

Door Unsecured for inside Door Handles 1)

1

0x11

Door Unsecured for inside Door Handles with timeout 2)

1

0x20

Door Unsecured for outside Door Handles 1)

1

0x21

Door Unsecured for outside Door Handles with timeout 2)

1

0xFF

Door Secured

1

  1. Constant mode. Door will be unsecured until set to secured mode by another command.

  2. Timeout mode. Fallback to secured mode after timeout has expired.

\requirement{CC:0062.01.01.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:0062.01.01.11.003}{0}

A controlling node MUST NOT specify modes using timeout-based fall back if the Operation Type of the supporting device is set to Constant operation (set by Door Lock Configuration Set).

\requirement{CC:0062.01.01.11.004}{0}

A supporting node MUST ignore modes using timeout-based fall back if Operation Type is set to Constant operation.

\requirement{CC:0062.01.01.11.006}{0}

A supporting node MUST apply the constant modes without any timeout even if it is set to Timed Operation Type.

\requirement{CC:0062.01.01.13.001}{0}

A supporting node MAY implement a subset of the Door Lock Modes defined by Table 2.191.

\requirement{CC:0062.01.01.11.005}{0}

A supporting node MUST accept the Door Lock Mode values 0x00 and 0xFF.

2.2.38.3. Door Lock Operation Get Command

This command is used to request the status of a door lock device.

\requirement{CC:0062.01.02.11.001}{0}

The Door Lock Operation Report command MUST be returned in response to this command.

\requirement{CC:0062.01.02.11.002}{0}

This command MUST NOT be issued via multicast addressing.

\requirement{CC:0062.01.02.11.003}{0}

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.192 Door Lock Operation Get Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_DOOR_LOCK (0x62)

Command = DOOR_LOCK_OPERATION_GET (0x02)

2.2.38.4. Door Lock Operation Report Command

This command is used to advertise the status of a door lock device.

Table 2.193 Door Lock Operation Report Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_DOOR_LOCK (0x62)

Command = DOOR_LOCK_OPERATION_REPORT (0x03)

Door Lock Mode

Outside Door Handles Mode

Inside Door Handles Mode

Door Condition

Remaining Lock Time Minutes

Remaining Lock Time Seconds

Door Lock Mode (8 bits)

\requirement{CC:0062.01.03.11.001}{0}

The Door Lock Mode field MUST advertise the mode of the door lock device.

\requirement{CC:0062.01.03.11.002}{0}

The encoding of this field MUST be according to Table 2.194.

Table 2.194 Door Lock Operation Report::Door Lock Mode

Mode

Description

Version

0x00

Door Unsecured 1)

1

0x01

Door Unsecured with timeout 2)

1

0x10

Door Unsecured for inside Door Handles 1)

1

0x11

Door Unsecured for inside Door Handles with timeout 2)

1

0x20

Door Unsecured for outside Door Handles 1)

1

0x21

Door Unsecured for outside Door Handles with timeout 2)

1

0xFE

Door/Lock State Unknown 3)

2

0xFF

Door Secured

1

  1. Constant mode. Door will be unsecured until set back to secured mode by command

  2. Timeout mode. Fallback to secured mode after timeout has expired

  3. Bolt is not fully retracted/engaged

\requirement{CC:0062.01.03.11.003}{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:0062.01.03.13.001}{0}

A supporing node MAY advertise a subset of the available Door Lock Mode values.

\requirement{CC:0062.01.03.11.004}{0}

A controlling node MUST accept all Door Lock Mode values.

\requirement{CC:0062.01.03.12.001}{0}

The Door Lock Mode field SHOULD advertise the current value of the device hardware; also while in transition to a new target value.

Outside Door Handles Mode (4 bits)

\requirement{CC:0062.01.03.11.005}{0}

This field MUST advertise the status of each individual outside door handle.

\requirement{CC:0062.01.03.11.006}{0}

The encoding of the Outside Door Handles Mode bitmask field MUST be according to Table 2.195 and Table 2.196.

Table 2.195 Door Handles Mode bitmask

Bit 3

Bit 2

Bit 1

Bit 0

Handle 4

Handle 3

Handle 2

Handle 1
Table 2.196 Door Handles Mode bit encoding

Bit value

Description

‘0’

Disabled

‘1’

Enabled

\requirement{CC:0062.01.03.11.007}{0}

The value ‘0’ MUST signify that the actual handle cannot open the door locally.

\requirement{CC:0062.01.03.11.008}{0}

The value ‘1’ MUST signify that the actual handle can open the door locally.

\requirement{CC:0062.01.03.13.002}{0}

A supporting node MAY advertise just a subset of the available Door Handles Mode values.

\requirement{CC:0062.01.03.11.009}{0}

A controlling node MUST accept all Door Handles Mode values.

Inside Door Handles Mode (4 bits)

\requirement{CC:0062.01.03.11.00A}{0}

This field MUST advertise the status of each individual inside door handle.

\requirement{CC:0062.01.03.11.00B}{0}

The encoding of the Inside Door Handles Mode bitmask field MUST be according to Table 2.195 and Table 2.196.

\requirement{CC:0062.01.03.13.003}{0}

A supporting node MAY advertise just a subset of the available Door Handles Mode values.

\requirement{CC:0062.01.03.11.00C}{0}

A controlling node MUST accept all Door Handles Mode values.

Door Condition (8 bits)

\requirement{CC:0062.01.03.11.00D}{0}

The Door Condition field MUST advertise the status of the door lock components.

\requirement{CC:0062.01.03.11.00E}{0}

The encoding of the Door Condition bitmask field MUST be according to Table 2.210.

\requirement{CC:0062.01.03.13.004}{0}

A supporting node MAY advertise just a subset of the available Door Condition values.

\requirement{CC:0062.01.03.11.0010}{0}

A controlling node MUST accept all Door Condition values.

Remaining Lock Time Minutes (8 bits)

\requirement{CC:0062.01.03.11.011}{0}

This field MUST advertise the remaining time before the door lock will automatically be locked again.

\requirement{CC:0062.01.03.11.012}{0}

The encoding of the Remaining Lock Time Minutes field MUST be according to Table 2.197. The time the supporting node stays unlocked MUST be determined by combining the Remaining Lock Time Minutes and Remaining Lock Time Seconds fields.

Table 2.197 Door Lock Operation Report::Remaining Lock Time Minutes

Value

Operation

0x00..0xFD

Unlocked 0 .. 253 minutes (Operation Type = Timed Operation)

0xFE

No unlocked period (Operation Type = Constant Operation)

\requirement{CC:0062.01.03.11.013}{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:0062.01.03.13.005}{0}

A supporting node MAY advertise just a subset of the available Remaining Lock Time values.

\requirement{CC:0062.01.03.11.014}{0}

A controlling node MUST accept all Remaining Lock Time values.

Remaining Lock Time Seconds (8 bits)

\requirement{CC:0062.01.03.11.015}{0}

This field MUST advertise the remaining time before the door lock will automatically be locked again.

\requirement{CC:0062.01.03.11.016}{0}

The encoding of the Remaining Lock Time Seconds field MUST be according to Table 2.198. The time to stay unlocked MUST be determined by combining the Remaining Lock Time Minutes and Remaining Lock Time Seconds fields.

Table 2.198 Door Lock Operation Report::Remaining Lock Time Seconds

Value

Operation

0..59 (0x00..0x3B)

Unlocked 0 .. 59 seconds (Operation Type = Timed Operation)

254 (0xFE)

No unlocked period (Operation Type = Constant Operation)

\requirement{CC:0062.01.03.11.017}{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:0062.01.03.13.006}{0}

A supporting node MAY advertise just a subset of the available Lock Timeout values.

\requirement{CC:0062.01.03.11.018}{0}

A controlling de MUST accept all Lock Timeout values.

2.2.38.5. Door Lock Configuration Set Command

This command is used to set the configuration of a supporting door lock device.

\requirement{CC:0062.01.04.11.001}{0}

A door lock device MUST be able to operate with the factory default settings.

Table 2.199 Door Lock Configuration Set Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_DOOR_LOCK (0x62)

Command = DOOR_LOCK_CONFIGURATION_SET (0x04)

Operation Type

Outside Door Handles Enabled

Inside Door Handles Enabled

Lock Timeout Minutes

Lock Timeout Seconds

Operation Type (1 byte)

\requirement{CC:0062.01.04.11.002}{0}

The Operation Type field MUST be set according to Table 2.200. When timed operation is specified, the Lock Timeout Minutes and Lock Timeout Seconds fields MUST be set to valid values.

Table 2.200 Door Lock Operation Type

Operation Type

Description

Valid Lock Timeout values

0x01

Constant operation

Minutes = 0xFE Seconds= 0xFE

0x02

Timed operation

Minutes = 0x00..0xFD Seconds= 0x00..0x3B

\requirement{CC:0062.01.04.11.003}{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:0062.01.04.13.001}{0}

A supporting node MAY accept just a subset of the available Operation Type values.

\requirement{CC:0062.01.04.11.004}{0}

A supporting node MUST accept the Operation Type value 0x01.

Outside Door Handles Enabled (4 bits)

This field is used to advertise the status of each individual outside door handle.

\requirement{CC:0062.01.04.11.005}{0}

The encoding of the Outside Door Handles Mode bitmask field MUST be according to Table 2.195 and Table 2.196.

\requirement{CC:0062.01.04.13.002}{0}

A supporting node MAY ignore the Door Handles Mode value.

Inside Door Handles Enabled (4 bits)

\requirement{CC:0062.01.04.11.006}{0}

This field MUST advertise the status of each individual inside door handle.

\requirement{CC:0062.01.04.11.007}{0}

The encoding of the Inside Door Handles Mode bitmask field MUST be according to Table 2.195 and Table 2.196.

\requirement{CC:0062.01.04.13.003}{0}

A supporting node MAY ignore the Door Handles Mode value.

Lock Timeout Minutes (1 byte)

\requirement{CC:0062.01.04.11.008}{0}

This field MUST specify the time that a door lock must wait before automatically being locked again.

\requirement{CC:0062.01.04.11.009}{0}

The encoding of the Lock Timeout Minutes field MUST be according to Table 2.197. The time to stay unlocked MUST be determined by combining the Lock Timeout Minutes and Lock Timeout Seconds fields.

\requirement{CC:0062.01.04.13.004}{0}

A supporting node MAY ignore the Lock Timeout values if it implements only the Operation Type = 0x01 (Constant operation).

Lock Timeout Seconds (1 byte)

\requirement{CC:0062.01.04.11.00A}{0}

This field MUST specify the time that a door lock must wait before automatically being locked again.

\requirement{CC:0062.01.04.11.00B}{0}

The encoding of the Lock Timeout Seconds field MUST be according to Table 2.198. The time to stay unlocked MUST be determined by combining the Lock Timeout Minutes and Lock Timeout Seconds fields.

\requirement{CC:0062.01.04.13.005}{0}

A supporting node MAY ignore the Lock Timeout values if it implements only the Operation Type = 0x01 (Constant operation).

2.2.38.6. Door Lock Configuration Get Command

This command is used to request the configuration parameters of a door lock device.

\requirement{CC:0062.01.05.11.001}{0}

The Door Lock Configuration Report command MUST be returned in response to this command.

\requirement{CC:0062.01.05.11.002}{0}

This command MUST NOT be issued via multicast addressing.

\requirement{CC:0062.01.05.11.003}{0}

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.201 Door Lock Configuration Get Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_DOOR_LOCK (0x62)

Command = DOOR_LOCK_CONFIGURATION_GET (0x05)

2.2.38.7. Door Lock Configuration Report Command

This command is used to advertise the configuration parameters of a door lock device.

Table 2.202 Door Lock Configuration Report Command

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_DOOR_LOCK (0x62)

Command = DOOR_LOCK_CONFIGURATION_REPORT (0x06)

Operation Type

Outside Door Handles Enabled

Inside Door Handles Enabled

Lock Timeout Minutes

Lock Timeout Seconds

For fields’ description, refer to Section 2.2.38.5 Door Lock Configuration Set Command.