@matter/protocol 0.16.0-alpha.0-20251217-038f88085 → 0.16.0-alpha.0-20251221-21acf226d

package/src/interaction/InteractionMessenger.ts

@@ -18,19 +18,13 @@ import {
     Time,
     UnexpectedDataError,
 } from "#general";
-import { DecodedAttributeReportValue } from "#interaction/AttributeDataDecoder.js";
-import { DecodedDataReport } from "#interaction/DecodedDataReport.js";
 import { Specification } from "#model";
 import { RetransmissionLimitReachedError, SessionClosedError, UnexpectedMessageError } from "#protocol/errors.js";
 import {
-    AttributeId,
-    ClusterId,
-    EndpointNumber,
     ReceivedStatusResponseError,
     Status,
     StatusResponseError,
     TlvAny,
-    TlvAttributeReport,
     TlvDataReport,
     TlvDataReportForSend,
     TlvDataVersionFilter,
@@ -825,162 +819,6 @@ export class IncomingInteractionClientMessenger extends InteractionMessenger {
         return message;
     }
 
-    /**
-     * Reads data report stream and aggregates them into a single report.
-     * Additionally, a callback can be provided that is called for each cluster chunk received.
-     */
-    async readAggregateDataReport(
-        chunkListener?: (chunk: DecodedAttributeReportValue<any>[]) => Promise<void>,
-        expectedSubscriptionIds?: number[],
-    ): Promise<DecodedDataReport> {
-        let result: DecodedDataReport | undefined = undefined;
-        let currentEndpointId: EndpointNumber | undefined = undefined;
-        let currentClusterId: ClusterId | undefined = undefined;
-        const currentClusterChunk = new Array<DecodedAttributeReportValue<any>>();
-        let pendingAttributeReports: TypeFromSchema<typeof TlvAttributeReport>[] | undefined = undefined;
-
-        const handleAttributeReportEntries = (
-            attributeReports: TypeFromSchema<typeof TlvAttributeReport>[] | undefined,
-            previousPendingAttributeReports: TypeFromSchema<typeof TlvAttributeReport>[] | undefined,
-        ) => {
-            if (previousPendingAttributeReports?.length) {
-                attributeReports = attributeReports ?? [];
-                attributeReports.unshift(...previousPendingAttributeReports);
-            }
-
-            let lastAttributeDataIndex = -1;
-            if (attributeReports?.length) {
-                let lastEndpointId: EndpointNumber | undefined = undefined;
-                let lastClusterId: ClusterId | undefined = undefined;
-                let lastAttributeId: AttributeId | undefined = undefined;
-                for (let i = attributeReports.length - 1; i >= 0; i--) {
-                    const attributeReport = attributeReports[i];
-                    if (attributeReport.attributeData === undefined) {
-                        break; // No data report, so nothing more to search for
-                    }
-                    const {
-                        path: { endpointId, clusterId, attributeId },
-                    } = attributeReport.attributeData;
-                    if (lastEndpointId === undefined && lastClusterId === undefined && lastAttributeId === undefined) {
-                        // Remember path of the last attribute data entry and check if previous entries match
-                        lastEndpointId = endpointId;
-                        lastClusterId = clusterId;
-                        lastAttributeId = attributeId;
-                    }
-                    if (
-                        endpointId === lastEndpointId &&
-                        clusterId === lastClusterId &&
-                        attributeId === lastAttributeId
-                    ) {
-                        lastAttributeDataIndex = i;
-                        continue;
-                    }
-                    break; // We found an attribute that does not match the last one, so we are done
-                }
-
-                if (lastAttributeDataIndex > 0) {
-                    return attributeReports.splice(lastAttributeDataIndex);
-                }
-            }
-        };
-
-        const processDecodedReport = async (
-            decodedReport: DecodedDataReport,
-            result: DecodedDataReport | undefined,
-        ) => {
-            if (!result) {
-                result = decodedReport;
-            } else {
-                if (!result.attributeReports) {
-                    result.attributeReports = decodedReport.attributeReports;
-                } else {
-                    result.attributeReports.push(...decodedReport.attributeReports);
-                }
-                if (Array.isArray(decodedReport.eventReports)) {
-                    if (!result.eventReports) {
-                        result.eventReports = decodedReport.eventReports;
-                    } else {
-                        result.eventReports.push(...decodedReport.eventReports);
-                    }
-                }
-            }
-
-            if (chunkListener !== undefined && decodedReport.attributeReports) {
-                for (const data of decodedReport.attributeReports) {
-                    const {
-                        path: { endpointId, clusterId },
-                    } = data;
-                    if (currentEndpointId !== endpointId || currentClusterId !== clusterId) {
-                        // We switched the cluster, so we need to send the current chunk first
-                        if (currentClusterChunk.length > 0) {
-                            await chunkListener(currentClusterChunk);
-                            currentClusterChunk.length = 0;
-                        }
-                        currentEndpointId = endpointId;
-                        currentClusterId = clusterId;
-                    }
-                    currentClusterChunk.push(data);
-                }
-            }
-            return result;
-        };
-
-        for await (const report of this.readDataReports()) {
-            if (expectedSubscriptionIds !== undefined) {
-                if (report.subscriptionId === undefined || !expectedSubscriptionIds.includes(report.subscriptionId)) {
-                    await this.sendStatus(Status.InvalidSubscription, {
-                        multipleMessageInteraction: true,
-                        logContext: Subscription.diagnosticOf(report),
-                    });
-                    throw new UnexpectedDataError(
-                        report.subscriptionId === undefined
-                            ? "Invalid Data report without Subscription ID"
-                            : `Invalid Data report with unexpected subscription ID ${Subscription.idStrOf(report)}`,
-                    );
-                }
-            }
-
-            if (result?.subscriptionId !== undefined && report.subscriptionId !== result.subscriptionId) {
-                throw new UnexpectedDataError(`Invalid subscription ID ${Subscription.idStrOf(report)} received`);
-            }
-
-            report.attributeReports = report.attributeReports ?? [];
-            pendingAttributeReports = handleAttributeReportEntries(report.attributeReports, pendingAttributeReports);
-
-            result = await processDecodedReport(DecodedDataReport(report), result);
-        }
-
-        if (pendingAttributeReports?.length && result !== undefined) {
-            result = await processDecodedReport(
-                DecodedDataReport({
-                    interactionModelRevision: result.interactionModelRevision,
-                    attributeReports: pendingAttributeReports,
-                }),
-                result,
-            );
-        }
-
-        if (chunkListener !== undefined && currentClusterChunk.length > 0) {
-            await chunkListener(currentClusterChunk);
-            currentClusterChunk.length = 0;
-        }
-
-        if (result === undefined) {
-            // readDataReports should have thrown
-            throw new InternalError("No data reports loaded during read");
-        }
-
-        return result;
-    }
-
-    /**
-     * Read a single data report.
-     */
-    async readDataReport() {
-        const dataReportMessage = await this.waitFor("DataReport", MessageType.ReportData);
-        return TlvDataReport.decode(dataReportMessage.payload);
-    }
-
     /**
      * Read data reports as they come in on the wire.
      *
@@ -988,7 +826,8 @@ export class IncomingInteractionClientMessenger extends InteractionMessenger {
      */
     async *readDataReports() {
         while (true) {
-            const report = await this.readDataReport();
+            const dataReportMessage = await this.waitFor("DataReport", MessageType.ReportData);
+            const report = TlvDataReport.decode(dataReportMessage.payload);
 
             yield report;
 
@@ -1133,29 +972,6 @@ export class InteractionClientMessenger extends IncomingInteractionClientMesseng
         await this.send(MessageType.SubscribeRequest, request);
     }
 
-    async readAggregateSubscribeResponse(chunkListener?: (chunk: DecodedAttributeReportValue<any>[]) => Promise<void>) {
-        const report = await this.readAggregateDataReport(chunkListener);
-        const { subscriptionId } = report;
-
-        if (subscriptionId === undefined) {
-            throw new UnexpectedDataError(`Subscription ID not provided in report`);
-        }
-
-        const subscribeResponseMessage = await this.nextMessage(MessageType.SubscribeResponse);
-        const subscribeResponse = TlvSubscribeResponse.decode(subscribeResponseMessage.payload);
-
-        if (subscribeResponse.subscriptionId !== subscriptionId) {
-            throw new MatterFlowError(
-                `Received subscription ID ${Subscription.idStrOf(subscribeResponse.subscriptionId)} instead of ${Subscription.idStrOf(subscriptionId)}`,
-            );
-        }
-
-        return {
-            subscribeResponse,
-            report,
-        };
-    }
-
     async sendInvokeCommand(invokeRequest: InvokeRequest, expectedProcessingTime?: Duration) {
         if (invokeRequest.suppressResponse) {
             await this.requestWithSuppressedResponse(

package/src/interaction/index.ts

@@ -11,4 +11,3 @@ export * from "./EventDataDecoder.js";
 export * from "./FabricAccessControl.js";
 export * from "./InteractionMessenger.js";
 export * from "./Subscription.js";
-export * from "./SubscriptionClient.js";

package/src/mdns/MdnsClient.ts

@@ -6,7 +6,6 @@
 
 import {
     BasicSet,
-    Bytes,
     ChannelType,
     Diagnostic,
     DnsMessageType,
@@ -36,7 +35,7 @@ import {
     isIPv6,
 } from "#general";
 import { PeerAddress } from "#peer/PeerAddress.js";
-import { NodeId, VendorId } from "#types";
+import { GlobalFabricId, NodeId, VendorId } from "#types";
 import {
     CommissionableDevice,
     CommissionableDeviceIdentifiers,
@@ -114,7 +113,7 @@ export interface MdnsScannerTargetCriteria {
 
     /** List of operational targets. */
     operationalTargets: {
-        operationalId: Bytes;
+        fabricId: GlobalFabricId;
         nodeId?: NodeId;
     }[];
 }
@@ -209,12 +208,13 @@ export class MdnsClient implements Scanner {
         for (const criteria of this.#targetCriteriaProviders) {
             const { operationalTargets, commissionable } = criteria;
             cacheCommissionableDevices = cacheCommissionableDevices || commissionable;
-            for (const { operationalId, nodeId } of operationalTargets) {
-                const operationalIdString = Bytes.toHex(operationalId).toUpperCase();
+            for (const { fabricId, nodeId } of operationalTargets) {
                 if (nodeId === undefined) {
-                    this.#operationalScanTargets.add(operationalIdString);
+                    this.#operationalScanTargets.add(GlobalFabricId.strOf(fabricId));
                 } else {
-                    this.#operationalScanTargets.add(`${operationalIdString}-${NodeId.toHexString(nodeId)}`);
+                    this.#operationalScanTargets.add(
+                        `${GlobalFabricId.strOf(fabricId)}-${NodeId.strOf(nodeId)}`.toUpperCase(),
+                    );
                 }
             }
         }
@@ -494,11 +494,6 @@ export class MdnsClient implements Scanner {
         return this.#recordWaiters.has(queryId);
     }
 
-    #createOperationalMatterQName(operationalId: Bytes, nodeId: NodeId) {
-        const operationalIdString = Bytes.toHex(operationalId).toUpperCase();
-        return getOperationalDeviceQname(operationalIdString, NodeId.toHexString(nodeId));
-    }
-
     /**
      * Method to find an operational device (already commissioned) and return a promise with the list of discovered
      * IP/ports or an empty array if not found.
@@ -512,7 +507,7 @@ export class MdnsClient implements Scanner {
         if (this.#closing) {
             throw new ImplementationError("Cannot discover operational device because scanner is closing.");
         }
-        const deviceMatterQname = this.#createOperationalMatterQName(fabric.operationalId, nodeId);
+        const deviceMatterQname = getOperationalDeviceQname(fabric.globalId, nodeId);
 
         let storedDevice = ignoreExistingRecords ? undefined : this.#getOperationalDeviceRecords(deviceMatterQname);
         if (storedDevice === undefined) {
@@ -538,7 +533,7 @@ export class MdnsClient implements Scanner {
     }
 
     cancelOperationalDeviceDiscovery(fabric: Fabric, nodeId: NodeId, resolvePromise = true) {
-        const deviceMatterQname = this.#createOperationalMatterQName(fabric.operationalId, nodeId);
+        const deviceMatterQname = getOperationalDeviceQname(fabric.globalId, nodeId);
         this.#finishWaiter(deviceMatterQname, resolvePromise);
     }
 
@@ -550,8 +545,8 @@ export class MdnsClient implements Scanner {
         this.#finishWaiter(queryId, resolvePromise);
     }
 
-    getDiscoveredOperationalDevice({ operationalId }: Fabric, nodeId: NodeId) {
-        return this.#getOperationalDeviceRecords(this.#createOperationalMatterQName(operationalId, nodeId));
+    getDiscoveredOperationalDevice({ globalId }: Fabric, nodeId: NodeId) {
+        return this.#getOperationalDeviceRecords(getOperationalDeviceQname(globalId, nodeId));
     }
 
     /**
@@ -1576,9 +1571,9 @@ export class MdnsClient implements Scanner {
     static discoveryDataDiagnostics(data: DiscoveryData, kind?: string) {
         return Diagnostic.dict({
             kind,
-            SII: Duration.format(data.SII),
-            SAI: Duration.format(data.SAI),
-            SAT: Duration.format(data.SAT),
+            SII: data.SII !== undefined ? Duration.format(data.SII) : undefined,
+            SAI: data.SAI !== undefined ? Duration.format(data.SAI) : undefined,
+            SAT: data.SAT !== undefined ? Duration.format(data.SAT) : undefined,
             T: data.T,
             DT: data.DT,
             PH: data.PH,

package/src/mdns/MdnsConsts.ts

@@ -5,7 +5,7 @@
  */
 
 import { PairingHintBitmap } from "#advertisement/PairingHintBitmap.js";
-import { VendorId } from "#types";
+import { GlobalFabricId, NodeId, VendorId } from "#types";
 
 export const MDNS_BROADCAST_IPV4 = "224.0.0.251";
 export const MDNS_BROADCAST_IPV6 = "ff02::fb";
@@ -35,9 +35,10 @@ export const PAIRING_HINTS_REQUIRING_INSTRUCTION = Array<keyof typeof PairingHin
     "pressSetupButtonNumberOfTimes",
 );
 
-export const getFabricQname = (operationalIdString: string) => `_I${operationalIdString}._sub.${MATTER_SERVICE_QNAME}`;
-export const getOperationalDeviceQname = (operationalIdString: string, nodeIdString: string) =>
-    `${operationalIdString}-${nodeIdString}.${MATTER_SERVICE_QNAME}`;
+export const getFabricQname = (fabric: GlobalFabricId) =>
+    `_I${GlobalFabricId.strOf(fabric).toUpperCase()}._sub.${MATTER_SERVICE_QNAME}`;
+export const getOperationalDeviceQname = (fabric: GlobalFabricId, node: NodeId) =>
+    `${GlobalFabricId.strOf(fabric).toUpperCase()}-${NodeId.strOf(node).toUpperCase()}.${MATTER_SERVICE_QNAME}`;
 export const getVendorQname = (vendorId: VendorId) => `_V${vendorId}._sub.${MATTER_COMMISSION_SERVICE_QNAME}`;
 export const getDeviceTypeQname = (deviceType: number) => `_T${deviceType}._sub.${MATTER_COMMISSION_SERVICE_QNAME}`;
 export const getShortDiscriminatorQname = (shortDiscriminator: number) =>

package/src/{dcl → ota}/OtaImageReader.ts

@@ -12,13 +12,10 @@ import {
     HashAlgorithm,
     HashFipsAlgorithmId,
     InternalError,
-    Logger,
     MatterError,
 } from "#general";
 import { OtaImageHeader, TlvOtaImageHeader } from "./OtaImageHeader.js";
 
-const logger = Logger.get("OtaImageReader");
-
 export class OtaImageError extends MatterError {
     constructor(message: string, options?: ErrorOptions) {
         super(message, options);
@@ -132,7 +129,7 @@ export class OtaImageReader {
                 allHeaderBytes.push(value);
             }
 
-            // We still need to get the header, so initialize or append to data reader
+            // We still need to get the header, so initialize or append to the data reader
             if (headerReader !== undefined) {
                 headerReader = new DataReader(Bytes.concat(headerReader.remainingBytes, value), Endian.Little);
             } else {
@@ -161,7 +158,6 @@ export class OtaImageReader {
                 headerReader.remainingBytesCount >= this.#headerSize
             ) {
                 const data = headerReader.readByteArray(this.#headerSize);
-                logger.debug(`OTA Header read, size=${this.#headerSize} bytes`, data);
                 this.#headerData = TlvOtaImageHeader.decode(data);
                 const remainingBytes = headerReader.remainingBytes;
 

package/src/{dcl → ota}/OtaImageWriter.ts

@@ -26,7 +26,7 @@ export interface OtaImageWriterResult {
  * including file identifier, header encoding, and payload digest computation.
  *
  * The class can be used to convert raw firmware payloads into OTA image files suitable for distribution.
- * It does not use streaming approach, so it requires the entire payload to be available in memory what is ok for now.
+ * It does not use a streaming approach, so it requires the entire payload to be available in memory what is ok for now.
  */
 export class OtaImageWriter {
     /**

package/src/ota/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from "./OtaImageHeader.js";
+export * from "./OtaImageReader.js";
+export * from "./OtaImageWriter.js";

package/src/peer/ControllerCommissioner.ts

@@ -459,6 +459,12 @@ export class ControllerCommissioner {
             Commissionee SHALL exit Commissioning Mode after 20 failed attempts.
          */
 
+        // The pase session has actual negotiated parameters from the device. Use them over the discoveryData
+        discoveryData = discoveryData ?? {};
+        discoveryData.SII = paseSession.parameters.idleInterval;
+        discoveryData.SAI = paseSession.parameters.activeInterval;
+        discoveryData.SAT = paseSession.parameters.activeThreshold;
+
         const address = this.#determineAddress(fabric, commissioningOptions.nodeId);
         logger.info(
             `Start commissioning of node ${address.nodeId} into fabric ${fabric.fabricId} (index ${address.fabricIndex})`,
@@ -515,6 +521,7 @@ export class ControllerCommissioner {
             await this.#context.peers.get(address)?.delete();
             throw error;
         } finally {
+            commissioningManager.close();
             /*
                 In concurrent connection commissioning flow the commissioning channel SHALL terminate after
                 successful step 15 (CommissioningComplete command invocation).