Kernel
/
iwd
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git
3
0
Fork 0
Code Releases Activity

doc: Tweak GetHiddenStations API 

Station was really a misnomer, it should have been AccessPoint.  Also
mark the API as experimental.  It will be moved to the Diagnostics
interface eventually.
This commit is contained in:
Denis Kenzior 2018-11-09 13:43:19 -06:00
parent 5f8c20f455
commit fbcacce0a3
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/station-api.txt
View File

@ -49,29 +49,29 @@ Methods void Scan()
in 100 * dBm. The value is the range of 0 in 100 * dBm. The value is the range of 0
(strongest signal) to -10000 (weakest signal) (strongest signal) to -10000 (weakest signal)
array(sns) GetHiddenStations() array(sns) GetHiddenAccessPoints() [experimental]
Returns a list (possibly empty) of detected hidden Returns a list (possibly empty) of detected hidden
stations. The list is sorted according to the access points. The list is sorted according to the
relative signal strength of each station. relative signal strength of each access point.
Every record returned contains a 3-tuple of the Every record returned contains a 3-tuple of the
following values. following values.
string Address string Address
Station's address Access Point's address
int16 SignalStrength int16 SignalStrength
Station's signal strength expressed in Access Point's signal strength expressed in
100 * dBm. The value is the range of 0 100 * dBm. The value is the range of 0
(strongest signal) to -10000 (weakest signal) (strongest signal) to -10000 (weakest signal)
string Type string Type
The type of the hidden network. Same values The type of the hidden Access Point. Same
as Network.Type. values as Network.Type.
void ConnectHiddenNetwork(string ssid) void ConnectHiddenNetwork(string ssid)