Variable BatteryComponentConst

Type declaration

• Readonlyattributes: {
      activeBatFaults: OptionalAttribute<PowerSource.BatFault[], any>;
      batChargeLevel: Attribute<PowerSource.BatChargeLevel, any>;
      batPercentRemaining: OptionalAttribute<null | number, any>;
      batPresent: OptionalAttribute<boolean, any>;
      batReplaceability: FixedAttribute<PowerSource.BatReplaceability, any>;
      batReplacementNeeded: Attribute<boolean, any>;
      batTimeRemaining: OptionalAttribute<null | number, any>;
      batVoltage: OptionalAttribute<null | number, any>;
  }

  • ReadonlyactiveBatFaults: OptionalAttribute<PowerSource.BatFault[], any>

    Indicates the set of battery faults currently detected by the Node on this power source. This set is represented as a list of BatFaultEnum. When the Node detects a fault has been raised, the appropriate BatFaultEnum value shall be added to this list, provided it is not already present. This list shall NOT contain more than one instance of a specific BatFaultEnum value. When the Node detects all conditions contributing to a fault have been cleared, the corresponding BatFaultEnum value shall be removed from this list. An empty list shall indicate there are currently no active faults. The order of this list SHOULD have no significance. Clients interested in monitoring changes in active faults may subscribe to this attribute, or they may subscribe to BatFaultChange.

    See

    MatterSpecification.v13.Core § 11.7.7.19

  • ReadonlybatChargeLevel: Attribute<PowerSource.BatChargeLevel, any>

    Indicates a coarse ranking of the charge level of the battery, used to indicate when intervention is required as specified in BatChargeLevelEnum.

    See

    MatterSpecification.v13.Core § 11.7.7.15

  • ReadonlybatPercentRemaining: OptionalAttribute<null | number, any>

    Indicates the estimated percentage of battery charge remaining until the battery will no longer be able to provide power to the Node. Values are expressed in half percent units, ranging from 0 to 200. E.g. a value of 48 is equivalent to 24%. A value of NULL shall indicate the Node is currently unable to assess the value.

    See

    MatterSpecification.v13.Core § 11.7.7.13

  • ReadonlybatPresent: OptionalAttribute<boolean, any>

    Indicates whether the Node detects that the batteries are properly installed.

    See

    MatterSpecification.v13.Core § 11.7.7.18

  • ReadonlybatReplaceability: FixedAttribute<PowerSource.BatReplaceability, any>

    Indicates the replaceability of the battery as specified in BatReplaceabilityEnum.

    See

    MatterSpecification.v13.Core § 11.7.7.17

  • ReadonlybatReplacementNeeded: Attribute<boolean, any>

    Indicates if the battery needs to be replaced. Replacement may be simple routine maintenance, such as with a single use, non-rechargeable cell. Replacement, however, may also indicate end of life, or serious fault with a rechargeable or even non-replaceable cell.

    See

    MatterSpecification.v13.Core § 11.7.7.16

  • ReadonlybatTimeRemaining: OptionalAttribute<null | number, any>

    Indicates the estimated time in seconds before the battery will no longer be able to provide power to the Node. A value of NULL shall indicate the Node is currently unable to assess the value.

    See

    MatterSpecification.v13.Core § 11.7.7.14

  • ReadonlybatVoltage: OptionalAttribute<null | number, any>

    Indicates the currently measured output voltage of the battery in mV (millivolts). A value of NULL shall indicate the Node is currently unable to assess the value.

    See

    MatterSpecification.v13.Core § 11.7.7.12

• Readonlyevents: {
      batFaultChange: OptionalEvent<TypeFromFields<{
          current: FieldType<PowerSource.BatFault[]>;
          previous: FieldType<PowerSource.BatFault[]>;
      }>, any>;
  }

  • ReadonlybatFaultChange: OptionalEvent<TypeFromFields<{
        current: FieldType<PowerSource.BatFault[]>;
        previous: FieldType<PowerSource.BatFault[]>;
    }>, any>

    The BatFaultChange Event shall be generated when the set of battery faults currently detected by the Node on this battery power source changes. This event shall correspond to a change in value of ActiveBatFaults.

    See

    MatterSpecification.v13.Core § 11.7.8.2