2.2.95. Schedule Entry Lock Command Class, version 4 [OBSOLETED] [NEVER CERTIFIED]

Warning

THIS COMMAND CLASS HAS NEVER BEEN CERTIFIED

Warning

THIS COMMAND CLASS HAS BEEN OBSOLETED New implementations MUST NOT support this Command Class. Instead, the Active Schedule Command Class, version 1 [NEVER CERTIFIED] SHOULD be used.

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 3.

The Schedule Entry Command Class, version 4 is backwards compatible with Schedule Entry Lock Command Class, version 3.

The Extended User Code Set Command permits to configure an extended number of users (credentials) with 16 bits for its “User Identifier”. Also the User Credential Command Class, version 1 uses 16 bits for its “User Unique Identifier”.

In this Schedule Entry Command Class, version 4 the following commands have been introduced to match the extended number of supported users:

  • Extended Schedule Entry Lock Enable Set Command

  • Extended Schedule Entry Lock Week Day Schedule Set Command

  • Extended Schedule Entry Lock Week Day Schedule Get Command

  • Extended Schedule Entry Lock Week Day Schedule Report Command

  • Extended Schedule Entry Lock Year Day Schedule Set Command

  • Extended Schedule Entry Lock Year Day Schedule Get Command

  • Extended Schedule Entry Lock Year Day Schedule Report Command

  • Extended Schedule Entry Lock Daily Repeating Set Command

  • Extended Schedule Entry Lock Daily Repeating Get Command

  • Extended Schedule Entry Lock Daily Repeating Report Command

2.2.95.1. Extended Schedule Entry Lock Enable Set Command

This command enables or disables schedules for a specified User ID. It only affects the schedules associated with the specific User ID.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = EXTENDED_SCHEDULE_ENTRY_LOCK_ENABLE_SET (0x11)

User Identifier (MSB)

User Identifier (LSB)

Reserved

Enabled

User Identifier (16 bits)

The User Identifier (User ID) 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 MUST be ignored.

Enabled (1 bit)

Table 2.517 Schedule Entry Lock Enable Set::Enabled encoding

Value

Description

0

Schedule for the user identified is disabled.

1

Schedule for the user identified is enabled.

2.2.95.2. Extended Schedule Entry Lock Week Day Schedule Set Command

This command set or erase a weekday schedule for a identified user who already has valid user access code.

When setting, the week day schedule is automatically enabled and 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 week day 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_WEEK_DAY_SCHEDULE_SET (0x12)

Set Action

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

Day of Week

Start Hour

Start Minute

Stop Hour

Stop Minute

Set Action (8 bits)

Table 2.518 Schedule Entry Lock Week Day Schedule Set::Set Action encoding

Set Action

Description

0

Erase the schedule slot.

1

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 (16 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 Week Day Supported.

Day of Week (8 bits)

A value from 0 to 6 where 0 is Sunday.

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.

Stop Hour (8 bits)

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

Stop Minute (8 bits)

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

2.2.95.3. Extended Schedule Entry Lock Week Day Schedule Get Command

This command gets a week day schedule slot for a identified user and specified schedule slot ID.

The Extended Schedule Entry Lock Week Days Schedule 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_WEEK_DAY_SCHEDULE_GET (0x13)

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

User Identifier (16 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 Week Day Supported.

2.2.95.4. Extended Schedule Entry Lock Week Day Schedule Report Command

This command returns week day schedule report for 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_WEEK_DAY_SCHEDULE_REPORT (0x14)

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

Day of Week

Start Hour

Start Minute

Stop Hour

Stop Minute

Refer to the description under the Schedule Set Week Day Schedule.

Note

If a requested schedule slot is erased/empty, the time fields SHOULD be set to 0xFF.

2.2.95.5. Extended Schedule Entry Lock Year Day Schedule Set Command

This command sets or erases a schedule slot for a identified user who already has valid user access code. The year day schedule represents two days, any time apart, where the specified user ID’s code is valid. When setting the schedule slot, the start parameters of the time fence needs to occur prior to the stop parameters and the year day schedule is automatically enabled for the identified user. When erasing, the user code does not change from year day 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_YEAR_DAY_SCHEDULE_SET (0x15)

Set Action

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

Start Year

Start Month

Start Day

Start Hour

Start Minute

Stop Year

Stop Month

Stop Day

Stop Hour

Stop Minute

Set Action (8 bits)

Table 2.519 Schedule Entry Lock Year Day Schedule 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 (16 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 Year Day Supported.

Start Year (8 bits)

A value from 0 to 99 that represents the 2 year in the century.

Start Month (8 bits)

A value from 1 to 12 that represents the month in a year.

Start Day (8 bits)

A value from 1 to 31 that represents the date of the month.

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.

Stop Year (8 bits)

A value from 0 to 99 that represents the 2 year in the century.

Stop Month (8 bits)

A value from 1 to 12 that represents the month in a year.

Stop Day (8 bits)

A value from 1 to 31 that represents the date of the month.

Stop Hour (8 bits)

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

Stop Minute (8 bits)

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

2.2.95.6. Extended Schedule Entry Lock Year Day Schedule Get Command

This command gets a year/day schedule slot for an identified user and specified schedule slot ID.

The Extended Schedule Entry Lock Year Day Schedule 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_YEAR_DAY_SCHEDULE_GET (0x16)

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

User Identifier (16 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 Year Day Supported.

2.2.95.7. Extended Schedule Entry Lock Year Day Schedule Report Command

This command returns year/day schedule report for the requested schedule slot ID for the identified user.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = EXTENDED_SCHEDULE_ENTRY_LOCK_YEAR_DAY_SCHEDULE_REPORT (0x17)

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

Start Year

Start Month

Start Day

Start Hour

Start Minute

Stop Year

Stop Month

Stop Day

Stop Hour

Stop Minute

Refer to the description under Schedule Set Year Day Schedule command.

Note

If a requested schedule slot is erased/empty the time fields SHOULD be set to 0xFF.

2.2.95.8. Extended 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_DAILY_REPEATING_SET (0x18)

Set Action

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

Week Day Bitmask

Start Hour

Start Minute

Duration Hour

Duration Minute

Set Action (8 bits)

Table 2.520 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 (16 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.521 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.95.9. Extended 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 Extended 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_DAILY_REPEATING_GET (0x19)

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

User Identifier (16 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.95.10. Extended 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 = EXTENDED_SCHEDULE_ENTRY_LOCK_DAILY_REPEATING_REPORT (0x1A)

User Identifier (MSB)

User Identifier (LSB)

Schedule Slot ID

Week Day Bitmask

Start Hour

Start Minute

Duration Hour

Duration Minute

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