3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2025-01-05 12:52:37 +01:00
iwd/doc/diagnostics.txt
James Prestwood 2fe20808c2 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.
2021-01-12 13:39:30 -06:00

37 lines
1.1 KiB
Plaintext

Station diagnostic hierarchy [experimental]
============================
Service net.connman.iwd
Interface net.connman.iwd.StationDiagnostic
Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}
Methods dict GetDiagnostics()
Get all diagnostic information for this interface. The
diagnostics are contained in a single dictionary. Values
here are generally low level and not meant for general
purpose applications which could get by with the
existing Station interface or values which are volatile
and change too frequently to be represented as
properties. The values in the dictionary may come and
go depending on the state of IWD.
Below is a list of possible diagnostic dictionary
values:
ConnectedBss - MAC address of currently connected BSS.
RSSI [optional] - The RSSI of the currently connected BSS.
RxRate [optional] - Receive rate in 100kbit/s
RxMCS [optional] - Receiving MCS index
TxRate [optional] - Transmission rate in 100kbit/s
TxMCS [optional] - Transmitting MCS index
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.NotConnected