Variable LightingComponentConst

Type declaration

• Readonlyattributes: {
      globalSceneControl: Attribute<boolean, any>;
      offWaitTime: WritableAttribute<number, any>;
      onTime: WritableAttribute<number, any>;
      startUpOnOff: WritableAttribute<OnOff.StartUpOnOff | null, any>;
  }

  • ReadonlyglobalSceneControl: Attribute<boolean, any>

    In order to support the use case where the user gets back the last setting of a set of devices (e.g. level settings for lights), a global scene is introduced which is stored when the devices are turned off and recalled when the devices are turned on. The global scene is defined as the scene that is stored with group identifier 0 and scene identifier 0.

    This attribute is defined in order to prevent a second Off command storing the all-devices-off situation as a global scene, and to prevent a second On command destroying the current settings by going back to the global scene.

    This attribute shall be set to TRUE after the reception of a command which causes the OnOff attribute to be set to TRUE, such as a standard On command, a MoveToLevel(WithOnOff) command, a RecallScene command or a OnWithRecallGlobalScene command.

    This attribute is set to FALSE after reception of a OffWithEffect command.

    See

    MatterSpecification.v13.Cluster § 1.5.6.3

  • ReadonlyoffWaitTime: WritableAttribute<number, any>

    This attribute specifies the length of time (in 1/10ths second) that the Off state shall be guarded to prevent another OnWithTimedOff command turning the server back to its On state (e.g., when leaving a room, the lights are turned off but an occupancy sensor detects the leaving person and attempts to turn the lights back on). This attribute can be written at any time, but writing a value only has an effect when in the Timed On state followed by a transition to the Delayed Off state, or in the Delayed Off state. See OnWithTimedOff for more details.

    See

    MatterSpecification.v13.Cluster § 1.5.6.5

  • ReadonlyonTime: WritableAttribute<number, any>

    This attribute specifies the length of time (in 1/10ths second) that the On state shall be maintained before automatically transitioning to the Off state when using the OnWithTimedOff command. This attribute can be written at any time, but writing a value only has effect when in the Timed On state. See OnWithTimedOff for more details.

    See

    MatterSpecification.v13.Cluster § 1.5.6.4

  • ReadonlystartUpOnOff: WritableAttribute<OnOff.StartUpOnOff | null, any>

    This attribute shall define the desired startup behavior of a device when it is supplied with power and this state shall be reflected in the OnOff attribute. If the value is null, the OnOff attribute is set to its previous value. Otherwise, the behavior is defined in the table defining StartUpOnOffEnum.

    This behavior does not apply to reboots associated with OTA. After an OTA restart, the OnOff attribute shall return to its value prior to the restart.

    See

    MatterSpecification.v13.Cluster § 1.5.6.6

• Readonlycommands: {
      offWithEffect: Command<TypeFromFields, void, any>;
      onWithRecallGlobalScene: Command<void, void, any>;
      onWithTimedOff: Command<TypeFromFields, void, any>;
  }

  • ReadonlyoffWithEffect: Command<TypeFromFields, void, any>

    The OffWithEffect command allows devices to be turned off using enhanced ways of fading.

    See

    MatterSpecification.v13.Cluster § 1.5.7.4

  • ReadonlyonWithRecallGlobalScene: Command<void, void, any>

    This command allows the recall of the settings when the device was turned off.

    See

    MatterSpecification.v13.Cluster § 1.5.7.5

  • ReadonlyonWithTimedOff: Command<TypeFromFields, void, any>

    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.

    See

    MatterSpecification.v13.Cluster § 1.5.7.6