From 2fe20808c2a7b6e17e52374e8451e332e8fe3ebf Mon Sep 17 00:00:00 2001 From: James Prestwood Date: Tue, 12 Jan 2021 09:17:23 -0800 Subject: [PATCH] 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. --- doc/diagnostics.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/diagnostics.txt b/doc/diagnostics.txt index c6d2aef0..f94ef6f8 100644 --- a/doc/diagnostics.txt +++ b/doc/diagnostics.txt @@ -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