session doc: Document PeriodicConnect and IdleTimeout

[framework/connectivity/connman.git] / doc / technology-api.txt

diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index 9b10c58..12b421c 100644 (file)
--- a/doc/technology-api.txt
+++ b/doc/technology-api.txt
@@ -1,8 +1,8 @@
 Technology hierarchy
 ====================
 
-Service                org.moblin.connman
-Interface      org.moblin.connman.Technology
+Service                net.connman
+Interface      net.connman.Technology
 Object path    [variable prefix]/{technology0,technology1,...}
 
 Methods                dict GetProperties()
@@ -17,7 +17,13 @@ Signals              PropertyChanged(string name, variant value)
                        This signal indicates a changed value of the given
                        property.
 
-Properties     string Name [readonly]
+Properties     string State [readonly]
+
+                       The technology state information.
+
+                       Valid states are "offline", "enabled" and "connected".
+
+               string Name [readonly]
 
                        Name of this technology.
 
@@ -29,6 +35,25 @@ Properties   string Name [readonly]
                        advanced properties or showing the correct icon
                        to the user.
 
-               array{object} Devices [readonly]
+               boolean Tethering [readwrite]
+
+                       This option allows to enable or disable the support
+                       for tethering. When tethering is enabled then the
+                       default service is bridged to all clients connected
+                       through the technology.
+
+               string TetheringIdentifier [readwrite]
+
+                      The tethering broadcasted identifier.
+
+                      This property is only valid for the WiFi technology,
+                      and is then mapped to the WiFi AP SSID clients will
+                      have to join in order to gain internet connectivity.
+
+               string TetheringPassphrase [readwrite]
+
+                      The tethering connection passphrase.
 
-                       List of device objects.
+                      This property is only valid for the WiFi technology,
+                      and is then mapped to the WPA pre-shared key clients
+                      will have to use in order to establish a connection.