Class CommissioningController

Controller class to commission and connect multiple nodes into one fabric.

Hierarchy (view full)

MatterNode
- CommissioningController

Constructors

constructor

new CommissioningController(options): CommissioningController
Creates a new CommissioningController instance
Parameters
- options: CommissioningControllerOptions
  The options for the CommissioningController
Returns CommissioningController
Overrides MatterNode.constructor
- Defined in packages/matter.js/src/CommissioningController.ts:147

Accessors

nodeId

get nodeId(): undefined | NodeId
Returns undefined | NodeId
- Defined in packages/matter.js/src/CommissioningController.ts:151

paseCommissionerConfig

get paseCommissionerConfig(): {
caConfig: Configuration;
fabricData: Config;
}
Returns {
caConfig: Configuration;
fabricData: Config;
}
- caConfig: Configuration
- fabricData: Config
- Defined in packages/matter.js/src/CommissioningController.ts:155

Methods

assertControllerIsStarted

assertControllerIsStarted(errorText?): MatterController
Parameters
- OptionalerrorText: string
Returns MatterController
- Defined in packages/matter.js/src/CommissioningController.ts:176

assertIsAddedToMatterServer

assertIsAddedToMatterServer(): {
    environment: undefined | Environment;
    mdnsScanner: MdnsScanner;
    storage: undefined | StorageContext<any>;
}
Returns {
    environment: undefined | Environment;
    mdnsScanner: MdnsScanner;
    storage: undefined | StorageContext<any>;
}
- environment: undefined | Environment
- mdnsScanner: MdnsScanner
- storage: undefined | StorageContext<any>
- Defined in packages/matter.js/src/CommissioningController.ts:166

cancelCommissionableDeviceDiscovery

cancelCommissionableDeviceDiscovery(identifierData, discoveryCapabilities?): void
Parameters
- identifierData: CommissionableDeviceIdentifiers
- OptionaldiscoveryCapabilities: TypeFromPartialBitSchema<{
  ble: BitFlag;
  onIpNetwork: BitFlag;
  }>
Returns void
- Defined in packages/matter.js/src/CommissioningController.ts:519

close

close(): Promise<void>
Disconnects all connected nodes and Closes the network connections and other resources of the controller.

Returns Promise<void>
Overrides MatterNode.close
- Defined in packages/matter.js/src/CommissioningController.ts:447

collectStoredAttributeData

collectStoredAttributeData(nodeId): Promise<DecodedAttributeReportValue<any>[]>
Parameters
- nodeId: NodeId
Returns Promise<DecodedAttributeReportValue<any>[]>
- Defined in packages/matter.js/src/CommissioningController.ts:348

commissionNode

commissionNode(nodeOptions, connectNodeAfterCommissioning?): Promise<NodeId>
Commissions/Pairs a new device into the controller fabric. The method returns the NodeId of the commissioned node.
Parameters
- nodeOptions: NodeCommissioningOptions
- connectNodeAfterCommissioning: boolean = true
Returns Promise<NodeId>
- Defined in packages/matter.js/src/CommissioningController.ts:236

completeCommissioningForNode

completeCommissioningForNode(peerNodeId, discoveryData?): Promise<void>
Completes the commissioning process for a node when the initial commissioning process was done by a PASE commissioner. This method should be called to discover the device operational and complete the commissioning process.
Parameters
- peerNodeId: NodeId
- OptionaldiscoveryData: DiscoveryData
Returns Promise<void>
- Defined in packages/matter.js/src/CommissioningController.ts:262

connect

connect(connectOptions?): Promise<PairedNode[]>
Connects to all paired nodes. After connection the endpoint data of the device is analyzed and an object structure is created.
Parameters
- OptionalconnectOptions: CommissioningControllerNodeOptions
Returns Promise<PairedNode[]>
- Defined in packages/matter.js/src/CommissioningController.ts:362

connectNode

connectNode(nodeId, connectOptions?): Promise<PairedNode>
Connect to an already paired Node. After connection the endpoint data of the device is analyzed and an object structure is created.
Parameters
- nodeId: NodeId
- OptionalconnectOptions: CommissioningControllerNodeOptions
Returns Promise<PairedNode>
- Defined in packages/matter.js/src/CommissioningController.ts:314

createInteractionClient

createInteractionClient(nodeId, discoveryType?, forcedConnection?): Promise<InteractionClient>
Creates and Return a new InteractionClient to communicate with a node. This is mainly used internally and should not be used directly. See the PairedNode class for the public API.
Parameters
- nodeId: NodeId
- OptionaldiscoveryType: NodeDiscoveryType
- forcedConnection: boolean = true
Returns Promise<InteractionClient>
- Defined in packages/matter.js/src/CommissioningController.ts:416

disconnectNode

disconnectNode(nodeId): Promise<void>
Parameters
- nodeId: NodeId
Returns Promise<void>
- Defined in packages/matter.js/src/CommissioningController.ts:302

discoverCommissionableDevices

discoverCommissionableDevices(identifierData, discoveryCapabilities?, discoveredCallback?, timeoutSeconds?): Promise<CommissionableDevice[]>
Parameters
- identifierData: CommissionableDeviceIdentifiers
- OptionaldiscoveryCapabilities: TypeFromPartialBitSchema<{
  ble: BitFlag;
  onIpNetwork: BitFlag;
  }>
- OptionaldiscoveredCallback: ((device: CommissionableDevice) => void)
  - - (device): void
    - Parameters
      device: CommissionableDevice
      Returns void
- timeoutSeconds: number = 900
Returns Promise<CommissionableDevice[]>
- Defined in packages/matter.js/src/CommissioningController.ts:530

getActiveSessionInformation

getActiveSessionInformation(): {
    fabric: undefined | ExposedFabricInformation;
    isPeerActive: boolean;
    lastActiveTimestamp: undefined | number;
    lastInteractionTimestamp: undefined | number;
    name: string;
    nodeId: NodeId;
    numberOfActiveSubscriptions: number;
    peerNodeId: NodeId;
    secure: boolean;
}[]
Returns active session information for all connected nodes.

Returns {
    fabric: undefined | ExposedFabricInformation;
    isPeerActive: boolean;
    lastActiveTimestamp: undefined | number;
    lastInteractionTimestamp: undefined | number;
    name: string;
    nodeId: NodeId;
    numberOfActiveSubscriptions: number;
    peerNodeId: NodeId;
    secure: boolean;
}[]
- Defined in packages/matter.js/src/CommissioningController.ts:562

getCommissionedNodes

getCommissionedNodes(): NodeId[]
Returns an array with the Node Ids for all commissioned nodes.

Returns NodeId[]
- Defined in packages/matter.js/src/CommissioningController.ts:434

getCommissionedNodesDetails

getCommissionedNodesDetails(): {
    advertisedName: undefined | string;
    deviceData: undefined | DeviceInformationData;
    discoveryData: undefined | DiscoveryData;
    nodeId: NodeId;
    operationalAddress: undefined | string;
}[]
Returns {
    advertisedName: undefined | string;
    deviceData: undefined | DeviceInformationData;
    discoveryData: undefined | DiscoveryData;
    nodeId: NodeId;
    operationalAddress: undefined | string;
}[]
- Defined in packages/matter.js/src/CommissioningController.ts:440

getPairedNode

getPairedNode(nodeId): undefined | PairedNode
Returns the PairedNode instance for a given node id, if this node is connected.
Parameters
- nodeId: NodeId
Returns undefined | PairedNode
- Defined in packages/matter.js/src/CommissioningController.ts:429

getPort

getPort(): undefined | number
Returns undefined | number
Overrides MatterNode.getPort
- Defined in packages/matter.js/src/CommissioningController.ts:458

initialize

initialize(ipv4Disabled): void
Parameters
- ipv4Disabled: boolean
Returns void
Overrides MatterNode.initialize
- Defined in packages/matter.js/src/CommissioningController.ts:462

initializeControllerStore

initializeControllerStore(): Promise<void>
Returns Promise<void>
- Defined in packages/matter.js/src/CommissioningController.ts:474

isCommissioned

isCommissioned(): boolean
Returns true if t least one node is commissioned/paired with this controller instance.

Returns boolean
- Defined in packages/matter.js/src/CommissioningController.ts:406

isNodeCommissioned

isNodeCommissioned(nodeId): boolean
Check if a given node id is commissioned on this controller.
Parameters
- nodeId: NodeId
Returns boolean
- Defined in packages/matter.js/src/CommissioningController.ts:269

removeNode

removeNode(nodeId, tryDecommissioning?): Promise<void>
Remove a Node id from the controller. This method should only be used if the decommission method on the PairedNode instance returns an error. By default, it tries to decommission the node from the controller but will remove it also in case of an error during decommissioning. Ideally try to decommission the node before and only use this in case of an error.
Parameters
- nodeId: NodeId
- tryDecommissioning: boolean = true
Returns Promise<void>
- Defined in packages/matter.js/src/CommissioningController.ts:280

resetStorage

resetStorage(): Promise<void>
Returns Promise<void>
- Defined in packages/matter.js/src/CommissioningController.ts:546

setMdnsBroadcaster

setMdnsBroadcaster(mdnsBroadcaster): void
Set the MDNS Broadcaster instance. Should be only used internally
Parameters
- mdnsBroadcaster: MdnsBroadcaster
  MdnsBroadcaster instance
Returns void
Overrides MatterNode.setMdnsBroadcaster
- Defined in packages/matter.js/src/CommissioningController.ts:391

setMdnsScanner

setMdnsScanner(mdnsScanner): void
Set the MDNS Scanner instance. Should be only used internally
Parameters
- mdnsScanner: MdnsScanner
  MdnsScanner instance
Returns void
Overrides MatterNode.setMdnsScanner
- Defined in packages/matter.js/src/CommissioningController.ts:382

setStorage

setStorage(storage): void
Set the Storage instance. Should be only used internally
Parameters
- storage: StorageContext<SyncStorage>
  storage context to use
Returns void
- Defined in packages/matter.js/src/CommissioningController.ts:400

start

start(): Promise<void>
Initialize the controller and connect to all commissioned nodes if autoConnect is not set to false.

Returns Promise<void>
Overrides MatterNode.start
- Defined in packages/matter.js/src/CommissioningController.ts:486

Class CommissioningController

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CommissioningController

Accessors

nodeId

Returns undefined | NodeId

paseCommissionerConfig

Returns { caConfig: Configuration; fabricData: Config; }

caConfig: Configuration

fabricData: Config

Methods

assertControllerIsStarted

Parameters

Returns MatterController

assertIsAddedToMatterServer

Returns { environment: undefined | Environment; mdnsScanner: MdnsScanner; storage: undefined | StorageContext<any>; }

environment: undefined | Environment

mdnsScanner: MdnsScanner

storage: undefined | StorageContext<any>

cancelCommissionableDeviceDiscovery

Parameters

Returns void

close

Returns Promise<void>

collectStoredAttributeData

Parameters

Returns Promise<DecodedAttributeReportValue<any>[]>

commissionNode

Parameters

Returns Promise<NodeId>

completeCommissioningForNode

Parameters

Returns Promise<void>

connect

Parameters

Returns Promise<PairedNode[]>

connectNode

Parameters

Returns Promise<PairedNode>

createInteractionClient

Parameters

Returns Promise<InteractionClient>

disconnectNode

Parameters

Returns Promise<void>

discoverCommissionableDevices

Parameters

Parameters

Returns void

Returns Promise<CommissionableDevice[]>

getActiveSessionInformation

Returns { fabric: undefined | ExposedFabricInformation; isPeerActive: boolean; lastActiveTimestamp: undefined | number; lastInteractionTimestamp: undefined | number; name: string; nodeId: NodeId; numberOfActiveSubscriptions: number; peerNodeId: NodeId; secure: boolean; }[]

getCommissionedNodes

Returns NodeId[]

getCommissionedNodesDetails

Returns { advertisedName: undefined | string; deviceData: undefined | DeviceInformationData; discoveryData: undefined | DiscoveryData; nodeId: NodeId; operationalAddress: undefined | string; }[]

getPairedNode

Parameters

Returns undefined | PairedNode

getPort

Returns undefined | number

initialize

Parameters

Returns void

initializeControllerStore

Returns Promise<void>

isCommissioned

Returns boolean

isNodeCommissioned

Parameters

Returns boolean

removeNode

Parameters

Returns {
caConfig: Configuration;
fabricData: Config;
}

Returns {
environment: undefined | Environment;
mdnsScanner: MdnsScanner;
storage: undefined | StorageContext<any>;
}

Returns {
fabric: undefined | ExposedFabricInformation;
isPeerActive: boolean;
lastActiveTimestamp: undefined | number;
lastInteractionTimestamp: undefined | number;
name: string;
nodeId: NodeId;
numberOfActiveSubscriptions: number;
peerNodeId: NodeId;
secure: boolean;
}[]

Returns {
advertisedName: undefined | string;
deviceData: undefined | DeviceInformationData;
discoveryData: undefined | DiscoveryData;
nodeId: NodeId;
operationalAddress: undefined | string;
}[]