diff --git a/doc/signal-level-agent-api.txt b/doc/signal-level-agent-api.txt index 847e7ca3..e69de29b 100644 --- a/doc/signal-level-agent-api.txt +++ b/doc/signal-level-agent-api.txt @@ -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. diff --git a/doc/station-api.txt b/doc/station-api.txt index 0367eaa7..7d1e210d 100644 --- a/doc/station-api.txt +++ b/doc/station-api.txt @@ -154,3 +154,37 @@ Properties string State [readonly] Reflects whether the device is currently scanning for networks. net.connman.iwd.Network objects are 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.