2.2.92. Schedule Entry Lock Command Class, version 1 [DEPRECATED]

Warning

THIS COMMAND CLASS HAS BEEN DEPRECATED

A device MAY implement this command class, but it is RECOMMENDED that new implementations use the Schedule Command Class.

If implementing this command class, it is RECOMMENDED that the Schedule Command Class is also implemented.

The Schedule Entry Lock Command Class provides Z-Wave devices the capability to exchange scheduling information. The Schedule Entry Lock Type Commands are for controlling the schedules of an Entry Lock using schedule based user code Ids. The Entry Lock supports two types of schedules for each user ID supported in the device. The two schedule types are a time-fenced weekly schedule and a time-fenced one-time range schedule. When these schedules are configured and enabled, it allows the specified user ID’s code to be active during the time intervals configured in the scheduling slots.

The Week Day schedule is a day-to-day schedule that will repeat weekly for the enabled user ID. A single schedule slot cannot span days.

Example: A homeowner has a Secure Keypad Door Lock and a dog that needs walking three times a week. The dog walker can be given access to the house using this schedule. The homeowner would give the dog walker a keypad code that would be active M, W, F from 1pm - 2pm.

The Year Day schedule is an extended schedule that allows two points in time to be specified that is beyond a daily schedule. A particular slot can span weeks, months or years. Once the end point is reached that schedule slot is no longer valid because it is out of range.

Example: A homeowner is going away on vacation for two weeks. The homeowner could give the neighbor a keypad code to the neighbor that would be active from April 2nd, 2008 to April 16th` 2008. The code would be invalid after April 16th 2008.

2.2.92.1. Schedule Entry Lock Enable Set Command

This command enables or disables schedules for a specified user code ID. It affects only 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 = SCHEDULE_ENTRY_LOCK_ENABLE_SET (0x01)

User Identifier

Enabled

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.

Enabled (8 bits)

Table 2.512 Schedule Entry Lock Enable Set::Enabled encoding

Value

Description

0x00

Schedule for the user identified is disabled.

0x01

Schedule for the user identified is enabled.

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

2.2.92.2. Schedule Entry Lock Enable All Set Command

This command enables or disables all schedules for type Entry Lock.

7

6

5

4

3

2

1

0

Command Class = COMMAND_CLASS_SCHEDULE_ENTRY_LOCK (0x4E)

Command = SCHEDULE_ENTRY_LOCK_ENABLE_ALL_SET (0x02)

Enabled

Enabled (8 bits)

See description in Schedule Entry Lock Enable Set Command.

2.2.92.3. Schedule Entry Lock Supported Get Command

This command is used to request the number of schedule slots each type of schedule the device supports for every user.

The Schedule Entry Lock Supported 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_TYPE_SUPPORTED_GET (0x09)

2.2.92.4. Schedule Entry Lock 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 Days type and how many slots for the Year Day type.

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 Week Day (8 bits)

A number from 0 - 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 - 255 that represents how many different schedule slots are supported for every user in the system for type Year Day.

2.2.92.5. 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 = SCHEDULE_ENTRY_LOCK_WEEK_DAY_SET (0x03)

Set Action

User Identifier

Schedule Slot ID

Day of Week

Start Hour

Start Minute

Stop Hour

Stop Minute

Set Action (8 bits)

Table 2.513 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 (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 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.92.6. Schedule Entry Lock Week Days Schedule Get Command

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

The 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 = SCHEDULE_ENTRY_LOCK_WEEK_DAY_GET (0x04)

User Identifier

Schedule Slot 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 Week Day Supported.

2.2.92.7. 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 = SCHEDULE_ENTRY_LOCK_WEEK_DAY_REPORT (0x05)

User Identifier

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.92.8. 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 = SCHEDULE_ENTRY_LOCK_YEAR_DAY_SET (0x06)

Set Action

User Identifier

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.514 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 (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 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.92.9. 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 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 = SCHEDULE_ENTRY_LOCK_YEAR_DAY_GET (0x07)

User Identifier

Schedule Slot 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 Year Day Supported.

2.2.92.10. 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 = SCHEDULE_ENTRY_LOCK_YEAR_DAY_REPORT (0x08)

User Identifier

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.