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

doc: Merge signal-level-agent-api.txt

Browse Source 
into station-api.txt where it logically belongs
This commit is contained in:
Denis Kenzior 2019-10-23 17:43:10 -05:00
parent 3191c61b26
commit 966114ab3e
2 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/signal-level-agent-api.txt
View File

@ -1,33 +0,0 @@
SignalLevelAgent hierarchy
==========================
Service unique name
Interface net.connman.iwd.SignalLevelAgent
Object path freely definable
Methods void Release(object device)
This method gets called when the service daemon
unregisters the agent. An agent can use it to do
cleanup tasks. There is no need to unregister the
agent, because when this method gets called it has
already been unregistered.
string Changed(object device, uint8 level)
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
net.connman.iwd.Device.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
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.

34
doc/station-api.txt
View File

@ -154,3 +154,37 @@ Properties string State [readonly]
Reflects whether the device is currently scanning Reflects whether the device is currently scanning
for networks. net.connman.iwd.Network objects are for networks. net.connman.iwd.Network objects are
updated when this property goes from true to false. updated when this property goes from true to false.
SignalLevelAgent hierarchy
==========================
Service unique name
Interface net.connman.iwd.SignalLevelAgent
Object path freely definable
Methods void Release(object device)
This method gets called when the service daemon
unregisters the agent. An agent can use it to do
cleanup tasks. There is no need to unregister the
agent, because when this method gets called it has
already been unregistered.
string Changed(object device, uint8 level)
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
net.connman.iwd.Device.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
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.