3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-12-22 13:02:44 +01:00

doc: update diagnostics with [optional] tags

Some elements, though unlikely, are not required to be included
with the GET_STATION call that GetDiagnostics relies on. mac80211
based drivers include most of these, but other drivers may not.
To be on the safe side all properties except ConnectedBss are now
optional and may not be included.
This commit is contained in:
James Prestwood 2021-01-12 09:17:23 -08:00 committed by Denis Kenzior
parent 08de8186c6
commit 2fe20808c2

View File

@ -21,15 +21,15 @@ Methods dict GetDiagnostics()
ConnectedBss - MAC address of currently connected BSS.
RSSI - The RSSI of the currently connected BSS.
RSSI [optional] - The RSSI of the currently connected BSS.
RxRate - Receive rate in 100kbit/s
RxRate [optional] - Receive rate in 100kbit/s
RxMCS - Receiving MCS index
RxMCS [optional] - Receiving MCS index
TxRate - Transmission rate in 100kbit/s
TxRate [optional] - Transmission rate in 100kbit/s
TxMCS - Transmitting MCS index
TxMCS [optional] - Transmitting MCS index
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed