Class MdnsScanner

This class implements the Scanner interface for a MDNS scanner via UDP messages in a IP based network. It sends out queries to discover various types of Matter device types and listens for announcements.

Implements

Scanner

Index

Constructors

constructor

new MdnsScanner(multicastServer, enableIpv4?): MdnsScanner
Parameters
- multicastServer: UdpMulticastServer
- OptionalenableIpv4: boolean
Returns MdnsScanner
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:118

Accessors

type

get type(): ChannelType
Returns ChannelType
Implementation of Scanner.type
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:80

Methods

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
- resolvePromise: boolean = true
Returns void
Implementation of Scanner.cancelCommissionableDeviceDiscovery
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:395

cancelOperationalDeviceDiscovery

cancelOperationalDeviceDiscovery(fabric, nodeId, resolvePromise?): void
Parameters
- fabric: Fabric
- nodeId: NodeId
- resolvePromise: boolean = true
Returns void
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:390

close

close(): Promise<void>
Close all connects, end all timers and resolve all pending promises.

Returns Promise<void>
Implementation of Scanner.close
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:664

findCommissionableDevices

findCommissionableDevices(identifier, timeoutSeconds?, ignoreExistingRecords?): Promise<CommissionableDevice[]>
Discovers commissionable devices based on a defined identifier for maximal given timeout, but returns the first found entries. If already a discovered device matches in the cache the response is returned directly and no query is triggered. If no record exists a query is sent out and the promise gets fulfilled as soon as at least one device is found. If no device is discovered in the defined timeframe an empty array is returned. When the promise got fulfilled no more queries are send out, but more device entries might be added when discovered later. These can be requested by the getCommissionableDevices method.
Parameters
- identifier: CommissionableDeviceIdentifiers
- timeoutSeconds: number = 5
- ignoreExistingRecords: boolean = false
Returns Promise<CommissionableDevice[]>
Implementation of Scanner.findCommissionableDevices
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:585

findCommissionableDevicesContinuously

findCommissionableDevicesContinuously(identifier, callback, timeoutSeconds?, cancelSignal?): Promise<CommissionableDevice[]>
Discovers commissionable devices based on a defined identifier and returns the first found entries. If already a
Parameters
- identifier: CommissionableDeviceIdentifiers
- callback: ((device: CommissionableDevice) => void)
  - - (device): void
    - Parameters
      device: CommissionableDevice
      Returns void
- OptionaltimeoutSeconds: number
- OptionalcancelSignal: Promise<void>
Returns Promise<CommissionableDevice[]>
Implementation of Scanner.findCommissionableDevicesContinuously
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:613

findOperationalDevice

findOperationalDevice(__namedParameters, nodeId, timeoutSeconds?, ignoreExistingRecords?): Promise<undefined | OperationalDevice>
Method to find an operational device (already commissioned) and return a promise with the list of discovered IP/ports or an empty array if not found.
Parameters
- __namedParameters: Fabric
- nodeId: NodeId
- OptionaltimeoutSeconds: number
- ignoreExistingRecords: boolean = false
Returns Promise<undefined | OperationalDevice>
Implementation of Scanner.findOperationalDevice
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:360

getDiscoveredCommissionableDevices

getDiscoveredCommissionableDevices(identifier): {
    addresses: ServerAddressIp[];
    CM: number;
    D: number;
    deviceIdentifier: string;
    discoveredAt: number;
    DN?: string;
    DT?: number;
    expires: undefined;
    ICD?: number;
    instanceId: string;
    P?: number;
    PH?: number;
    PI?: string;
    RI?: string;
    SAI?: number;
    SAT?: number;
    SD: number;
    SII?: number;
    T?: number;
    ttl: number;
    V?: number;
    VP?: string;
}[]
Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries.
Parameters
- identifier: CommissionableDeviceIdentifiers
Returns {
    addresses: ServerAddressIp[];
    CM: number;
    D: number;
    deviceIdentifier: string;
    discoveredAt: number;
    DN?: string;
    DT?: number;
    expires: undefined;
    ICD?: number;
    instanceId: string;
    P?: number;
    PH?: number;
    PI?: string;
    RI?: string;
    SAI?: number;
    SAT?: number;
    SD: number;
    SII?: number;
    T?: number;
    ttl: number;
    V?: number;
    VP?: string;
}[]
Implementation of Scanner.getDiscoveredCommissionableDevices
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:657

getDiscoveredOperationalDevice

getDiscoveredOperationalDevice(__namedParameters, nodeId): undefined | OperationalDevice
Return already discovered addresses of an operational paired device and return them. Does not send out new DNS-SD queries.
Parameters
- __namedParameters: Fabric
- nodeId: NodeId
Returns undefined | OperationalDevice
Implementation of Scanner.getDiscoveredOperationalDevice
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:400

`Static`create

create(network, options?): Promise<MdnsScanner>
Parameters
- network: Network
- Optionaloptions: {
  enableIpv4?: boolean;
  netInterface?: string;
  }
  - OptionalenableIpv4?: boolean
  - OptionalnetInterface?: string
Returns Promise<MdnsScanner>
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:84

`Static`deviceAddressDiagnostics

deviceAddressDiagnostics(addresses): (Record<string, unknown> & Diagnostic)[]
Parameters
- addresses: Map<string, MatterServerRecordWithExpire>
Returns (Record<string, unknown> & Diagnostic)[]
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:1064

`Static`discoveryDataDiagnostics

discoveryDataDiagnostics(data): Record<string, unknown> & Diagnostic
Parameters
- data: DiscoveryData
Returns Record<string, unknown> & Diagnostic
- Defined in packages/protocol/src/mdns/MdnsScanner.ts:1048

Class MdnsScanner

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MdnsScanner

Accessors

type

Returns ChannelType

Methods

cancelCommissionableDeviceDiscovery

Parameters

Returns void

cancelOperationalDeviceDiscovery

Parameters

Returns void

close

Returns Promise<void>

findCommissionableDevices

Parameters

Returns Promise<CommissionableDevice[]>

findCommissionableDevicesContinuously

Parameters

Parameters

Returns void

Returns Promise<CommissionableDevice[]>

findOperationalDevice

Parameters

Returns Promise<undefined | OperationalDevice>

getDiscoveredCommissionableDevices

Parameters

getDiscoveredOperationalDevice

Parameters

Returns undefined | OperationalDevice

Staticcreate

Parameters

OptionalenableIpv4?: boolean

OptionalnetInterface?: string

Returns Promise<MdnsScanner>

StaticdeviceAddressDiagnostics

Parameters

Returns (Record<string, unknown> & Diagnostic)[]

StaticdiscoveryDataDiagnostics

Parameters

Returns Record<string, unknown> & Diagnostic

Settings

On This Page

`Static`create

`Optional`enableIpv4?: boolean

`Optional`netInterface?: string

`Static`deviceAddressDiagnostics

`Static`discoveryDataDiagnostics