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

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.
This commit is contained in:
Andrew Zaborowski 2020-10-14 14:38:36 +02:00 committed by Denis Kenzior
parent 1f89ebb86a
commit 008b29f359
2 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/p2p-api.txt
View File

@ -47,8 +47,8 @@ Methods array(on) GetPeers()
Register the agent object to receive signal strength Register the agent object to receive signal strength
level change notifications on the level change notifications on the
net.connman.iwd.Station.SignalLevelAgent interface, net.connman.iwd.SignalLevelAgent interface, see
see station-api.txt. The "levels" parameter decides station-api.txt. The "levels" parameter decides
the thresholds in dBm that will generate a call to the thresholds in dBm that will generate a call to
the agent's Changed method whenever current RSSI the agent's Changed method whenever current RSSI
crosses any of the values. The values must be crosses any of the values. The values must be

31
doc/station-api.txt
View File

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