@project-chip/matter.js 0.3.0 → 0.5.0

package/dist/es/cluster/definitions/SwitchCluster.js

@@ -0,0 +1,351 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseClusterComponent, ClusterComponent, ExtensibleCluster, validateFeatureSelection, extendCluster, preventCluster, AsConditional } from "../../cluster/ClusterFactory.js";
+import { BitFlag, BitFlags } from "../../schema/BitmapSchema.js";
+import { FixedAttribute, Attribute, Event, Cluster as CreateCluster } from "../../cluster/Cluster.js";
+import { TlvUInt8 } from "../../tlv/TlvNumber.js";
+import { TlvObject, TlvField } from "../../tlv/TlvObject.js";
+export var Switch;
+(function (Switch) {
+    /**
+     * Body of the Switch multiPressOngoing event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.6
+     */
+    Switch.TlvMultiPressOngoingEvent = TlvObject({
+        newPosition: TlvField(0, TlvUInt8),
+        currentNumberOfPressesCounted: TlvField(1, TlvUInt8.bound({ min: 2 }))
+    });
+    /**
+     * Body of the Switch multiPressComplete event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.7
+     */
+    Switch.TlvMultiPressCompleteEvent = TlvObject({
+        previousPosition: TlvField(0, TlvUInt8),
+        totalNumberOfPressesCounted: TlvField(1, TlvUInt8.bound({ min: 1 }))
+    });
+    /**
+     * Body of the Switch switchLatched event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.1
+     */
+    Switch.TlvSwitchLatchedEvent = TlvObject({ newPosition: TlvField(0, TlvUInt8) });
+    /**
+     * Body of the Switch initialPress event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.2
+     */
+    Switch.TlvInitialPressEvent = TlvObject({ newPosition: TlvField(0, TlvUInt8) });
+    /**
+     * Body of the Switch longPress event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.3
+     */
+    Switch.TlvLongPressEvent = TlvObject({ newPosition: TlvField(0, TlvUInt8) });
+    /**
+     * Body of the Switch longRelease event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.5
+     */
+    Switch.TlvLongReleaseEvent = TlvObject({ previousPosition: TlvField(0, TlvUInt8) });
+    /**
+     * Body of the Switch shortRelease event
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.4
+     */
+    Switch.TlvShortReleaseEvent = TlvObject({ previousPosition: TlvField(0, TlvUInt8) });
+    /**
+     * These are optional features supported by SwitchCluster.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.4
+     */
+    let Feature;
+    (function (Feature) {
+        /**
+         * LatchingSwitch
+         */
+        Feature["LatchingSwitch"] = "LatchingSwitch";
+        /**
+         * MomentarySwitch
+         */
+        Feature["MomentarySwitch"] = "MomentarySwitch";
+        /**
+         * MomentarySwitchRelease
+         */
+        Feature["MomentarySwitchRelease"] = "MomentarySwitchRelease";
+        /**
+         * MomentarySwitchLongPress
+         */
+        Feature["MomentarySwitchLongPress"] = "MomentarySwitchLongPress";
+        /**
+         * MomentarySwitchMultiPress
+         */
+        Feature["MomentarySwitchMultiPress"] = "MomentarySwitchMultiPress";
+    })(Feature = Switch.Feature || (Switch.Feature = {}));
+    /**
+     * These elements and properties are present in all Switch clusters.
+     */
+    Switch.Base = BaseClusterComponent({
+        id: 0x3b,
+        name: "Switch",
+        revision: 1,
+        features: {
+            /**
+             * LatchingSwitch
+             */
+            latchingSwitch: BitFlag(0),
+            /**
+             * MomentarySwitch
+             */
+            momentarySwitch: BitFlag(1),
+            /**
+             * MomentarySwitchRelease
+             */
+            momentarySwitchRelease: BitFlag(2),
+            /**
+             * MomentarySwitchLongPress
+             */
+            momentarySwitchLongPress: BitFlag(3),
+            /**
+             * MomentarySwitchMultiPress
+             */
+            momentarySwitchMultiPress: BitFlag(4)
+        },
+        attributes: {
+            /**
+             * This attribute shall indicate the maximum number of positions the switch has. Any kind of switch has a
+             * minimum of 2 positions. Also see Section 1.11.10, “NumberOfPositions > 2” for the case
+             * NumberOfPositions>2.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.5.1
+             */
+            numberOfPositions: FixedAttribute(0x0, TlvUInt8.bound({ min: 2 }), { default: 2 }),
+            /**
+             * This attribute shall indicate the position of the switch. The valid range is zero to
+             * NumberOfPositions-1. CurrentPosition value 0 shall be assigned to the default position of the switch:
+             * for example the "open" state of a rocker switch, or the "idle" state of a push button switch.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.5.2
+             */
+            currentPosition: Attribute(0x1, TlvUInt8, { persistent: true, default: 0 })
+        }
+    });
+    /**
+     * A SwitchCluster supports these elements if it supports feature MomentarySwitchMultiPress.
+     */
+    Switch.MomentarySwitchMultiPressComponent = ClusterComponent({
+        attributes: {
+            /**
+             * This attribute shall indicate how many consecutive presses can be detected and reported by a momentary
+             * switch which supports multi-press (e.g. it will report the value 3 if it can detect single press, double
+             * press and triple press, but not quad press and beyond).
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.5.3
+             */
+            multiPressMax: FixedAttribute(0x2, TlvUInt8.bound({ min: 2 }), { default: 2 })
+        },
+        events: {
+            /**
+             * This event shall be generated to indicate how many times the momentary switch has been pressed in a
+             * multi-press sequence, during that sequence. See Section 1.11.9, “Sequence of events for MultiPress”
+             * below.
+             *
+             * The NewPosition field shall indicate the new value of the CurrentPosition attribute, i.e. while pressed.
+             *
+             * The CurrentNumberOfPressesCounted field shall contain:
+             *
+             *   • a value of 2 when the second press of a multi-press sequence has been detected,
+             *
+             *   • a value of 3 when the third press of a multi-press sequence has been detected,
+             *
+             *   • a value of N when the Nth press of a multi-press sequence has been detected.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.6
+             */
+            multiPressOngoing: Event(0x5, 1 /* EventPriority.Info */, Switch.TlvMultiPressOngoingEvent),
+            /**
+             * This event shall be generated to indicate how many times the momentary switch has been pressed in a
+             * multi-press sequence, after it has been detected that the sequence has ended. See Section 1.11.9,
+             * “Sequence of events for MultiPress” below.
+             *
+             * The PreviousPosition field shall indicate the previous value of the CurrentPosition attribute, i.e. just
+             * prior to release.
+             *
+             * The TotalNumberOfPressesCounted field shall contain:
+             *
+             *   • a value of 1 when there was one press in a multi-press sequence (and the sequence has ended),
+             *
+             *     i.e. there was no double press (or more),
+             *
+             *   • a value of 2 when there were exactly two presses in a multi-press sequence (and the sequence has
+             *     ended),
+             *
+             *   • a value of 3 when there were exactly three presses in a multi-press sequence (and the sequence has
+             *     ended),
+             *
+             *   • a value of N when there were exactly N presses in a multi-press sequence (and the sequence has
+             *     ended).
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.7
+             */
+            multiPressComplete: Event(0x6, 1 /* EventPriority.Info */, Switch.TlvMultiPressCompleteEvent)
+        }
+    });
+    /**
+     * A SwitchCluster supports these elements if it supports feature LatchingSwitch.
+     */
+    Switch.LatchingSwitchComponent = ClusterComponent({
+        events: {
+            /**
+             * This event shall be generated, when the latching switch is moved to a new position. It may have been
+             * delayed by debouncing within the switch.
+             *
+             * The NewPosition field shall indicate the new value of the CurrentPosition attribute, i.e. after the move.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.1
+             */
+            switchLatched: Event(0x0, 1 /* EventPriority.Info */, Switch.TlvSwitchLatchedEvent)
+        }
+    });
+    /**
+     * A SwitchCluster supports these elements if it supports feature MomentarySwitch.
+     */
+    Switch.MomentarySwitchComponent = ClusterComponent({
+        events: {
+            /**
+             * This event shall be generated, when the momentary switch starts to be pressed (after debouncing).
+             *
+             * The NewPosition field shall indicate the new value of the CurrentPosition attribute, i.e. while pressed.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.2
+             */
+            initialPress: Event(0x1, 1 /* EventPriority.Info */, Switch.TlvInitialPressEvent)
+        }
+    });
+    /**
+     * A SwitchCluster supports these elements if it supports feature MomentarySwitchLongPress.
+     */
+    Switch.MomentarySwitchLongPressComponent = ClusterComponent({
+        events: {
+            /**
+             * This event shall be generated, when the momentary switch has been pressed for a "long" time (this time
+             * interval is manufacturer determined (e.g. since it depends on the switch physics)).
+             *
+             * The NewPosition field shall indicate the new value of the CurrentPosition attribute, i.e. while pressed.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.3
+             */
+            longPress: Event(0x2, 1 /* EventPriority.Info */, Switch.TlvLongPressEvent),
+            /**
+             * This event shall be generated, when the momentary switch has been released (after debouncing) and after
+             * having been pressed for a long time, i.e. this event shall be generated when the switch is released if a
+             * LongPress event has been generated since since the previous InitialPress event. Also see Section 1.11.8,
+             * “Sequence of generated events”.
+             *
+             * The PreviousPosition field shall indicate the previous value of the CurrentPosition attribute, i.e. just
+             * prior to release.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.5
+             */
+            longRelease: Event(0x4, 1 /* EventPriority.Info */, Switch.TlvLongReleaseEvent)
+        }
+    });
+    /**
+     * A SwitchCluster supports these elements if it supports feature MomentarySwitchRelease.
+     */
+    Switch.MomentarySwitchReleaseComponent = ClusterComponent({
+        events: {
+            /**
+             * This event shall be generated, when the momentary switch has been released (after debouncing).
+             *
+             *   • If the server supports the Momentary Switch LongPress (MSL) feature, this event shall be generated
+             *     when the switch is released if no LongPress event had been generated since the previous InitialPress
+             *     event.
+             *
+             *   • If the server does not support the Momentary Switch LongPress (MSL) feature, this event shall be
+             *     generated when the switch is released - even when the switch was pressed for a long time.
+             *
+             *   • Also see Section 1.11.8, “Sequence of generated events”.
+             *
+             * The PreviousPosition field shall indicate the previous value of the CurrentPosition attribute, i.e. just
+             * prior to release.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11.7.4
+             */
+            shortRelease: Event(0x3, 1 /* EventPriority.Info */, Switch.TlvShortReleaseEvent)
+        }
+    });
+    /**
+     * Switch
+     *
+     * This cluster exposes interactions with a switch device, for the purpose of using those interactions by other
+     * devices.
+     *
+     * Two types of switch devices are supported: latching switch (e.g. rocker switch) and momentary switch (e.g. push
+     * button), distinguished with their feature flags.
+     *
+     * Interactions with the switch device are exposed as attributes (for the latching switch) and as events (for both
+     * types of switches).
+     *
+     * An interested client may subscribe to these attributes/events and thus be informed of the interactions, and can
+     * perform actions based on this, for example by sending commands to perform an action such as controlling a light
+     * or a window shade.
+     *
+     * SwitchCluster supports optional features that you can enable with the SwitchCluster.with() factory method.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 1.11
+     */
+    Switch.Cluster = ExtensibleCluster(Object.assign(Object.assign({}, Switch.Base), { 
+        /**
+         * Use this factory method to create a Switch cluster with support for optional features. Include each
+         * {@link Feature} you wish to support.
+         *
+         * @param features the optional features to support
+         * @returns a Switch cluster with specified features enabled
+         * @throws {IllegalClusterError} if the feature combination is disallowed by the Matter specification
+         */
+        factory: (...features) => {
+            validateFeatureSelection(features, Feature);
+            const cluster = CreateCluster(Object.assign(Object.assign({}, Switch.Base), { supportedFeatures: BitFlags(Switch.Base.features, ...features) }));
+            extendCluster(cluster, Switch.MomentarySwitchMultiPressComponent, { momentarySwitchMultiPress: true });
+            extendCluster(cluster, Switch.LatchingSwitchComponent, { latchingSwitch: true });
+            extendCluster(cluster, Switch.MomentarySwitchComponent, { momentarySwitch: true });
+            extendCluster(cluster, Switch.MomentarySwitchLongPressComponent, { momentarySwitchLongPress: true });
+            extendCluster(cluster, Switch.MomentarySwitchReleaseComponent, { momentarySwitchRelease: true });
+            preventCluster(cluster, { momentarySwitchRelease: true, momentarySwitch: false }, { momentarySwitchLongPress: true, momentarySwitch: false }, { momentarySwitchLongPress: true, momentarySwitchRelease: false }, { momentarySwitchMultiPress: true, momentarySwitch: false }, { momentarySwitchMultiPress: true, momentarySwitchRelease: false }, { latchingSwitch: true, momentarySwitch: true }, { latchingSwitch: false, momentarySwitch: false });
+            return cluster;
+        } }));
+    const MSM = { momentarySwitchMultiPress: true };
+    const LS = { latchingSwitch: true };
+    const MS = { momentarySwitch: true };
+    const MSL = { momentarySwitchLongPress: true };
+    const MSR = { momentarySwitchRelease: true };
+    /**
+     * This cluster supports all Switch features. It may support illegal feature combinations.
+     *
+     * If you use this cluster you must manually specify which features are active and ensure the set of active
+     * features is legal per the Matter specification.
+     */
+    Switch.Complete = CreateCluster({
+        id: Switch.Cluster.id,
+        name: Switch.Cluster.name,
+        revision: Switch.Cluster.revision,
+        features: Switch.Cluster.features,
+        attributes: Object.assign(Object.assign({}, Switch.Cluster.attributes), { multiPressMax: AsConditional(Switch.MomentarySwitchMultiPressComponent.attributes.multiPressMax, { mandatoryIf: [MSM] }) }),
+        events: {
+            switchLatched: AsConditional(Switch.LatchingSwitchComponent.events.switchLatched, { mandatoryIf: [LS] }),
+            initialPress: AsConditional(Switch.MomentarySwitchComponent.events.initialPress, { mandatoryIf: [MS] }),
+            longPress: AsConditional(Switch.MomentarySwitchLongPressComponent.events.longPress, { mandatoryIf: [MSL] }),
+            shortRelease: AsConditional(Switch.MomentarySwitchReleaseComponent.events.shortRelease, { mandatoryIf: [MSR] }),
+            longRelease: AsConditional(Switch.MomentarySwitchLongPressComponent.events.longRelease, { mandatoryIf: [MSL] }),
+            multiPressOngoing: AsConditional(Switch.MomentarySwitchMultiPressComponent.events.multiPressOngoing, { mandatoryIf: [MSM] }),
+            multiPressComplete: AsConditional(Switch.MomentarySwitchMultiPressComponent.events.multiPressComplete, { mandatoryIf: [MSM] })
+        }
+    });
+})(Switch = Switch || (Switch = {}));
+export const SwitchCluster = Switch.Cluster;
+//# sourceMappingURL=SwitchCluster.js.map

package/dist/es/cluster/definitions/SwitchCluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwitchCluster.js","sourceRoot":"","sources":["../../../../src/cluster/definitions/SwitchCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EACH,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACxB,aAAa,EACb,cAAc,EAEd,aAAa,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAA4B,MAAM,8BAA8B,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,KAAK,EAAiB,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACrH,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,KAAW,MAAM,CA0ZtB;AA1ZD,WAAiB,MAAM;IACnB;;;;OAIG;IACU,gCAAyB,GAAG,SAAS,CAAC;QAC/C,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC;QAClC,6BAA6B,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;KACzE,CAAC,CAAC;IAEH;;;;OAIG;IACU,iCAA0B,GAAG,SAAS,CAAC;QAChD,gBAAgB,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC;QACvC,2BAA2B,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;KACvE,CAAC,CAAC;IAEH;;;;OAIG;IACU,4BAAqB,GAAG,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEvF;;;;OAIG;IACU,2BAAoB,GAAG,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEtF;;;;OAIG;IACU,wBAAiB,GAAG,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEnF;;;;OAIG;IACU,0BAAmB,GAAG,SAAS,CAAC,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE1F;;;;OAIG;IACU,2BAAoB,GAAG,SAAS,CAAC,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAE3F;;;;OAIG;IACH,IAAY,OAyBX;IAzBD,WAAY,OAAO;QACf;;WAEG;QACH,4CAAiC,CAAA;QAEjC;;WAEG;QACH,8CAAmC,CAAA;QAEnC;;WAEG;QACH,4DAAiD,CAAA;QAEjD;;WAEG;QACH,gEAAqD,CAAA;QAErD;;WAEG;QACH,kEAAuD,CAAA;IAC3D,CAAC,EAzBW,OAAO,GAAP,cAAO,KAAP,cAAO,QAyBlB;IAED;;OAEG;IACU,WAAI,GAAG,oBAAoB,CAAC;QACrC,EAAE,EAAE,IAAI;QACR,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC;QAEX,QAAQ,EAAE;YACN;;eAEG;YACH,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;YAE1B;;eAEG;YACH,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;YAE3B;;eAEG;YACH,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;YAElC;;eAEG;YACH,wBAAwB,EAAE,OAAO,CAAC,CAAC,CAAC;YAEpC;;eAEG;YACH,yBAAyB,EAAE,OAAO,CAAC,CAAC,CAAC;SACxC;QAED,UAAU,EAAE;YACR;;;;;;eAMG;YACH,iBAAiB,EAAE,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YAElF;;;;;;eAMG;YACH,eAAe,EAAE,SAAS,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;SAC9E;KACJ,CAAC,CAAC;IAEH;;OAEG;IACU,yCAAkC,GAAG,gBAAgB,CAAC;QAC/D,UAAU,EAAE;YACR;;;;;;eAMG;YACH,aAAa,EAAE,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;SACjF;QAED,MAAM,EAAE;YACJ;;;;;;;;;;;;;;;;eAgBG;YACH,iBAAiB,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,yBAAyB,CAAC;YAE5E;;;;;;;;;;;;;;;;;;;;;;;;eAwBG;YACH,kBAAkB,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,0BAA0B,CAAC;SACjF;KACJ,CAAC,CAAC;IAEH;;OAEG;IACU,8BAAuB,GAAG,gBAAgB,CAAC;QACpD,MAAM,EAAE;YACJ;;;;;;;eAOG;YACH,aAAa,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,qBAAqB,CAAC;SACvE;KACJ,CAAC,CAAC;IAEH;;OAEG;IACU,+BAAwB,GAAG,gBAAgB,CAAC;QACrD,MAAM,EAAE;YACJ;;;;;;eAMG;YACH,YAAY,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,oBAAoB,CAAC;SACrE;KACJ,CAAC,CAAC;IAEH;;OAEG;IACU,wCAAiC,GAAG,gBAAgB,CAAC;QAC9D,MAAM,EAAE;YACJ;;;;;;;eAOG;YACH,SAAS,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,iBAAiB,CAAC;YAE5D;;;;;;;;;;eAUG;YACH,WAAW,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,mBAAmB,CAAC;SACnE;KACJ,CAAC,CAAC;IAEH;;OAEG;IACU,sCAA+B,GAAG,gBAAgB,CAAC;QAC5D,MAAM,EAAE;YACJ;;;;;;;;;;;;;;;;eAgBG;YACH,YAAY,EAAE,KAAK,CAAC,GAAG,8BAAsB,OAAA,oBAAoB,CAAC;SACrE;KACJ,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACU,cAAO,GAAG,iBAAiB,iCACjC,OAAA,IAAI;QAEP;;;;;;;WAOG;QACH,OAAO,EAAE,CAA2B,GAAG,QAAgB,EAAE,EAAE;YACvD,wBAAwB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,aAAa,iCAAM,OAAA,IAAI,KAAE,iBAAiB,EAAE,QAAQ,CAAC,OAAA,IAAI,CAAC,QAAQ,EAAE,GAAG,QAAQ,CAAC,IAAG,CAAC;YACpG,aAAa,CAAC,OAAO,EAAE,OAAA,kCAAkC,EAAE,EAAE,yBAAyB,EAAE,IAAI,EAAE,CAAC,CAAC;YAChG,aAAa,CAAC,OAAO,EAAE,OAAA,uBAAuB,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1E,aAAa,CAAC,OAAO,EAAE,OAAA,wBAAwB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5E,aAAa,CAAC,OAAO,EAAE,OAAA,iCAAiC,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9F,aAAa,CAAC,OAAO,EAAE,OAAA,+BAA+B,EAAE,EAAE,sBAAsB,EAAE,IAAI,EAAE,CAAC,CAAC;YAE1F,cAAc,CACV,OAAO,EACP,EAAE,sBAAsB,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,EACxD,EAAE,wBAAwB,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,EAC1D,EAAE,wBAAwB,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,EACjE,EAAE,yBAAyB,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,EAC3D,EAAE,yBAAyB,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,EAClE,EAAE,cAAc,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,EAC/C,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,CACpD,CAAC;YAEF,OAAO,OAAkE,CAAC;QAC9E,CAAC,IACH,CAAC;IAkBH,MAAM,GAAG,GAAG,EAAE,yBAAyB,EAAE,IAAI,EAAE,CAAC;IAChD,MAAM,EAAE,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;IACpC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;IACrC,MAAM,GAAG,GAAG,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;IAC/C,MAAM,GAAG,GAAG,EAAE,sBAAsB,EAAE,IAAI,EAAE,CAAC;IAE7C;;;;;OAKG;IACU,eAAQ,GAAG,aAAa,CAAC;QAClC,EAAE,EAAE,OAAA,OAAO,CAAC,EAAE;QACd,IAAI,EAAE,OAAA,OAAO,CAAC,IAAI;QAClB,QAAQ,EAAE,OAAA,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAA,OAAO,CAAC,QAAQ;QAE1B,UAAU,kCACH,OAAA,OAAO,CAAC,UAAU,KACrB,aAAa,EAAE,aAAa,CACxB,OAAA,kCAAkC,CAAC,UAAU,CAAC,aAAa,EAC3D,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CACzB,GACJ;QAED,MAAM,EAAE;YACJ,aAAa,EAAE,aAAa,CAAC,OAAA,uBAAuB,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;YACjG,YAAY,EAAE,aAAa,CAAC,OAAA,wBAAwB,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;YAChG,SAAS,EAAE,aAAa,CAAC,OAAA,iCAAiC,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YACpG,YAAY,EAAE,aAAa,CAAC,OAAA,+BAA+B,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YACxG,WAAW,EAAE,aAAa,CAAC,OAAA,iCAAiC,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YACxG,iBAAiB,EAAE,aAAa,CAC5B,OAAA,kCAAkC,CAAC,MAAM,CAAC,iBAAiB,EAC3D,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CACzB;YACD,kBAAkB,EAAE,aAAa,CAC7B,OAAA,kCAAkC,CAAC,MAAM,CAAC,kBAAkB,EAC5D,EAAE,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,CACzB;SACJ;KACJ,CAAC,CAAC;AACP,CAAC,EA1ZgB,MAAM,GAAN,MAAM,KAAN,MAAM,QA0ZtB;AAGD,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC"}

package/dist/es/cluster/definitions/TargetNavigatorCluster.d.ts

@@ -0,0 +1,229 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+import { Cluster as CreateCluster, Attribute, OptionalAttribute, Command } from "../../cluster/Cluster.js";
+export declare namespace TargetNavigator {
+    /**
+     * This indicates an object describing the navigable target.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1
+     */
+    const TlvTargetInfoStruct: import("../../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * An unique id within the TargetList.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1.1
+         */
+        identifier: import("../../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * A name string for the TargetInfoStruct.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1.2
+         */
+        name: import("../../tlv/TlvObject.js").FieldType<string>;
+    }>;
+    /**
+     * Input to the TargetNavigator navigateTarget command
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1
+     */
+    const TlvNavigateTargetRequest: import("../../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This shall indicate the Identifier for the target for UX navigation. The Target shall be an Identifier value
+         * contained within one of the TargetInfoStruct objects in the TargetList attribute list.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1.1
+         */
+        target: import("../../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This shall indicate Optional app-specific data.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1.2
+         */
+        data: import("../../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>;
+    /**
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.2
+     */
+    const enum Status {
+        /**
+         * Command succeeded
+         */
+        Success = 0,
+        /**
+         * Requested target was not found in the TargetList
+         */
+        TargetNotFound = 1,
+        /**
+         * Target request is not allowed in current state.
+         */
+        NotAllowed = 2
+    }
+    /**
+     * This command shall be generated in response to NavigateTarget command.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2
+     */
+    const TlvNavigateTargetResponse: import("../../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This shall indicate the of the command.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2.1
+         */
+        status: import("../../tlv/TlvObject.js").FieldType<Status>;
+        /**
+         * This shall indicate Optional app-specific data.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2.2
+         */
+        data: import("../../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>;
+    /**
+     * Target Navigator
+     *
+     * This cluster provides an interface for UX navigation within a set of targets on a device or endpoint.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11
+     */
+    const Cluster: CreateCluster<import("../../schema/BitmapSchema.js").BitSchema, import("../../schema/BitmapSchema.js").TypeFromPartialBitSchema<import("../../schema/BitmapSchema.js").BitSchema>, import("../../util/Type.js").Merge<{
+        /**
+         * The TargetList attribute shall represent a list of targets that can be navigated to within the
+         * experience presented to the user by the Endpoint (Video Player or Content App). The list shall not
+         * contain any entries with the same Identifier in the TargetInfoStruct object.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.3.1
+         */
+        targetList: Attribute<import("../../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * An unique id within the TargetList.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1.1
+             */
+            identifier: import("../../tlv/TlvObject.js").FieldType<number>;
+            /**
+             * A name string for the TargetInfoStruct.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1.2
+             */
+            name: import("../../tlv/TlvObject.js").FieldType<string>;
+        }>[], any>;
+        /**
+         * The CurrentTarget attribute shall represent the Identifier for the target which is currently in
+         * foreground on the corresponding Endpoint (Video Player or Content App), or null to indicate that no
+         * target is in the foreground.
+         *
+         * When not null, the CurrentTarget shall be an Identifier value contained within one of the
+         * TargetInfoStruct objects in the TargetList attribute list.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.3.2
+         */
+        currentTarget: OptionalAttribute<number | null, any>;
+    }, import("../../cluster/Cluster.js").GlobalAttributes<import("../../schema/BitmapSchema.js").BitSchema>>, {
+        /**
+         * Upon receipt, this shall navigation the UX to the target identified.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1
+         */
+        navigateTarget: Command<import("../../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * This shall indicate the Identifier for the target for UX navigation. The Target shall be an Identifier value
+             * contained within one of the TargetInfoStruct objects in the TargetList attribute list.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1.1
+             */
+            target: import("../../tlv/TlvObject.js").FieldType<number>;
+            /**
+             * This shall indicate Optional app-specific data.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1.2
+             */
+            data: import("../../tlv/TlvObject.js").OptionalFieldType<string>;
+        }>, import("../../tlv/TlvObject.js").TypeFromFields<{
+            /**
+             * This shall indicate the of the command.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2.1
+             */
+            status: import("../../tlv/TlvObject.js").FieldType<Status>;
+            /**
+             * This shall indicate Optional app-specific data.
+             *
+             * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2.2
+             */
+            data: import("../../tlv/TlvObject.js").OptionalFieldType<string>;
+        }>, any>;
+    }, {}>;
+}
+export type TargetNavigatorCluster = typeof TargetNavigator.Cluster;
+export declare const TargetNavigatorCluster: CreateCluster<import("../../schema/BitmapSchema.js").BitSchema, import("../../schema/BitmapSchema.js").TypeFromPartialBitSchema<import("../../schema/BitmapSchema.js").BitSchema>, import("../../util/Type.js").Merge<{
+    /**
+     * The TargetList attribute shall represent a list of targets that can be navigated to within the
+     * experience presented to the user by the Endpoint (Video Player or Content App). The list shall not
+     * contain any entries with the same Identifier in the TargetInfoStruct object.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.3.1
+     */
+    targetList: Attribute<import("../../tlv/TlvObject.js").TypeFromFields<{
+        /**
+         * An unique id within the TargetList.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1.1
+         */
+        identifier: import("../../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * A name string for the TargetInfoStruct.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.5.1.2
+         */
+        name: import("../../tlv/TlvObject.js").FieldType<string>;
+    }>[], any>;
+    /**
+     * The CurrentTarget attribute shall represent the Identifier for the target which is currently in
+     * foreground on the corresponding Endpoint (Video Player or Content App), or null to indicate that no
+     * target is in the foreground.
+     *
+     * When not null, the CurrentTarget shall be an Identifier value contained within one of the
+     * TargetInfoStruct objects in the TargetList attribute list.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.3.2
+     */
+    currentTarget: OptionalAttribute<number | null, any>;
+}, import("../../cluster/Cluster.js").GlobalAttributes<import("../../schema/BitmapSchema.js").BitSchema>>, {
+    /**
+     * Upon receipt, this shall navigation the UX to the target identified.
+     *
+     * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1
+     */
+    navigateTarget: Command<import("../../tlv/TlvObject.js").TypeFromFields<{
+        /**
+         * This shall indicate the Identifier for the target for UX navigation. The Target shall be an Identifier value
+         * contained within one of the TargetInfoStruct objects in the TargetList attribute list.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1.1
+         */
+        target: import("../../tlv/TlvObject.js").FieldType<number>;
+        /**
+         * This shall indicate Optional app-specific data.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.1.2
+         */
+        data: import("../../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>, import("../../tlv/TlvObject.js").TypeFromFields<{
+        /**
+         * This shall indicate the of the command.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2.1
+         */
+        status: import("../../tlv/TlvObject.js").FieldType<TargetNavigator.Status>;
+        /**
+         * This shall indicate Optional app-specific data.
+         *
+         * @see {@link MatterApplicationClusterSpecificationV1_1} § 6.11.4.2.2
+         */
+        data: import("../../tlv/TlvObject.js").OptionalFieldType<string>;
+    }>, any>;
+}, {}>;
+//# sourceMappingURL=TargetNavigatorCluster.d.ts.map

package/dist/es/cluster/definitions/TargetNavigatorCluster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TargetNavigatorCluster.d.ts","sourceRoot":"","sources":["../../../../src/cluster/definitions/TargetNavigatorCluster.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,SAAS,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAQ3G,yBAAiB,eAAe,CAAC;IAC7B;;;;OAIG;IACI,MAAM,mBAAmB;QAC5B;;;;WAIG;;QAGH;;;;WAIG;;MAEL,CAAC;IAEH;;;;OAIG;IACI,MAAM,wBAAwB;QACjC;;;;;WAKG;;QAGH;;;;WAIG;;MAEL,CAAC;IAEH;;OAEG;IACH,WAAkB,MAAM;QACpB;;WAEG;QACH,OAAO,IAAI;QAEX;;WAEG;QACH,cAAc,IAAI;QAElB;;WAEG;QACH,UAAU,IAAI;KACjB;IAED;;;;OAIG;IACI,MAAM,yBAAyB;QAClC;;;;WAIG;;QAGH;;;;WAIG;;MAEL,CAAC;IAEH;;;;;;OAMG;IACI,MAAM,OAAO;QAMZ;;;;;;WAMG;;YAjGP;;;;eAIG;;YAGH;;;;eAIG;;;QAyFC;;;;;;;;;WASG;;;QAKH;;;;WAIG;;YAjGP;;;;;eAKG;;YAGH;;;;eAIG;;;YA8BH;;;;eAIG;;YAGH;;;;eAIG;;;UA+CL,CAAC;CACN;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,eAAe,CAAC,OAAO,CAAC;AACpE,eAAO,MAAM,sBAAsB;IAlCvB;;;;;;OAMG;;QAjGP;;;;WAIG;;QAGH;;;;WAIG;;;IAyFC;;;;;;;;;OASG;;;IAKH;;;;OAIG;;QAjGP;;;;;WAKG;;QAGH;;;;WAIG;;;QA8BH;;;;WAIG;;QAGH;;;;WAIG;;;MAmDkD,CAAC"}