/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ import { Aspect } from "./Aspect.js"; /** * An operational representation of "other quality" as defined by the Matter specification. * * "Other qualities" are defined behaviors of data fields and cluster elements that do not involve access or * conformance. * * See {@link MatterSpecification.v161.Core} ยง 7.7 */ export declare class Quality extends Aspect implements Quality.Ast { #private; /** * The value may be null. */ nullable?: boolean; /** * An attribute persists across restarts. * * Note that Matter designates any configuration as persistent so matter.js persists writable attributes even * without this flag. */ nonvolatile?: boolean; /** * An attribute never changes unless software revision changes. */ fixed?: boolean; /** * An attribute changes rapidly so subscriptions would not be useful. Not available for subscription. */ changesOmitted?: boolean; /** * An attribute contributes to a scene. */ scene?: boolean; /** * An attribute generates data useful for interval or change reporting. */ reportable?: boolean; /** * A cluster only appears once on a node for a given device type. */ singleton?: boolean; /** * An attribute or event broadcasts a limited number of occurrences for performance reasons. */ quieter?: boolean; /** * A command's input or output may be larger than than an IPv6 MTU of 1280 bytes. */ largeMessage?: boolean; /** * A cluster provides verbose diagnostics and will be omitted from wildcard expansion. */ diagnostics?: boolean; /** * Writes to an attribute are legal only in the context of a transaction. */ atomic?: boolean; /** * Qualities this definition removes. A removal drops the quality from the definition itself and, where the * definition extends another, from what it inherits. */ disallowed?: Quality.AllProperties; /** * Flags the definition states that are not qualities. * * Each also raises an error. A caller that rewrites a definition can carry these through so what it produces * still reports the same problem. */ unrecognized?: readonly string[]; /** * Initialize from a Quality.All definition or a string conforming to the * "other quality" DSL defined in the Matter specification. */ constructor(definition: Quality.Definition); extend(other: Quality): Quality; /** * Display quality using standard Matter syntax. */ toString(): string; } export declare namespace Quality { /** * Various ways to define quality. */ type Definition = Ast | FlagName[] | string | undefined; /** * All qualities designated as "other qualities" in the Matter specification. */ enum Field { nullable = "X", nonvolatile = "N", fixed = "F", scene = "S", reportable = "P", changesOmitted = "C", singleton = "I", quieter = "Q", largeMessage = "L", diagnostics = "K", atomic = "T" } /** * Quality flags and the logical field they map to. */ enum Flag { X = "nullable", N = "nonvolatile", F = "fixed", S = "scene", P = "reportable", C = "changesOmitted", I = "singleton", Q = "quieter", L = "largeMessage", K = "diagnostics", T = "atomic" } /** * Valid "other quality" flags. */ type FlagName = `${Field}`; /** * Runtime version of QualityFlag. */ const FlagNames: FlagName[]; /** * Quality values that apply to data fields. */ type DataField = { /** * Designates a data field as nullable? * * Scope: data field */ nullable?: boolean; }; /** * Quality values that apply to attribute data. */ type AttributeData = DataField & { /** * Designates attribute value persistant across restarts? */ nonvolatile?: boolean; /** * Designates a value as unchanging short of software replacement. */ fixed?: boolean; /** * Designates a fast-changing value for which delta changes are * unavailable. */ changesOmitted?: boolean; /** * Designates data with fluctuating product rate or where some deltas are meaningless or otherwise undesirable * to report. */ quieter?: boolean; /** * Designates attribute as mutable only via atomic write. */ atomic?: boolean; }; /** * Quality values that apply to attributes. */ type Attribute = AttributeData & { /** * Designates an attribute as part of a scene. */ scene?: boolean; /** * Designates best-effort reporting as available for an attribute. */ reportable?: boolean; }; type Command = { /** * Designates commands with payloads that potentially exceed a single IPv6 packet (1280 bytes, the minimum IPv6 * MTU). */ largeMessage?: boolean; }; type Cluster = { /** * Designates a cluster as a singleton on the node for the device type. */ singleton?: boolean; /** * Designates a cluster as a diagnostics cluster. Diagnostics clusters may be omitted from attribute expansion. */ diagnostics?: boolean; }; /** * Quality properties that apply to device types. */ type AllProperties = Attribute & Command & Cluster; /** * Quality values that apply to device types. */ type DeviceType = AllProperties & { /** * Designates qualities the definition removes. */ disallowed?: AllProperties; }; /** * Values for all qualities designated as "other qualities" in the Matter * specification. */ interface Ast extends DeviceType { } } //# sourceMappingURL=Quality.d.ts.map