2.2.94. Schedule Entry Lock Command Class, version 3

Warning

THIS COMMAND CLASS HAS BEEN DEPRECATED

A device MAY implement this command class, but it is RECOMMENDED that new implementations use the Schedule Entry Lock Command Class, version 4 [OBSOLETED] [NEVER CERTIFIED].

The Schedule Entry Lock Command Class provides a scheduling type alongside the existing types Week Day and Year Day. The new type is similar to Week Day functionality but provides a simpler implementation to repeat a time slot daily (selected days) and repeat those days weekly. The commands not mentioned here remain the same as in Version 2.

2.2.94.1. Schedule Entry Type Supported Report Command

This command is used to report the number of supported schedule slots an Entry Lock schedule device supports for each user in the system. It lists how many schedule slots there are for Week Day, Year Day, and Daily Repeating types.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = SCHEDULE_ENTRY_TYPE_SUPPORTED_REPORT (0x0A)

Number of Slots Week Day

Number of Slots Year Day

Number of Slots Daily Repeating

Number of Slots Week Day (8 bits)

A number from 0 to 255 that represents how many different schedule slots are supported each week for every user in the system for type Week Day.

Number of Slots Year Day (8 bits)

A number from 0 to 255 that represents how many different schedule slots are supported for every user in the system for type Year Day.

Number of Slots Daily Repeating (8 bits)

A number from 0 to 255 that represents how many different schedule slots are supported for every user in the system for type Daily Repeating Day.

2.2.94.2. Schedule Entry Lock Daily Repeating Set Command

This command is used to set or erase a daily repeating schedule for an identified user who already has valid user access code.

When setting; the daily repeating schedule is automatically enabled for the identified user if it is not already. The start parameters of the time fence needs to occur prior to the stop parameters. When erasing the schedule slot ID, the user code ID will continue to use daily repeating type scheduling.

Note

Each user can only use one type of scheduling at a time.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = SCHEDULE_ENTRY_LOCK_DAILY_REPEATING_SET (0x10)

Set Action

User Identifier

Schedule Slot ID

Week Day Bitmask

Start Hour

Start Minute

Duration Hour

Duration Minute

Set Action (8 bits)

Table 2.515 Schedule Entry Lock Daily Repeating Set::Set Action encoding

Value

Description

0x00

Erase the schedule slot.

0x01

Modify the schedule slot for the identified user.

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

User Identifier (8 bits)

The User Identifier is used to recognize the user identity. A valid User Identifier MUST be a value starting from 1 to the maximum number of users supported by the device; refer to the User Code Command Class. If the user identifier is out of range, the command will be ignored

Schedule Slot ID (8 bits)

A value from 1 to Number of Slots Daily Repeating Supported.

Week Day Bitmask (8 bits)

A bitmask of the days of the week for this schedule entry is active.

Table 2.516 Schedule Entry Lock Daily Repeating Set::Week Day Bitmask encoding

Bit

7

6

5

4

3

2

1

0

Value

Res

Sat

Fri

Thr

Wed

Tue

Mon

Sun

The ‘Res’ bit is reserved and MUST be set to zero by a sending node. Reserved bits MUST be ignored by a receiving node.

Start Hour (8 bits)

A value from 0 to 23 representing the starting hour of the time fence.

Start Minute (8 bits)

A value from 0 to 59 representing the starting minute of the time fence.

Duration Hour (8 bits)

A value from 0 to 23 representing how many hours the time fence will last. Duration hour will be maxed at the documented capability of the specific device since this scheduling type is memory conscious.

Duration Minute (8 bits)

A value from 0 to 59 representing how many minutes the time fence will last past the Duration Hour field.

2.2.94.3. Schedule Entry Lock Daily Repeating Get Command

This command is used to request a daily repeating schedule slot for a identified user and specified schedule slot ID.

The Schedule Entry Lock Daily Repeating 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.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = SCHEDULE_ENTRY_LOCK_DAILY_REPEATING_GET (0x0E)

User Identifier

Schedule Set ID

User Identifier (8 bits)

The User Identifier is used to recognize the user identity. A valid User Identifier MUST be a value starting from 1 to the maximum number of users supported by the device; refer to the User Code Command Class. If the user identifier is out of range, the command will be ignored

Schedule Slot ID (8 bits)

A value from 1 to Number of Slots Daily Repeating Supported.

2.2.94.4. Schedule Entry Lock Daily Repeating Report Command

This command is used to return the requested schedule slot ID for identified user.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = SCHEDULE_ENTRY_LOCK_DAILY_REPEATING_REPORT (0x0F)

User Identifier

Schedule Set ID

Week Day Bitmask

Start Hour

Start Minute

Duration Hour

Duration Minute

Refer to the description under the Schedule Set Daily Repeating Schedule.