Client functionality related to commissioning.

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

Hierarchy (view full)

Constructors

Properties

events: EventEmitter

Access the behavior's events.

state: State

Access the behavior's state.

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.

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.

Events: typeof EventEmitter = EventEmitter

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

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.

Internal: (new () => {}) = EmptyState

Implementation of internal state. Subclasses may override to extend.

schema: DatatypeModel = ...

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

Accessors

Methods

  • 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

  • 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

  • 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>

  • 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