Kernel/iwd
3
0
Fork 0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-22 06:29:23 +01:00
Code Releases Activity

doc: Document initial signal level notification

Browse Source 
Document the initial "Changed" method call following SignalLevelAgent
registration.
This commit is contained in:
Jesse Lentz 2022-05-20 17:53:24 -04:00 committed by Denis Kenzior
parent 3d27d0d80a
commit 8115105835
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/station-api.txt
View File

@ -182,16 +182,17 @@ Methods void Release(object device) [noreply]
void Changed(object device, uint8 level) [noreply]
This method gets called when the signal strength
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 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.
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 RegisterSignalLevelAgent(). It also gets
called immediately after the signal level agent is
registered. 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.