Class CommissioningClient

Client functionality related to commissioning.

Updates node state based on commissioning status and commissions new nodes.

Hierarchy (view full)

Constructors

constructor

Properties

events state dependencies? early Events id Internal schema

Accessors

[reference] agent context descriptor endpoint env session defaults supervisor

Methods

[asyncDispose] asAdmin callback commission finalizeCommissioning initialize reactTo toString set supports

Constructors

constructor

Properties

Readonlyevents

events: EventEmitter

Access the behavior's events.

state

state: State

Access the behavior's state.

Static Optionaldependencies

dependencies?: Iterable<Type, any, any>

Explicitly reference other Behaviors as dependencies, ensuring this behavior is destroyed first.

This probably won't be commonly necessary. If it is we can instrument Agent to collect dependencies automatically.

Static Readonlyearly

early = true

By default behaviors load lazily as they are accessed. You can set this flag to true to force behaviors to load immediately when the endpoint initializes.

StaticEvents

Events: typeof EventEmitter

Implementation of the events property. Subclasses may override to extend.

Static Readonlyid

id = "commissioning"

Each behavior implementation has an ID that uniquely identifies the type of behavior. An Endpoint may only have one behavior with the specified ID.

Endpoint instances store each behavior in a property with the same name as the behavior's ID.

EndpointBuilder also uses the ID when replacing behaviors using the with() builder method.

StaticInternal

Internal: (new () => {})

Implementation of internal state. Subclasses may override to extend.

Type declaration

    • new (): {}

    • Implementation of internal state. Subclasses may override to extend.

      Returns {}

    Static Readonlyschema

    schema: DatatypeModel

    Define logical schema. This enables runtime validation, make fields persistent and makes subfields editable.

    Accessors

    [reference]

    • get [reference](): Datasource<StateType>

    • Returns Datasource<StateType>

    agent

    • get agent(): Agent

    • The agent that owns the behavior.

      Returns Agent

    context

    • get context(): ActionContext

    • The context in which the behavior operates.

      Returns ActionContext

    descriptor

    • get descriptor(): undefined | RemoteDescriptor

    • Returns undefined | RemoteDescriptor

    • set descriptor(descriptor): void

    • Parameters

      • descriptor: undefined | RemoteDescriptor

      Returns void

    endpoint

    • get endpoint(): Endpoint<Empty>

    • The endpoint that owns behavior's agent.

      Returns Endpoint<Empty>

    env

    • get env(): Environment

    • The endpoint's environment.

      Returns Environment

    session

    • get session(): SecureSession

    • The session in which the behavior has been invoked.

      Returns SecureSession

    Staticdefaults

    • get defaults(): Record<string, any>

    • Default state values.

      Returns Record<string, any>

    Staticsupervisor

    • get supervisor(): RootSupervisor

    • The data supervisor for the behavior. The supervisor controls validation and access to behavior data.

      Returns RootSupervisor

    Methods

    [asyncDispose]

    • [asyncDispose](): MaybePromise

    • Release resources. This is the public API for releasing application resources held by behaviors in internal state.

      Returns MaybePromise

    asAdmin

    • asAdmin(fn): void

    • Execute logic with elevated privileges.

      The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

      Elevated logic effectively ignores ACLs so should be used with care.

      Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.

      Parameters

      • fn: (() => void)

        the elevated logic

          • (): void

          • Returns void

      Returns void

    Protectedcallback

    • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

    • Create a generic callback function that has the same properties as a Reactor.

      Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      • A extends any[]
      • R

      Parameters

      Returns ((...args: A) => undefined | R)

        • (...args): undefined | R

        • Parameters

          • Rest...args: A

          Returns undefined | R

    commission

    • commission(passcode): Promise<ClientNode>

    • Parameters

      • passcode: number

      Returns Promise<ClientNode>

    • commission(options): Promise<ClientNode>

    • Parameters

      Returns Promise<ClientNode>

    ProtectedfinalizeCommissioning

    • finalizeCommissioning(_address, _discoveryData?): Promise<void>

    • Override to implement CASE commissioning yourself.

      If you override, matter.js commissions to the point where over PASE is complete. You must then complete commissioning yourself by connecting to the device and invokeint the "CommissioningComplete" command.

      Parameters

      Returns Promise<void>

    initialize

    • initialize(options): void

    • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

      This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

      Parameters

      • options: {
            descriptor?: RemoteDescriptor;
        }
        • Optionaldescriptor?: RemoteDescriptor

      Returns void

    ProtectedreactTo

    • reactTo<O>(observable, reactor, options?): void

    • Install a Reactor.

      Important: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      Parameters

      Returns void

    toString

    • toString(): string

    • Description used in diagnostic messages.

      Returns string

    Staticset

    • set<This>(this, defaults): This

    • Create a new behavior with different default state values.

      Type Parameters

      Parameters

      Returns This

    Staticsupports

    • supports(other): boolean

    • Does this behavior support functionality of a specific implementation?

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods