 | ZWManagerSetSwitchPoint Method |
Set a switch point in the schedule.
Namespace:
OpenZWave
Assembly:
OpenZWave (in OpenZWave.dll) Version: 255.255.255.255
Syntaxpublic bool SetSwitchPoint(
ZWValueId id,
byte hours,
byte minutes,
byte setback
)
Public Function SetSwitchPoint (
id As ZWValueId,
hours As Byte,
minutes As Byte,
setback As Byte
) As Boolean
public:
virtual bool SetSwitchPoint(
[InAttribute] ZWValueId^ id,
[InAttribute] unsigned char hours,
[InAttribute] unsigned char minutes,
[InAttribute] unsigned char setback
) sealed
Parameters
- id
- Type: OpenZWaveZWValueId
The unique identifier of the schedule value. - hours
- Type: SystemByte
The hours part of the time when the switch point will trigger. The time is set using
the 24-hour clock, so this value must be between 0 and 23. - minutes
- Type: SystemByte
The minutes part of the time when the switch point will trigger. This value must be
between 0 and 59. - setback
- Type: SystemByte
The setback in tenths of a degree Celsius. The setback value can range from -128 (-12.8C)
to 120 (12.0C). There are two special setback values - 121 is used to set Frost Protection mode, and
122 is used to set Energy Saving mode.
Return Value
Type:
Booleantrue if successful. Returns false if the value is not a ValueID::ValueType_Schedule. The type can be tested with a call to ValueID::GetType.
RemarksInserts a new switch point into the schedule, unless a switch point already exists at the specified
time in which case that switch point is updated with the new setback value instead.
A maximum of nine switch points can be set in the schedule.
See Also