2.2.44. Generic Schedule Command Class, version 1 [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 Generic Schedule Command Class is used to define schedules.

Schedules defined in this command class are essentially time ranges or intervals. Each schedule is associated to a Schedule ID.

The Schedules defined in this Command Class can be used in other Command Classes, e.g. to schedule when user credentials are valid or when to apply a particular configuration.

2.2.44.1. Terminology¶

Schedules are composed by one or more Time Range(s). A time range is a composed of one or several scheduling parameters, such as weekdays, day of the month, hour of the day, etc.

Time ranges are defined individually with scheduling parameters. For example, it could be Time Range 1 representing weekdays during work hours and Time Range 2 representing public holidays at fixed dates. (e.g. 25th of December and 31st of October)

A schedule can then be set including or excluding each of its composing time ranges. Schedule ID 1 could include weekdays work hours (Time Range 1) and exclude public holidays (Time Range 2). It means that Schedule 1 must be active only on weekdays work hours when it is not a public holiday.

At least one of the included Time Ranges conditions must be fulfilled and none of the excluded Time Ranges must be fulfilled for a Schedule to be active.

2.2.44.2. Interoperability considerations¶

This Command Class relies on time and date synchronization between controlling and supporting nodes.

Nodes supporting this command class should also have correct time or date settings depending on their capabilities. Supporting nodes may support the Clock Command Class for this purpose. The Time Command Class may also be used for reading the current date and time at the supporting node.

2.2.44.3. Generic Schedule Capabilities Get Command¶

This command is used to request the scheduling capabilities of a supporting node.

The Generic Schedule 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.240 Generic Schedule Capabilities Get Command¶
7	6	5	4	3	2	1	0
Command Class = COMMAND_CLASS_GENERIC_SCHEDULE (0xA3)
Command = GENERIC_SCHEDULE_CAPABILITIES_GET (0x01)

2.2.44.4. Generic Schedule Capabilities Report Command¶

This command is used to advertise the number of supported Schedule Slot IDs for each Schedule Type/User Identifier by the sending node.

Table 2.241 Generic Schedule Capabilities Report Command¶
7	6	2	1	0
Command Class = COMMAND_CLASS_GENERIC_SCHEDULE (0xA3)
Command = GENERIC_SCHEDULE_CAPABILITIES_REPORT (0x02)
Number of supported Schedule IDs (MSB)
Number of supported Schedule IDs (LSB)
Res	Number of supported Time Range IDs (MSB)
Number of supported Time Range IDs (LSB)
Number of supported Time Ranges per Schedule
Reserved		Week- days	Date	Hour & Minute

Number of supported Schedule IDs (16 bits)

This field is used to indicate how many Schedule IDs are supported by a supporting node.

This field MUST be in the range 1..65535.

Number of supported Time Range IDs (15 bits)

This field is used to indicate how many Time Ranges IDs are supported by a supporting node.

This field MUST be in the range 1.. 32767.

The number of supported Time Ranges IDs should be equal or greater than the (Number of supported Schedule IDs) x (Number of supported Time Ranges per Schedule)

Number of supported Time Ranges per Schedule (8 bits)

This field is used to indicate how many time ranges can be used as part of 1 schedule.

This field MUST be in the range 1..255.

Weekdays (1 bit)

This field is used to indicate if the supporting node can accept weekdays in the time ranges.

The value 0 MUST indicate that weekdays are not supported in time ranges and will be ignored.

The value 1 MUST indicate that weekdays are supported in time ranges.

Date (1 bit)

This field is used to indicate if the supporting node can accept years, month and day parameters in the time ranges.

The value 0 MUST indicate that start/stop dates are not supported in time ranges and will be ignored.

The value 1 MUST indicate that start/stop dates are supported in time ranges.

Hour & Minute (1 bit)

This field is used to indicate if the supporting node can accept start and stop hours/minutes in the time ranges.

The value 0 MUST indicate that start/stop hours/minutes are not supported in time ranges and will be ignored.

The value 1 MUST indicate that start/stop hours/minutes are supported in time ranges.

A supporting node MUST advertise support for at least 1 scheduling parameter (Weekdays, Date, Hour & Minute).

2.2.44.5. Generic Schedule Time Range Set Command¶

This command is used to configure a Time Range for a supporting node.

A Time Range MUST be active when all the conditions indicated in its configuration are fulfilled. Some examples are provided in Section 2.2.44.5.1.

Table 2.242 Generic Schedule Time Range Set Command¶
7	6	5	4	3
Command Class = COMMAND_CLASS_GENERIC_SCHEDULE (0xA3)
Command = GENERIC_SCHEDULE_TIME_RANGE_SET (0x03)
Res	Time Range ID 1 (MSB)
Time Range ID 2 (LSB)
In use	Weekday bitmask
In use	Start Year (MSB)
Start Year (LSB)
In use	Stop Year (MSB)
Stop Year (LSB)
In use	Reserved			Start Month
In use	Reserved			Stop Month
In use	Reserved		Start Day
In use	Reserved		Stop Day
In use	Reserved		Start Hour
In use	Reserved		Stop Hour
In use	Res	Start Minute
In use	Res	Stop Minute
In use	Reserved		Daily Start Hour
In use	Reserved		Daily Stop Hour
In use	Res	Daily Start Minute
In use	Res	Daily Stop Minute

Res / Reserved

This field MUST be set to 0 by a sending node and MUST be ignored by a receiving node.

Time Range ID (15 bits)

This field is used to indicate which Time Range ID to use for the Time Range being set.

This field MUST be in the range 0..[Number of supported Time Range IDs].

The value 0 MUST indicate that the supporting node MUST erase all configured Time Ranges. In this case, all other fields MUST be set to 0 and ignored by a receiving node.

Values in the range 1..[Number of supported Time Range IDs] MUST indicate the actual Time Range ID to configure.

If a non-supported Time Range ID is specified in this command, a receiving node MUST ignore the command.

In use (15 x 1 bit)

This field is used to indicate if the corresponding scheduling parameter must be used in the Time Range being set.

This field MUST apply to the scheduling parameter being part of the same byte. E.g. the “in use” field part of the byte comprising the Weekday bitmask field MUST indicate if the Weekday bitmask parameter MUST be used and applied to the current Time Range.

The value 0 MUST indicate that the corresponding field is set to 0 and MUST be ignored.

The value 1 MUST indicate that the corresponding field is set to a valid value and MUST be applied for the actual Time Range ID.

All “in use” fields set to 0 MUST indicate to erase a Time Range configuration.

Weekday bitmask (7 bits)

This field is used to indicate on which days the actual Time Range ID MUST be active.

This field MUST be treated as a bitmask and encoded according to Table 2.243.

Table 2.243 Generic Schedule Set::Weekday bitmask encoding¶
Bit #	Weekday
Bit 0	Sunday
Bit 1	Monday
Bit 2	Tuesday
Bit 3	Wednesday
Bit 4	Thursday
Bit 5	Friday
Bit 6	Saturday

If the corresponding In use field is set to 1:

The value 0 MUST indicate that the Time Range MUST NOT be active during the corresponding weekday.
The value 1 MUST indicate that the Time Range MUST be active during the corresponding weekday.

If the corresponding In use field is set to 0, the Time Range MUST be active regardless of the current weekday.

A supporting node MUST ignore this field if it advertises no support for the weekday scheduling parameter in the Generic Schedule Capabilities Report Command

Start Year (15 bits)

This field is used to indicate the start year for the actual Time Range ID.

If the corresponding In use field is set to 1, the fields MUST indicate that the Time Range ID MUST be use this field as parameter. Refer to Section 2.2.44.5.1 for details. This field MUST be encoded using unsigned representation.