Interface Lighting

interface Lighting {
    offWithEffect(request: OnOff.OffWithEffectRequest): MaybePromise;
    onWithRecallGlobalScene(): MaybePromise;
    onWithTimedOff(request: OnOff.OnWithTimedOffRequest): MaybePromise;
}

Index

Methods

offWithEffect onWithRecallGlobalScene onWithTimedOff

Methods

offWithEffect

offWithEffect(request): MaybePromise
The OffWithEffect command allows devices to be turned off using enhanced ways of fading.
Parameters
- request: OnOff.OffWithEffectRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 1.5.7.4
- Defined in packages/node/src/behaviors/on-off/OnOffInterface.ts:26

onWithRecallGlobalScene

onWithRecallGlobalScene(): MaybePromise
This command allows the recall of the settings when the device was turned off.

Returns MaybePromise
See
MatterSpecification.v13.Cluster § 1.5.7.5
- Defined in packages/node/src/behaviors/on-off/OnOffInterface.ts:33

onWithTimedOff

onWithTimedOff(request): MaybePromise
This command allows devices to be turned on for a specific duration with a guarded off duration so that SHOULD the device be subsequently turned off, further OnWithTimedOff commands, received during this time, are prevented from turning the devices back on. Further OnWithTimedOff commands received while the server is turned on, will update the period that the device is turned on.
Parameters
- request: OnOff.OnWithTimedOffRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 1.5.7.6
- Defined in packages/node/src/behaviors/on-off/OnOffInterface.ts:43