doc: SignalLevelAgent related docs

This commit is contained in:
Andrew Zaborowski 2017-05-20 01:39:39 +02:00 committed by Denis Kenzior
parent c68200b5a1
commit c2a39f5c22
2 changed files with 63 additions and 0 deletions

View File

@ -56,6 +56,36 @@ Methods void Scan()
Contains the type of the network. Possible
types are "open", "psk", "8021x" (EAP)
void RegisterSignalLevelAgent(object path,
array(int16) levels)
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 SignalLevelChanged
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 occuring to
update the client's signal meter. Only one agent
can be registered at any time.
Possible Errors: [service].Error.InvalidArguments
[service].Error.Failed
[service].Error.AlreadyExists
[service].Error.NotSupported
void UnregisterSignalLevelAgent(object path)
Unregister an existing agent.
Possible Errors: [service].Error.InvalidArguments
[service].Error.NotFound
Properties string Name [readonly]
Device's interface name

View File

@ -0,0 +1,33 @@
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 SignalLevelChanged(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.