struct
Matter::Cluster::Definitions::NetworkCommissioning::ScanAvailableNetworksRequest
Overview
Input to the NetworkCommissioning scanNetworks command
Included Modules
- TLV::Serializable
Defined in:
matter/cluster/definitions/network_commissioning.crConstructors
Instance Method Summary
-
#breadcrumb : UInt64 | Nil
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.
-
#breadcrumb=(breadcrumb : UInt64 | Nil)
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.
-
#ssid : Slice(UInt8) | Nil
This field, if present, shall contain the SSID for a directed scan of that particular Wi-Fi SSID.
-
#ssid=(ssid : Slice(UInt8) | Nil)
This field, if present, shall contain the SSID for a directed scan of that particular Wi-Fi SSID.
Constructor Detail
Instance Method Detail
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.
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.
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 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.
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 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.