Class ControllerDiscovery

Index

Constructors

Methods

cancelCommissionableDeviceDiscovery cancelOperationalDeviceDiscovery discoverCommissionableDevices discoverDeviceAddressesByIdentifier discoverOperationalDevice iterateServerAddresses

Constructors

constructor

new ControllerDiscovery(): ControllerDiscovery
Returns ControllerDiscovery

Methods

`Static`cancelCommissionableDeviceDiscovery

cancelCommissionableDeviceDiscovery(scanner, identifier?): void
Parameters
- scanner: Scanner
- identifier: CommissionableDeviceIdentifiers = {}
Returns void
- Defined in packages/protocol/src/peer/ControllerDiscovery.ts:138

`Static`cancelOperationalDeviceDiscovery

cancelOperationalDeviceDiscovery(fabric, peerNodeId, scanner): void
Parameters
- fabric: Fabric
- peerNodeId: NodeId
- scanner: MdnsScanner
Returns void
- Defined in packages/protocol/src/peer/ControllerDiscovery.ts:134

`Static`discoverCommissionableDevices

discoverCommissionableDevices(scanners, timeoutSeconds, identifier?, discoveredCallback?): Promise<CommissionableDevice[]>
Parameters
- scanners: Scanner[]
- timeoutSeconds: number
- identifier: CommissionableDeviceIdentifiers = {}
- OptionaldiscoveredCallback: ((device: CommissionableDevice) => void)
  - - (device): void
    - Parameters
      device: CommissionableDevice
      Returns void
Returns Promise<CommissionableDevice[]>
- Defined in packages/protocol/src/peer/ControllerDiscovery.ts:70

`Static`discoverDeviceAddressesByIdentifier

discoverDeviceAddressesByIdentifier(scanners, identifier, timeoutSeconds?): Promise<CommissionableDevice[]>
Discovers devices by a provided identifier and a list of scanners (e.g. IP and BLE in parallel). It returns after the timeout or if at least one device was found. The method returns a list of addresses of the discovered devices.
Parameters
- scanners: Scanner[]
- identifier: CommissionableDeviceIdentifiers
- timeoutSeconds: number = 30
Returns Promise<CommissionableDevice[]>
- Defined in packages/protocol/src/peer/ControllerDiscovery.ts:38

`Static`discoverOperationalDevice

discoverOperationalDevice(fabric, peerNodeId, scanner, timeoutSeconds?, ignoreExistingRecords?): Promise<OperationalDevice>
Parameters
- fabric: Fabric
- peerNodeId: NodeId
- scanner: MdnsScanner
- OptionaltimeoutSeconds: number
- OptionalignoreExistingRecords: boolean
Returns Promise<OperationalDevice>
- Defined in packages/protocol/src/peer/ControllerDiscovery.ts:113

`Static`iterateServerAddresses

iterateServerAddresses<DD, T, E>(devices, errorType, updateDevicesFunc, func, lastKnownAddress?): Promise<{
    result: T;
    resultAddress: AddressTypeFromDevice<DD>;
    resultDevice?: DD;
}>
Helper method to iterate through a list of server addresses and try to execute a method on each of them. If the method throws a configurable error (or EHOSTUNREACH), the server address list is updated (to also add later discovered addresses or devices) and then next server address is tried.The result of the first successful method call is returned. The logic makes sure to only try each unique address (IP/port) once.
Type Parameters
- DD extends DiscoverableDevice<any>
- T
- E extends Error
Parameters
- devices: DD[]
- errorType: ClassExtends<E>
- updateDevicesFunc: (() => Promise<DD[]>)
  - - (): Promise<DD[]>
    - Returns Promise<DD[]>
- func: ((address: AddressTypeFromDevice<DD>, device?: DD) => Promise<T>)
  - - (address, device?): Promise<T>
    - Parameters
      address: AddressTypeFromDevice<DD>
      Optionaldevice: DD
      Returns Promise<T>
- OptionallastKnownAddress: AddressTypeFromDevice<DD>
Returns Promise<{
    result: T;
    resultAddress: AddressTypeFromDevice<DD>;
    resultDevice?: DD;
}>
- Defined in packages/protocol/src/peer/ControllerDiscovery.ts:148