Update the D-Bus API documentation

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index 27bd321..ff7aa53 100644 (file)
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -2,7 +2,7 @@ Agent hierarchy
 ***************
 
 Service name   [unique name]
-Interface name org.freedesktop.connman.Agent
+Interface name org.moblin.connman.Agent
 Object path    [random object]
 
 Methods                void Release()
@@ -14,4 +14,4 @@ This method will be called when the core releases the agent. This normally
 happens when the core shuts down.
 
 To get notified when the core exits, an agent should also watch out for the
-NameOwnerChanged from org.freedesktop.connman service.
+NameOwnerChanged from org.moblin.connman service.

diff --git a/doc/element-api.txt b/doc/element-api.txt
new file mode 100644 (file)
index 0000000..423f1a7
--- /dev/null
+++ b/doc/element-api.txt
@@ -0,0 +1,50 @@
+Element hierarchy
+*****************
+
+Service name   org.moblin.connman
+Interface name org.moblin.connman.Element
+Object path    [element object]
+
+Methods                dict GetProperties()
+
+Properties     string Type
+               string Subtype
+               string Driver
+               string Vendor
+               string Product
+
+
+Method: GetProperties
+=====================
+This method allows to retrieve all properties of an element at once. The
+properties are presented in a dictionary.
+
+Property: Type
+==============
+This property represents the main type of an element. It can have the values
+like "device", "network", "ipv4", "ipv6", "dhcp", "bootp" and "zeroconf".
+
+Property: Subtype
+=================
+This property represents the subtype of an element. In the normal case this
+is the hardware type. It can have values like "ethernet", "wifi", "wimax",
+"modem" and "bluetooth".
+
+The element system will inherit the subtype from the parent if not overwritten
+manually and so it should be present in every element.
+
+Property: Driver
+================
+This property represents the driver that is assigned to this element. This
+value will only be present in case of Device elements. On Linux system this
+is the kernel driver name.
+
+Property: Vendor
+================
+This property represent the vendor string for this element. This value is only
+present in case of a Device element. This information are taken from HAL.
+
+Property: Product
+=================
+This property represent the product string for this element. This value is only
+present in case of a Device element. This information are taken from HAL.

diff --git a/doc/interface-api.txt b/doc/interface-api.txt
deleted file mode 100644 (file)
index faee203..0000000
--- a/doc/interface-api.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-Interface hierarchy
-*******************
-
-Service name   org.freedesktop.connman
-Interface name org.freedesktop.connman.Interface
-Object path    [interface object]
-
-Methods                dict GetProperties()
-               string GetState()
-               uint16 GetSignal()
-               string GetPolicy()
-               void SetPolicy(string policy)
-               dict GetNetwork()
-               void SetNetwork(dict network)
-               dict GetIPv4()
-               void SetIPv4(dict ipv4)
-
-Signals                StateChanged(string state)
-               SignalChanged(uint16 signal)
-               PolicyChanged(string policy)
-               NetworkFound(dict network)
-               NetworkChanged(dict network)
-               IPv4Changed(dict ipv4)

diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 0c4de41..03b39a5 100644 (file)
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -1,39 +1,31 @@
 Manager hierarchy
 *****************
 
-Service name   org.freedesktop.connman
-Interface name org.freedesktop.connman.Manager
+Service name   org.moblin.connman
+Interface name org.moblin.connman.Manager
 Object path    /
 
-Methods                array{object} ListInterfaces()
-               string GetState()
+Methods                array{object} ListElements()
                void RegisterAgent(object path)
                void UnregisterAgent(object path)
 
-Signals                InterfaceAdded(object)
-               InterfaceRemoved(object)
-               StateChanged(string state)
+Signals                ElementAdded(object)
+               ElementRemoved(object)
 
 
-Method: ListInferfaces
-======================
+Method: ListElements
+====================
 This method lists all available interfaces. The return value is an array of
 object paths. Every attached network interface (eth0, wlan0 etc.) of the
 system is presented by an object path with additional interfaces on it. The
 main interface is org.freedesktop.connman.Interface.
 
-Method: GetState
-================
-This method gets the overall master state of the Internet connection. Possible
-return values are "offline" and "online". If at least one interface is
-connected it will return "online".
-
 Method: RegisterAgent
 =====================
 This method allows the user interace to register an agent. There can be only
 one agent registered at a time. The parameter of the method is the object
 path the agent has been registered for the callback method. The agent has
-to implement org.freedesktop.connman.Agent interface on this object path.
+to implement org.moblin.connman.Agent interface on this object path.
 
 Method: UnregisterAgent
 =======================
@@ -41,19 +33,14 @@ This method unregisters a previously registered agent. In case the agent
 application exits the core will automatically unregister the agent. However
 for a clean agent application it is important to call the unregister method.
 
-Signal: InterfaceAdded
-======================
-This signal is emitted every time a new interface has been found by the
+Signal: ElementAdded
+====================
+This signal is emitted every time a new element has been added by the
 core and successfully activated. The signal is also emitted on startup
 or at anytime at runtime in case of hotplug devices.
 
-Signal: InterfaceRemoved
-========================
-This signal is emitted every time an interface has been removed. This can
+Signal: ElementRemoved
+======================
+This signal is emitted every time an element has been removed. This can
 happen at any time in case of hotplug devices. When the system shuts down,
 this signal is also emitted.
-
-Signal: StateChanged
-====================
-This signal is emitted every time the master state changes. Possible values
-are "offline" and "online" and reflect the state of the Internet connection.