Class ControllerCommissioner

Class to abstract the Device commission flow in a step wise way as defined in Specs. The specs are not 100%

Index

Constructors

Methods

executeCommissioning getCommissioningStepResult

Constructors

constructor

new ControllerCommissioner(interactionClient, ca, fabric, commissioningOptions, transitionToCase): ControllerCommissioner
Parameters
- interactionClient: InteractionClient
  InteractionClient for the initiated PASE session
- ca: RootCertificateManager
  CertificateManager of the controller.
- fabric: Fabric
  Fabric of the controller.
- commissioningOptions: CommissioningOptions
  Commissioning options for the commissioning process.
- transitionToCase: ((peerAddress: PeerAddress) => Promise<undefined | InteractionClient>)
  Callback that establishes CASE connection or handles final commissioning
  - - (peerAddress): Promise<undefined | InteractionClient>
    - Parameters
      peerAddress: PeerAddress
      Returns Promise<undefined | InteractionClient>
Returns ControllerCommissioner
- Defined in packages/protocol/dist/esm/peer/ControllerCommissioningFlow.d.ts:67

Methods

executeCommissioning

executeCommissioning(): Promise<void>
Execute the commissioning process in the defined order. The steps are sorted before execution based on the step number and sub step number. If >50% of the failsafe time has passed, the failsafe timer is re-armed (50% of 60s default are 30s and each action is allowed to take 30s at minimum based on specs).

Returns Promise<void>
- Defined in packages/protocol/dist/esm/peer/ControllerCommissioningFlow.d.ts:84

getCommissioningStepResult

getCommissioningStepResult(stepNumber, subStepNumber): undefined | CommissioningStepResult
Parameters
- stepNumber: number
- subStepNumber: number
Returns undefined | CommissioningStepResult
- Defined in packages/protocol/dist/esm/peer/ControllerCommissioningFlow.d.ts:85