Document the network address property

[connman] / doc / network-api.txt

diff --git a/doc/network-api.txt b/doc/network-api.txt
index 8480fcd..fc4f348 100644 (file)
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -27,12 +27,20 @@ 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 network.
+
+               string Name [readonly]
 
                        The pretty/long version of the network name. For
                        example in case of WiFi this should be the UTF-8
                        valid version of the SSID.
 
+                       This property might not be available for every
+                       network. For example hidden WiFi networks will
+                       not include it.
+
                boolean Available [readonly]
 
                        Indicates that this network is in range and
@@ -51,11 +59,31 @@ Properties  string Name [readonly]
                        For manually created networks this is set by
                        default.
 
+               uint8 Strength [readonly]
+
+                       Indicates the signal strength of the network. This
+                       is a normalized value between 0 and 100.
+
+               object Device [readonly]
+
+                       The object path of the device this networks
+                       belongs to.
+
                array{byte} WiFi.SSID [readonly]
 
                        If the network type is WiFi, then this property is
                        present and contains the binary SSID value.
 
+               string WiFi.Mode [readonly, readwrite]
+
+                       If the network type is WiFi, then this property is
+                       present and contains the mode of the network. The
+                       possible values are "managed" or "adhoc".
+
+                       For scanned networks this value is read only, but in
+                       case the network was manually created it is also
+                       changeable.
+
                string WiFi.Security [readonly, readwrite]
 
                        If the network type is WiFi, then this property is
@@ -66,7 +94,7 @@ Properties    string Name [readonly]
                        case the network was manually created it is also
                        changeable.
 
-                       Possible values are NONE, WPA and WPA2.
+                       Possible values are "none", "wep", "wpa" and "wpa2".
 
                string WiFi.Passphrase [readwrite]
 
@@ -74,5 +102,5 @@ Properties   string Name [readonly]
                        requires, then this property is present and contains
                        the passphrase in clear text.
 
-                       For system using PolicyKit, the access to this value
+                       For systems using PolicyKit, the access to this value
                        will be protected by the security policy.