OptionalbreadcrumbSee Section 11.9.7.1.2, “Breadcrumb Field” for usage.
Effect when received
If the Networks attribute does not contain a matching entry, the command shall immediately respond with NetworkConfigResponse having NetworkingStatus status field set to NetworkIdNotFound.
If the NetworkIndex field has a value larger or equal to the current number of entries in the Networks attribute, the command shall immediately respond with NetworkConfigResponse having NetworkingStatus status field set to OutOfRange.
On success, the NetworkConfigResponse command shall have its NetworkIndex field set to the 0- based index of the entry in the Networks attribute that was just updated, matching the incoming NetworkIndex, and a NetworkingStatus status field set to Success.
The entry selected shall be inserted at the new position in the list. All other entries, if any exist, shall be moved to allow the insertion, in a way that they all retain their existing relative order between each other, with the exception of the newly re-ordered entry.
Re-ordering to the same NetworkIndex as the current location shall be considered as a success and yield no visible changes of the Networks attribute.
Examples of re-ordering
To better illustrate the re-ordering operation, consider this initial state, exemplary of a Wi-Fi device:
On receiving ReorderNetwork with:
• NetworkId = Home-Guest
• NetworkIndex = 0
The outcome, after applying to the initial state would be:
In the above outcome, FancyCat and BlueDolphin moved "down" and Home-Guest became the highest priority network in the list.
On receiving ReorderNetwork with:
• NetworkId = FancyCat
• NetworkIndex = 3
The outcome, after applying to the initial state would be:
In the above outcome, BlueDolphin, Home-Guest and WillowTree moved "up" and FancyCat became the lowest priority network in the list.
This field shall contain the NetworkID for the entry to reorder: the SSID for Wi-Fi and XPAN ID for Thread.
This field shall contain the 0-based index of the new desired position of the entry in the Networks attribute.
Input to the NetworkCommissioning reorderNetwork command
See
MatterSpecification.v13.Core § 11.9.7.10