Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      configStatus: Attribute<TypeFromPartialBitSchema, any>;
      endProductType: FixedAttribute<WindowCovering.EndProductType, any>;
      mode: WritableAttribute<TypeFromPartialBitSchema, any>;
      operationalStatus: Attribute<TypeFromPartialBitSchema, any>;
      safetyStatus: OptionalAttribute<TypeFromPartialBitSchema, any>;
      type: FixedAttribute<WindowCovering.WindowCoveringType, any>;
  }

  • ReadonlyconfigStatus: Attribute<TypeFromPartialBitSchema, any>

    This attribute specifies the configuration and status information of the window covering.

    To change settings, devices shall write to the Mode attribute. The behavior causing the setting or clearing of each bit is vendor specific.

    See

    MatterSpecification.v13.Cluster § 5.3.6.9

  • ReadonlyendProductType: FixedAttribute<WindowCovering.EndProductType, any>

    This attribute SHOULD provide more detail about the product type than can be determined from the main category indicated by the Type attribute.

    The table below helps to match the EndProductType attribute with the Type attribute.

    See

    MatterSpecification.v13.Cluster § 5.3.6.17

  • Readonlymode: WritableAttribute<TypeFromPartialBitSchema, any>

    The Mode attribute allows configuration of the window covering, such as: reversing the motor direction, placing the window covering into calibration mode, placing the motor into maintenance mode, disabling the network, and disabling status LEDs.

    In the case a device does not support or implement a specific mode, e.g. the device has a specific installation method and reversal is not relevant or the device does not include a maintenance mode, any write interaction to the Mode attribute, with an unsupported mode bit or any out of bounds bits set, must be ignored and a response containing the status of CONSTRAINT_ERROR will be returned.

    See

    MatterSpecification.v13.Cluster § 5.3.6.22

  • ReadonlyoperationalStatus: Attribute<TypeFromPartialBitSchema, any>

    Indicates the currently ongoing operations and applies to all type of devices.

    See

    MatterSpecification.v13.Cluster § 5.3.6.16

  • ReadonlysafetyStatus: OptionalAttribute<TypeFromPartialBitSchema, any>

    The SafetyStatus attribute reflects the state of the safety sensors and the common issues preventing movements. By default for nominal operation all flags are cleared (0). A device might support none, one or several bit flags from this attribute (all optional).

    See

    MatterSpecification.v13.Cluster § 5.3.6.23

  • Readonlytype: FixedAttribute<WindowCovering.WindowCoveringType, any>

    This attribute shall identify the type of window covering.

    See

    MatterSpecification.v13.Cluster § 5.3.6.2

• Readonlycommands: {
      downOrClose: Command<void, void, any>;
      stopMotion: Command<void, void, any>;
      upOrOpen: Command<void, void, any>;
  }

  • ReadonlydownOrClose: Command<void, void, any>

    Upon receipt of this command, the window covering will adjust its position so the physical lift/slide and tilt is at the maximum closed/down position. This will happen as fast as possible. The server attributes supported shall be updated as follows:

    if the PositionAware feature is supported:

    • TargetPositionLiftPercent100ths attribute shall be set to 100.00%.

    • TargetPositionTiltPercent100ths attribute shall be set to 100.00%.

    The server positioning attributes will follow the movements, once the movement has successfully finished, the server attributes shall be updated as follows:

    if the PositionAware feature is supported:

    • CurrentPositionLiftPercent100ths attribute shall be 100.00%.

    • CurrentPositionLiftPercentage attribute shall be 100%.

    • CurrentPositionTiltPercent100ths attribute shall be 100.00%.

    • CurrentPositionTiltPercentage attribute shall be 100%. if the AbsolutePosition feature is supported:

    • CurrentPositionLift attribute shall be equal to the InstalledClosedLimitLift attribute.

    • CurrentPositionTilt attribute shall be equal to the InstalledClosedLimitTilt attribute.

    See

    MatterSpecification.v13.Cluster § 5.3.7.2

  • ReadonlystopMotion: Command<void, void, any>

    Upon receipt of this command, the window covering will stop any adjusting to the physical tilt and lift/slide that is currently occurring. The server attributes supported shall be updated as follows:

    • TargetPositionLiftPercent100ths attribute will be set to CurrentPositionLiftPercent100ths attribute value.

    • TargetPositionTiltPercent100ths attribute will be set to CurrentPositionTiltPercent100ths attribute value.

    See

    MatterSpecification.v13.Cluster § 5.3.7.3

  • ReadonlyupOrOpen: Command<void, void, any>

    Upon receipt of this command, the window covering will adjust its position so the physical lift/slide and tilt is at the maximum open/up position. This will happen as fast as possible. The server attributes shall be updated as follows:

    if the PositionAware feature is supported:

    • TargetPositionLiftPercent100ths attribute shall be set to 0.00%.

    • TargetPositionTiltPercent100ths attribute shall be set to 0.00%.

    The server positioning attributes will follow the movements, once the movement has successfully finished, the server attributes shall be updated as follows:

    if the PositionAware feature is supported:

    • CurrentPositionLiftPercent100ths attribute shall be 0.00%.

    • CurrentPositionLiftPercentage attribute shall be 0%.

    • CurrentPositionTiltPercent100ths attribute shall be 0.00%.

    • CurrentPositionTiltPercentage attribute shall be 0%. if the AbsolutePosition feature is supported:

    • CurrentPositionLift attribute shall be equal to the InstalledOpenLimitLift attribute.

    • CurrentPositionTilt attribute shall be equal to the InstalledOpenLimitTilt attribute.

    See

    MatterSpecification.v13.Cluster § 5.3.7.1

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              currentPositionLift: OptionalAttribute<number | null, any>;
              installedClosedLimitLift: Attribute<number, any>;
              installedOpenLimitLift: Attribute<number, any>;
              physicalClosedLimitLift: OptionalFixedAttribute<number, any>;
          };
      };
      flags: {
          absolutePosition: true;
          lift: true;
          positionAwareLift: true;
      };
  }, {
      component: {
          attributes: {
              currentPositionTilt: OptionalAttribute<number | null, any>;
              installedClosedLimitTilt: Attribute<number, any>;
              installedOpenLimitTilt: Attribute<number, any>;
              physicalClosedLimitTilt: OptionalFixedAttribute<number, any>;
          };
      };
      flags: {
          absolutePosition: true;
          positionAwareTilt: true;
          tilt: true;
      };
  }, {
      component: {
          attributes: {
              numberOfActuationsLift: OptionalAttribute<number, any>;
          };
          commands: {
              goToLiftPercentage: OptionalCommand<TypeFromFields, void, any>;
          };
      };
      flags: {
          lift: true;
      };
  }, {
      component: {
          attributes: {
              numberOfActuationsTilt: OptionalAttribute<number, any>;
          };
          commands: {
              goToTiltPercentage: OptionalCommand<TypeFromFields, void, any>;
          };
      };
      flags: {
          tilt: true;
      };
  }, {
      component: {
          attributes: {
              currentPositionLiftPercent100ths: Attribute<number | null, any>;
              currentPositionLiftPercentage: OptionalAttribute<number | null, any>;
              targetPositionLiftPercent100ths: Attribute<number | null, any>;
          };
          commands: {
              goToLiftPercentage: Command<TypeFromFields, void, any>;
          };
      };
      flags: {
          lift: true;
          positionAwareLift: true;
      };
  }, {
      component: {
          attributes: {
              currentPositionTiltPercent100ths: Attribute<number | null, any>;
              currentPositionTiltPercentage: OptionalAttribute<number | null, any>;
              targetPositionTiltPercent100ths: Attribute<number | null, any>;
          };
          commands: {
              goToTiltPercentage: Command<TypeFromFields, void, any>;
          };
      };
      flags: {
          positionAwareTilt: true;
          tilt: true;
      };
  }, {
      component: {
          commands: {
              goToLiftValue: OptionalCommand<TypeFromFields, void, any>;
          };
      };
      flags: {
          absolutePosition: true;
          lift: true;
      };
  }, {
      component: {
          commands: {
              goToTiltValue: OptionalCommand<TypeFromFields, void, any>;
          };
      };
      flags: {
          absolutePosition: true;
          tilt: true;
      };
  }, {
      component: false;
      flags: {
          lift: false;
          positionAwareLift: true;
      };
  }, {
      component: false;
      flags: {
          positionAwareTilt: true;
          tilt: false;
      };
  }, {
      component: false;
      flags: {
          lift: false;
          tilt: false;
      };
  }]

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

• Readonlyfeatures: {
      absolutePosition: BitFlag;
      lift: BitFlag;
      positionAwareLift: BitFlag;
      positionAwareTilt: BitFlag;
      tilt: BitFlag;
  }

  • ReadonlyabsolutePosition: BitFlag

    AbsolutePosition

    The percentage attributes shall indicate the position as a percentage between the InstalledOpenLimits and InstalledClosedLimits attributes of the window covering starting at the open (0.00%).

    As a general rule, absolute positioning (in centimeters or tenth of a degrees) SHOULD NOT be supported for new implementations.

    See

    MatterSpecification.v13.Cluster § 5.3.4.4

  • Readonlylift: BitFlag

    Lift

    The Lift feature applies to window coverings that lift up and down (e.g. for a roller shade, Up and Down is lift Open and Close) or slide left to right (e.g. for a sliding curtain, Left and Right is lift Open and Close).

    See

    MatterSpecification.v13.Cluster § 5.3.4.1

  • ReadonlypositionAwareLift: BitFlag

    PositionAwareLift

    Position aware lift control is supported.

  • ReadonlypositionAwareTilt: BitFlag

    PositionAwareTilt

    Position aware tilt control is supported.

  • Readonlytilt: BitFlag

    Tilt

    The Tilt feature applies to window coverings with vertical or horizontal strips.

    See

    MatterSpecification.v13.Cluster § 5.3.4.2

• Readonlyid: 258

• Readonlyname: "WindowCovering"

• Readonlyrevision: 5