/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ import type { Advertisement } from "#advertisement/Advertisement.js"; import { PairingHintBitmapSchema } from "#advertisement/PairingHintBitmap.js"; import { ServiceDescription } from "#advertisement/ServiceDescription.js"; import { DEFAULT_PAIRING_HINT, getCommissionableDeviceQname, getCommissioningModeQname, getDeviceTypeQname, getLongDiscriminatorQname, getShortDiscriminatorQname, getVendorQname, MATTER_COMMISSION_SERVICE_QNAME, PAIRING_HINTS_REQUIRING_INSTRUCTION, SERVICE_DISCOVERY_QNAME, } from "#mdns/MdnsConsts.js"; import { ImplementationError, PtrRecord } from "@matter/general"; import { MdnsAdvertisement } from "./MdnsAdvertisement.js"; import type { MdnsAdvertiser } from "./MdnsAdvertiser.js"; /** * Advertise a node as commissionable. */ export class CommissionableMdnsAdvertisement extends MdnsAdvertisement { instanceId: string; constructor(advertiser: MdnsAdvertiser, description: ServiceDescription.Commissionable) { const instanceId = advertiser.createInstanceId(); const qname = getCommissionableDeviceQname(instanceId); super(advertiser, qname, description); this.instanceId = instanceId; this.#validatePairingInstructions(); } override get ptrRecords() { const { discriminator, deviceType, vendorId } = this.description; const shortDiscriminator = (discriminator >> 8) & 0x0f; const vendorQname = getVendorQname(vendorId); const deviceTypeQname = getDeviceTypeQname(deviceType); const shortDiscriminatorQname = getShortDiscriminatorQname(shortDiscriminator); const longDiscriminatorQname = getLongDiscriminatorQname(discriminator); const commissionModeQname = getCommissioningModeQname(); const records = [ PtrRecord(SERVICE_DISCOVERY_QNAME, MATTER_COMMISSION_SERVICE_QNAME), PtrRecord(SERVICE_DISCOVERY_QNAME, deviceTypeQname), PtrRecord(SERVICE_DISCOVERY_QNAME, shortDiscriminatorQname), PtrRecord(SERVICE_DISCOVERY_QNAME, longDiscriminatorQname), PtrRecord(SERVICE_DISCOVERY_QNAME, commissionModeQname), PtrRecord(MATTER_COMMISSION_SERVICE_QNAME, this.qname), PtrRecord(deviceTypeQname, this.qname), PtrRecord(shortDiscriminatorQname, this.qname), PtrRecord(longDiscriminatorQname, this.qname), PtrRecord(commissionModeQname, this.qname), ]; if (!this.isPrivacyMasked) { records.push(PtrRecord(SERVICE_DISCOVERY_QNAME, vendorQname), PtrRecord(vendorQname, this.qname)); } return records; } override get txtValues() { const { vendorId, productId, deviceType, name, discriminator, mode, pairingHint = DEFAULT_PAIRING_HINT, pairingInstructions, } = this.description; const values: Record = { DN: name /* Device Name */, DT: deviceType /* Device Type */, D: discriminator /* Discriminator */, CM: mode /* Commission Mode */, PH: PairingHintBitmapSchema.encode(pairingHint) /* Pairing Hint */, PI: pairingInstructions /* Pairing Instruction */, }; if (!this.isPrivacyMasked) { values.VP = `${vendorId}+${productId}`; /* Vendor / Product */ } return values; } override isDuplicate(other: Advertisement) { // Only one commissioning advertisement allowed per advertiser return other.service === this.service && other.isCommissioning(); } #validatePairingInstructions() { const { pairingHint, pairingInstructions } = this.description; if (pairingHint) { if (Object.values(pairingHint).every(v => !v)) { throw new ImplementationError("At least one pairing hint must be set if pairing hint is provided"); } const needsInstructionsCount = PAIRING_HINTS_REQUIRING_INSTRUCTION.reduce( (count, hint) => (pairingHint[hint] === true ? count + 1 : count), 0, ); if (needsInstructionsCount > 1) { throw new ImplementationError( `Only one pairing hint requiring instructions can be set, but got ${needsInstructionsCount}`, ); } else if (needsInstructionsCount === 1 && !pairingInstructions) { throw new ImplementationError( `Pairing instructions are required when a pairing hint requiring instructions is set`, ); } else if (needsInstructionsCount === 0 && pairingInstructions) { throw new ImplementationError( `Pairing instructions provided but no pairing hint requiring instructions set`, ); } } else if (pairingInstructions) { throw new ImplementationError("Pairing instructions provided but no pairing hint set"); } } }