mirror of
https://git.kernel.org/pub/scm/network/wireless/iwd.git
synced 2024-11-22 06:29:23 +01:00
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:
parent
1f89ebb86a
commit
008b29f359
@ -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
|
||||
|
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user