Add device interface documentation

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 92d9540..6d35116 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -48,6 +48,7 @@ EXTRA_DIST = $(DOC_MAIN_SGML_FILE) connman-introduction.xml
 endif
 
 EXTRA_DIST += dbus-introspection.dtd dbus-introspection.xsl \
-               dbus-manager.xml
+                                               dbus-manager.xml
 
-EXTRA_DIST += manager-api.txt element-api.txt agent-api.txt plugin-api.txt
+EXTRA_DIST += manager-api.txt device-api.txt \
+                               element-api.txt agent-api.txt plugin-api.txt

diff --git a/doc/device-api.txt b/doc/device-api.txt
new file mode 100644 (file)
index 0000000..a7aa60e
--- /dev/null
+++ b/doc/device-api.txt
@@ -0,0 +1,52 @@
+Device hierarchy
+================
+
+Service                org.moblin.connman
+Interface      org.moblin.connman.Device
+Object path    [variable prefix]/{device0,device1,...}
+
+Methods                dict GetProperties()
+
+                       Returns properties for the device objects. See
+                       the properties section for available properties.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.DoesNotExist
+
+               void SetProperty(string name, variant value)
+
+                       Changes the value of the specified property. Only
+                       properties that are listed as read-write are
+                       changeable. On success a PropertyChanged signal
+                       will be emitted.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.DoesNotExist
+
+Signals                PropertyChanged(string name, variant value)
+
+                       This signal indicates a changed value of the given
+                       property.
+
+Properties     string Name [readonly]
+
+                       The device name (for example eth0, wlan0 etc.)
+
+               boolean Powered [readwrite]
+
+                       Switch a device on or off. This will also modify
+                       the list of networks in range. All known networks
+                       will be still available via the Networks property.
+
+               boolean Scanning [readonly]
+
+                       Indicates if a device is scanning. Not all device
+                       types might support this. Also some hardware might
+                       execute background scanning without notifying the
+                       driver about it. Use this property only for visual
+                       indication.
+
+               array{object} Networks [readonly]
+
+                       List of networks objects paths. Every object path
+                       represents a network in range or a known network.