Interface Scanner

type

cancelCommissionableDeviceDiscovery

• cancelCommissionableDeviceDiscovery(identifier, resolvePromise?): void

• Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would be over.

  Parameters

  • identifier: CommissionableDeviceIdentifiers
  • OptionalresolvePromise: boolean

  Returns void

close

• close(): void

• Close the scanner server and free resources.

  Returns void

findCommissionableDevices

• findCommissionableDevices(identifier, timeoutSeconds?, ignoreExistingRecords?): Promise<CommissionableDevice[]>

• Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, vendorId, etc.) and returns as soon as minimum one was found or the timeout is over.

  Parameters

  • identifier: CommissionableDeviceIdentifiers
  • OptionaltimeoutSeconds: number
  • OptionalignoreExistingRecords: boolean

  Returns Promise<CommissionableDevice[]>

findCommissionableDevicesContinuously

• findCommissionableDevicesContinuously(identifier, callback, timeoutSeconds?, cancelSignal?): Promise<CommissionableDevice[]>

• Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is called when it is discovered.

  Parameters

  • identifier: CommissionableDeviceIdentifiers
  • callback: ((device: CommissionableDevice) => void)
    • • (device): void

      • Parameters

        • device: CommissionableDevice

        Returns void

  • OptionaltimeoutSeconds: number
  • OptionalcancelSignal: Promise<void>

  Returns Promise<CommissionableDevice[]>

findOperationalDevice

• findOperationalDevice(fabric, nodeId, timeoutSeconds?, ignoreExistingRecords?): Promise<undefined | OperationalDevice>

• Send DNS-SD queries to discover the current addresses of an operational paired device by its operational ID and return them.

  Parameters

  • fabric: Fabric
  • nodeId: NodeId
  • OptionaltimeoutSeconds: number
  • OptionalignoreExistingRecords: boolean

  Returns Promise<undefined | OperationalDevice>

getDiscoveredCommissionableDevices

• getDiscoveredCommissionableDevices(identifier): CommissionableDevice[]

• Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries.

  Parameters

  • identifier: CommissionableDeviceIdentifiers

  Returns CommissionableDevice[]

getDiscoveredOperationalDevice

• getDiscoveredOperationalDevice(fabric, nodeId): undefined | OperationalDevice

• Return already discovered addresses of an operational paired device and return them. Does not send out new DNS-SD queries.

  Parameters

  • fabric: Fabric
  • nodeId: NodeId

  Returns undefined | OperationalDevice