From fbcacce0a3f308ff1427466b87585fe52312ef94 Mon Sep 17 00:00:00 2001 From: Denis Kenzior Date: Fri, 9 Nov 2018 13:43:19 -0600 Subject: [PATCH] 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. --- doc/station-api.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/station-api.txt b/doc/station-api.txt index cabc8ce0..0367eaa7 100644 --- a/doc/station-api.txt +++ b/doc/station-api.txt @@ -49,29 +49,29 @@ Methods void Scan() in 100 * dBm. The value is the range of 0 (strongest signal) to -10000 (weakest signal) - array(sns) GetHiddenStations() + array(sns) GetHiddenAccessPoints() [experimental] Returns a list (possibly empty) of detected hidden - stations. The list is sorted according to the - relative signal strength of each station. + access points. The list is sorted according to the + relative signal strength of each access point. Every record returned contains a 3-tuple of the following values. string Address - Station's address + Access Point's address int16 SignalStrength - Station's signal strength expressed in + Access Point's signal strength expressed in 100 * dBm. The value is the range of 0 (strongest signal) to -10000 (weakest signal) string Type - The type of the hidden network. Same values - as Network.Type. + The type of the hidden Access Point. Same + values as Network.Type. void ConnectHiddenNetwork(string ssid)