Skip to contentSkip to conversation

doc: Fix SignalLevelAgent interface name and filename pointers

PATCH Applied Andrew Zaborowski 2 participants 2 messages Oct 14, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v2 2/2 doc: Fix SignalLevelAgent interface name and filename pointers

When the SignalLevelAgent doc blurb was moved to station-api.txt it seems the interface was changed to Station.SignalLevelAgent in some places but not in most and not in the code. Also fix the pointers to the doc file.

---
 doc/p2p-api.txt     |  4 ++--
 doc/station-api.txt | 31 ++++++++++++++-----------------
 2 files changed, 16 insertions(+), 19 deletions(-)
doc/p2p-api.txt +2 -2
index 08ee8d92..b10c51ed 100644
@@ -47,8 +47,8 @@ Methods		array(on) GetPeers()
 
 			Register the agent object to receive signal strength
 			level change notifications on the
-			net.connman.iwd.Station.SignalLevelAgent interface,
-			see station-api.txt.  The "levels" parameter decides
+			net.connman.iwd.SignalLevelAgent interface, see
+			station-api.txt.  The "levels" parameter decides
 			the thresholds in dBm that will generate a call to
 			the agent's Changed method whenever current RSSI
 			crosses any of the values.  The values must be
doc/station-api.txt +14 -17
index b2131890..b640e18c 100644
@@ -112,14 +112,13 @@ Methods		void Scan()
 			Register the agent object to receive signal strength
 			level change notifications on the
 			net.connman.iwd.SignalLevelAgent interface, see
-			signal-level-agent-api.txt.  The "levels"
-			parameters decides the thresholds in dBm that will
-			generate a call to the agent's Changed
-			method whenever current RSSI crosses any of the
-			values.  The values must be passed in descending
-			order.  The number and distance between requested
-			threshold values is a compromise between resolution
-			and the frequency of system wakeups and
+			below.  The "levels" parameters decides the
+			thresholds in dBm that will generate a call to the
+			agent's Changed method whenever current RSSI crosses
+			any of the values.  The values must be passed in
+			descending order.  The number and distance between
+			requested threshold values is a compromise between
+			resolution and the frequency of system wakeups and
 			context-switches that are going to be occurring to
 			update the client's signal meter.  Only one agent
 			can be registered at any time.
@@ -186,15 +185,13 @@ Methods		void Release(object device)
 			measurement for the device's connected network
 			changes enough to go from one level to another out
 			of the N ranges defined by the array of (N-1)
-			threshold values passed to
-			net.connman.iwd.Station.RegisterSignalLevelAgent
-			(see device-api.txt.)  The level parameter is in
-			the range from 0 to N, 0 being the strongest
-			signal or above the first threshold value in the
-			array, and N being the weakest and below the
-			last threshold value.  For example if
-			RegisterSignalLevelAgent was called with the
-			array [-40, -50, -60], the 'level' parameter of
+			threshold values passed to RegisterSignalLevelAgent().
+			The level parameter is in the range from 0 to N,
+			0 being the strongest signal or above the first
+			threshold value in the array, and N being the
+			weakest and below the last threshold value.  For
+			example if RegisterSignalLevelAgent was called with
+			the array [-40, -50, -60], the 'level' parameter of
 			0 would mean signal is received at -40 or more dBm
 			and 3 would mean below -60 dBm and might correspond
 			to 1 out of 4 bars on a UI signal meter.
Signature · 1 line
2.25.1
#1 lore raw

Hi Andrew,

Quoted 9 lines · Andrew Zaborowski

When the SignalLevelAgent doc blurb was moved to station-api.txt it seems the interface was changed to Station.SignalLevelAgent in some places but not in most and not in the code. Also fix the pointers to the doc file.

---
  doc/p2p-api.txt     |  4 ++--
  doc/station-api.txt | 31 ++++++++++++++-----------------
  2 files changed, 16 insertions(+), 19 deletions(-)

Applied, thanks.

Regards,
-Denis