Variable BaseConst

Type declaration

• Readonlyattributes: {
      currentLevel: Attribute<null | number, any>;
      defaultMoveRate: OptionalWritableAttribute<null | number, any>;
      maxLevel: OptionalAttribute<number, any>;
      offTransitionTime: OptionalWritableAttribute<null | number, any>;
      onLevel: WritableAttribute<null | number, any>;
      onOffTransitionTime: OptionalWritableAttribute<number, any>;
      onTransitionTime: OptionalWritableAttribute<null | number, any>;
      options: WritableAttribute<TypeFromPartialBitSchema<{
          coupleColorTempToLevel: BitFlag;
          executeIfOff: BitFlag;
      }>, any>;
  }

  • ReadonlycurrentLevel: Attribute<null | number, any>

    Indicates the current level of this device. The meaning of 'level' is device dependent.

    See

    MatterSpecification.v13.Cluster § 1.6.6.2

  • ReadonlydefaultMoveRate: OptionalWritableAttribute<null | number, any>

    Indicates the movement rate, in units per second, when a Move command is received with a null value Rate parameter.

    See

    MatterSpecification.v13.Cluster § 1.6.6.14

  • ReadonlymaxLevel: OptionalAttribute<number, any>

    Indicates the maximum value of CurrentLevel that is capable of being assigned.

    See

    MatterSpecification.v13.Cluster § 1.6.6.5

  • ReadonlyoffTransitionTime: OptionalWritableAttribute<null | number, any>

    Indicates the time taken to move the current level from the maximum level to the minimum level when an Off command is received by an On/Off cluster on the same endpoint. It is specified in 1/10ths of a second. If this attribute is not implemented, or contains a null value, the OnOffTransitionTime shall be used instead.

    See

    MatterSpecification.v13.Cluster § 1.6.6.13

  • ReadonlyonLevel: WritableAttribute<null | number, any>

    Indicates the value that the CurrentLevel attribute is set to when the OnOff attribute of an On/Off cluster on the same endpoint is set to TRUE, as a result of processing an On/Off cluster command. If the OnLevel attribute is not implemented, or is set to the null value, it has no effect. For more details see Effect of On/Off Commands on the CurrentLevel Attribute.

    OnLevel represents a mandatory field that was previously not present or optional. Implementers should be aware that older devices may not implement it.

    See

    MatterSpecification.v13.Cluster § 1.6.6.11

  • ReadonlyonOffTransitionTime: OptionalWritableAttribute<number, any>

    Indicates the time taken to move to or from the target level when On or Off commands are received by an On/Off cluster on the same endpoint. It is specified in 1/10ths of a second.

    The actual time taken SHOULD be as close to OnOffTransitionTime as the device is able. Please note that if the device is not able to move at a variable rate, the OnOffTransitionTime attribute SHOULD NOT be implemented.

    See

    MatterSpecification.v13.Cluster § 1.6.6.10

  • ReadonlyonTransitionTime: OptionalWritableAttribute<null | number, any>

    Indicates the time taken to move the current level from the minimum level to the maximum level when an On command is received by an On/Off cluster on the same endpoint. It is specified in 1/10ths of a second. If this attribute is not implemented, or contains a null value, the OnOffTransitionTime shall be used instead.

    See

    MatterSpecification.v13.Cluster § 1.6.6.12

  • Readonlyoptions: WritableAttribute<TypeFromPartialBitSchema<{
        coupleColorTempToLevel: BitFlag;
        executeIfOff: BitFlag;
    }>, any>

    Indicates the selected options of the device.

    The Options attribute is a bitmap that determines the default behavior of some cluster commands. Each command that is dependent on the Options attribute shall first construct a temporary Options bitmap that is in effect during the command processing. The temporary Options bitmap has the same format and meaning as the Options attribute, but includes any bits that may be overridden by command fields.

    This attribute is meant to be changed only during commissioning.

    Command execution shall NOT continue beyond the Options processing if all of these criteria are true:

    • The command is one of the ‘without On/Off’ commands: Move, Move to Level, Step, or Stop.

    • The On/Off cluster exists on the same endpoint as this cluster.

    • The OnOff attribute of the On/Off cluster, on this endpoint, is FALSE.

    • The value of the ExecuteIfOff bit is 0.

    See

    MatterSpecification.v13.Cluster § 1.6.6.9

• Readonlycommands: {
      move: Command<TypeFromFields<{
          moveMode: FieldType<LevelControl.MoveMode>;
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          rate: FieldType<null | number>;
      }>, void, any>;
      moveToLevel: Command<TypeFromFields<{
          level: FieldType<number>;
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          transitionTime: FieldType<null | number>;
      }>, void, any>;
      moveToLevelWithOnOff: Command<TypeFromFields<{
          level: FieldType<number>;
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          transitionTime: FieldType<null | number>;
      }>, void, any>;
      moveWithOnOff: Command<TypeFromFields<{
          moveMode: FieldType<LevelControl.MoveMode>;
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          rate: FieldType<null | number>;
      }>, void, any>;
      step: Command<TypeFromFields<{
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          stepMode: FieldType<LevelControl.StepMode>;
          stepSize: FieldType<number>;
          transitionTime: FieldType<null | number>;
      }>, void, any>;
      stepWithOnOff: Command<TypeFromFields<{
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          stepMode: FieldType<LevelControl.StepMode>;
          stepSize: FieldType<number>;
          transitionTime: FieldType<null | number>;
      }>, void, any>;
      stop: Command<TypeFromFields<{
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
      }>, void, any>;
      stopWithOnOff: Command<TypeFromFields<{
          optionsMask: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
          optionsOverride: FieldType<TypeFromPartialBitSchema<{
              coupleColorTempToLevel: BitFlag;
              executeIfOff: BitFlag;
          }>>;
      }>, void, any>;
  }

  • Readonlymove: Command<TypeFromFields<{
        moveMode: FieldType<LevelControl.MoveMode>;
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        rate: FieldType<null | number>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7.2

  • ReadonlymoveToLevel: Command<TypeFromFields<{
        level: FieldType<number>;
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        transitionTime: FieldType<null | number>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7.1

  • ReadonlymoveToLevelWithOnOff: Command<TypeFromFields<{
        level: FieldType<number>;
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        transitionTime: FieldType<null | number>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7

  • ReadonlymoveWithOnOff: Command<TypeFromFields<{
        moveMode: FieldType<LevelControl.MoveMode>;
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        rate: FieldType<null | number>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7

  • Readonlystep: Command<TypeFromFields<{
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        stepMode: FieldType<LevelControl.StepMode>;
        stepSize: FieldType<number>;
        transitionTime: FieldType<null | number>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7.3

  • ReadonlystepWithOnOff: Command<TypeFromFields<{
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        stepMode: FieldType<LevelControl.StepMode>;
        stepSize: FieldType<number>;
        transitionTime: FieldType<null | number>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7

  • Readonlystop: Command<TypeFromFields<{
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7.4

  • ReadonlystopWithOnOff: Command<TypeFromFields<{
        optionsMask: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
        optionsOverride: FieldType<TypeFromPartialBitSchema<{
            coupleColorTempToLevel: BitFlag;
            executeIfOff: BitFlag;
        }>>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.6.7

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              minLevel: OptionalAttribute<number, any>;
              remainingTime: Attribute<number, any>;
              startUpCurrentLevel: WritableAttribute<null | number, any>;
          };
      };
      flags: {
          lighting: true;
      };
  }, {
      component: {
          attributes: {
              minLevel: OptionalAttribute<number, any>;
          };
      };
      flags: {
          lighting: false;
      };
  }, {
      component: {
          attributes: {
              currentFrequency: Attribute<number, any>;
              maxFrequency: Attribute<number, any>;
              minFrequency: Attribute<number, any>;
          };
          commands: {
              moveToClosestFrequency: Command<TypeFromFields<{
                  frequency: FieldType<number>;
              }>, void, any>;
          };
      };
      flags: {
          frequency: true;
      };
  }]

  This metadata controls which LevelControlCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      frequency: BitFlag;
      lighting: BitFlag;
      onOff: BitFlag;
  }

  • Readonlyfrequency: BitFlag

    Frequency

    NOTE The Frequency feature is provisional.

    See

    MatterSpecification.v13.Cluster § 1.6.4.3

  • Readonlylighting: BitFlag

    Lighting

    This feature supports an interface for controlling the level of a light source. For the CurrentLevel attribute:

    A value of 0x00 shall NOT be used.

    A value of 0x01 shall indicate the minimum level that can be attained on a device. A value of 0xFE shall indicate the maximum level that can be attained on a device. A value of null shall represent an undefined value.

    All other values are application specific gradations from the minimum to the maximum level.

    See

    MatterSpecification.v13.Cluster § 1.6.4.2

  • ReadonlyonOff: BitFlag

    OnOff

    Dependency with the On/Off cluster

• Readonlyid: 28

• Readonlyname: "PulseWidthModulation"

• Readonlyrevision: 5