Interface ScanNetworksRequest

Input to the NetworkCommissioning scanNetworks command

See

MatterSpecification.v13.Core § 11.9.7.1

interface ScanNetworksRequest {
    breadcrumb?: number | bigint;
    ssid?: null | Uint8Array;
}

Hierarchy (view full)

Properties

breadcrumb? ssid?

Properties

Optionalbreadcrumb

breadcrumb?: number | bigint

The Breadcrumb field, if present, shall be used to atomically set the Breadcrumb attribute in the General Commissioning cluster on success of the associated command. If the command fails, the Breadcrumb attribute in the General Commissioning cluster shall be left unchanged.

See

MatterSpecification.v13.Core § 11.9.7.1.2

Optionalssid

ssid?: null | Uint8Array

This field, if present, shall contain the SSID for a directed scan of that particular Wi-Fi SSID. Otherwise, if the field is absent, or if it is null, this shall indicate scanning of all BSSID in range. This field shall be ignored for ScanNetworks invocations on non-Wi-Fi server instances.

See

MatterSpecification.v13.Core § 11.9.7.1.1

Settings

Member Visibility

On This Page

Properties