Release 0.12

[connman] / doc / device-api.txt

diff --git a/doc/device-api.txt b/doc/device-api.txt
index d50a6c5..ce50be7 100644 (file)
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -11,7 +11,6 @@ Methods               dict GetProperties()
                        the properties section for available properties.
 
                        Possible Errors: [service].Error.InvalidArguments
-                                        [service].Error.DoesNotExist
 
                void SetProperty(string name, variant value)
 
@@ -23,6 +22,22 @@ Methods              dict GetProperties()
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.DoesNotExist
 
+               object CreateNetwork(dict network)
+
+                       Creates a network object from the specified
+                       properties. Valid properties are WiFi.SSID,
+                       WiFi.Security and WiFi.Passphrase. Check the
+                       network interface description for details.
+
+                       Possible Errors: [service].Error.InvalidArguments
+
+               void RemoveNetwork(object network)
+
+                       Removes a previously created network object.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.DoesNotExist
+
 Signals                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
@@ -30,11 +45,52 @@ Signals             PropertyChanged(string name, variant value)
 
 Properties     string Name [readonly]
 
-                       The device name (for example eth0, wlan0 etc.)
+                       The device name (for example "Wireless" etc.)
+
+                       This name can be used for directly displaying it in
+                       the application. It has pure informational purpose.
 
                string Type [readonly]
 
-                       The device type (for example ethernet, wifi etc.)
+                       The device type (for example "ethernet", "wifi" etc.)
+
+               string Interface [readonly]
+
+                       The device interface (for example "eth0" etc.)
+
+                       This value is for pure informational purposes. It
+                       is not guaranteed that it is always present.
+
+               string Policy [readwrite]
+
+                       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 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" 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 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]
 
@@ -42,6 +98,27 @@ Properties   string Name [readonly]
                        the list of networks in range. All known networks
                        will be still available via the Networks property.
 
+                       Changing this value doesn't change the value of the
+                       Policy property.
+
+                       The value of this property can be changed by other
+                       parts of the system (including the kernel). An
+                       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