/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ import { FailsafeContext } from "#common/FailsafeContext.js"; import { FabricManager } from "#fabric/FabricManager.js"; import { SecureChannelProtocol } from "#securechannel/SecureChannelProtocol.js"; import { PaseServer } from "#session/pase/PaseServer.js"; import { SessionManager } from "#session/SessionManager.js"; import { Duration, Environment, Environmental, MaybePromise } from "@matter/general"; import { CommissioningOptions } from "@matter/types"; import { AdministratorCommissioning } from "@matter/types/clusters/administrator-commissioning"; import { DeviceAdvertiser } from "./DeviceAdvertiser.js"; /** * The component allows commissioning configuration to change after the {@link DeviceCommissioner} is initialized. */ export declare abstract class CommissioningConfigProvider { abstract values: CommissioningOptions.Configuration; } /** * Interfaces the {@link DeviceCommissioner} with other components. */ export interface DeviceCommissionerContext { fabrics: FabricManager; sessions: SessionManager; advertiser: DeviceAdvertiser; secureChannelProtocol: SecureChannelProtocol; commissioningConfig: CommissioningConfigProvider; } /** * Implements commissioning for devices. * * Note this implements commissioning for a *local* device; use {@link ControllerCommissioner} to commission a *remote* * device. */ export declare class DeviceCommissioner { #private; constructor(context: DeviceCommissionerContext); static [Environmental.create](env: Environment): DeviceCommissioner; get failsafeContext(): FailsafeContext; /** * Open an Enhanced Commissioning Window. * * With {@link DeviceCommissioner.WindowOptions.byAdministrator} it replaces a window the node opened itself. * * @see {@link MatterSpecification.v161.Core} § 11.19.8.1 */ allowEnhancedCommissioning(discriminator: number, paseServer: PaseServer, options?: DeviceCommissioner.WindowOptions): Promise; /** * Open a Basic Commissioning Window with the node's own passcode. * * With {@link DeviceCommissioner.WindowOptions.byAdministrator} it replaces a window the node opened itself. * Without, it restarts a basic window the node opened itself. * * @see {@link MatterSpecification.v161.Core} § 11.19.8.2 */ allowBasicCommissioning(options?: DeviceCommissioner.WindowOptions): Promise; /** * The status of the commissioning window, whoever opened it. * * @see {@link MatterSpecification.v161.Core} § 11.19.7.1 */ get windowStatus(): AdministratorCommissioning.CommissioningWindowStatus; /** * Whether an Administrator's window is open or waiting to open, as opposed to a window the node opened itself. * * @see {@link MatterSpecification.v161.Core} § 11.19.8.1 */ get isAdministratorWindowOpen(): boolean; beginTimed(failsafeContext: FailsafeContext): void; get isFailsafeArmed(): boolean; assertFailsafeArmed(message?: string): void; /** * Close the open commissioning window, whoever opened it. */ endCommissioning(): Promise; close(): Promise; } export declare namespace DeviceCommissioner { /** * Options for opening a commissioning window. */ interface WindowOptions { /** * How long the window stays open. Defaults to the duration of a window the node opens itself. */ timeout?: Duration; /** * Set when an Administrator opens the window by command. Such a window replaces a window the node opened * itself, and while it is open or waiting to open the Administrator Commissioning cluster answers further opens * with Busy. */ byAdministrator?: boolean; /** * Invoked once the window closes, whatever closes it. It may open or close a window itself. A window the node * restarts takes the options of the restart instead. */ onClose?: () => MaybePromise; } } //# sourceMappingURL=DeviceCommissioner.d.ts.map