Cleanup maemo build dirs and files.

[connman] / doc / device-api.txt

diff --git a/doc/device-api.txt b/doc/device-api.txt
index 7d1b86f..55625cc 100644 (file)
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -22,6 +22,14 @@ Methods              dict GetProperties()
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.DoesNotExist
 
+               void JoinNetwork(dict network)
+
+                       Join network specified by the given properties. The
+                       properties for WiFi networks can be WiFi.SSID,
+                       WiFi.Security and WiFi.Passphrase.
+
+                       Possible Errors: [service].Error.InvalidArguments
+
                object CreateNetwork(dict network)
 
                        Creates a network object from the specified
@@ -38,12 +46,22 @@ Methods             dict GetProperties()
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.DoesNotExist
 
+               void ProposeScan()
+
+                       Proposes to trigger a scan transaction.
+
+                       Possible Errors: [service].Error.InvalidArguments
+
 Signals                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
                        property.
 
-Properties     string Name [readonly]
+Properties     string Address [readonly]
+
+                       The address of the device.
+
+               string Name [readonly]
 
                        The device name (for example "Wireless" etc.)
 
@@ -63,21 +81,34 @@ Properties  string Name [readonly]
 
                string Policy [readwrite]
 
-                       Setting of the device power policy. Possible values
-                       are "off", "ignore" and "auto".
+                       Setting of the device power and connection policy.
+                       Possible values are "ignore", "off", "auto"
+                       and "manual".
 
                        The policy defines on how the device is initialized
-                       when brought up. The actual device power state can
-                       be changed independently to this value.
+                       when brought up and how it connects. The actual
+                       device power state can be changed independently to
+                       this value.
 
                        If a device is switched off and the policy is changed
-                       to "auto", the device will be switched. For a current
-                       active device changing the policy to "off" results
-                       in powering down the device.
+                       to "auto" or "manual", the device will be switched
+                       on. For a current active device changing the policy
+                       to "off" results in powering down the device.
 
                        The "ignore" policy can be set for devices that are
                        detected, but managed by a different entity on the
-                       system. For example complex network setups.
+                       system. For example for complex network setups.
+
+                       Devices that can connect to various networks, the
+                       difference between "auto" or "manual" defines if
+                       known networks are connected automatically or not.
+                       For simple devices like Ethernet cards, setting
+                       the "manual" policy might fail.
+
+               uint8 Priority [readwrite]
+
+                       The device priority. Higher values indicate the
+                       preference for this device.
 
                boolean Powered [readwrite]
 
@@ -93,6 +124,19 @@ Properties  string Name [readonly]
                        example would be modifications via the "ifconfig"
                        command line utility.
 
+               uint16 ScanInterval [readwrite]
+
+                       The scan interval describes the time in seconds
+                       between automated scan attempts. Setting this
+                       value to 0 will disable the background scanning.
+
+                       The default value is 300 and so every 5 minutes
+                       a scan procedure will be triggered.
+
+                       This property is not available with all types
+                       of devices. Some might not support background
+                       scanning at all.
+
                boolean Scanning [readonly]
 
                        Indicates if a device is scanning. Not all device