Class CommissioningServer

Server behavior related to commissioning.

Updates node state based on commissioning status.

Hierarchy (view full)

Constructors

constructor

Properties

events internal state dependencies? early id schema

Accessors

[reference] agent context endpoint env session defaults supervisor

Methods

[asyncDispose] asAdmin callback handleFabricChange initialize initiateCommissioning reactTo toString pairingCodesFor set supports

Constructors

constructor

Properties

events

events: Events

Access the behavior's events.

internal

internal: Internal

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.

Staticearly

early: boolean

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.

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.

Static Readonlyschema

schema: DatatypeModel

Define logical schema to make passcode and discriminator persistent.

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

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](): void

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

    Returns void

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

handleFabricChange

  • handleFabricChange(fabricIndex, fabricAction): void

  • Parameters

    Returns void

initialize

  • initialize(): 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.

    Returns void

initiateCommissioning

  • initiateCommissioning(): void

  • The server invokes this method when the node is active but not yet commissioned unless you set CommissioningServer.State#enabled to false.

    An uncommissioned node is not yet associated with fabrics. It cannot be used until commissioned by a controller.

    The default implementation logs the QR code and credentials.

    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

StaticpairingCodesFor

  • pairingCodesFor(node): {
        manualPairingCode: string;
        qrPairingCode: string;
    }

  • Obtain pairing codes for a node.

    Parameters

    Returns {
        manualPairingCode: string;
        qrPairingCode: string;
    }

    • manualPairingCode: string
    • qrPairingCode: 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