From: Marcel Holtmann <marcel@holtmann.org>
Date: Sun, 21 Dec 2008 15:18:05 +0000 (+0100)
Subject: Update property documentation
X-Git-Tag: 0.6~189
X-Git-Url: https://vcs.maemo.org/git/?a=commitdiff_plain;h=7eb0cf5c259469ab07a6ec79cc316afe532cf5ec;p=connman

Update property documentation
---

diff --git a/doc/device-api.txt b/doc/device-api.txt
index 7df3791..45c7215 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -52,7 +52,25 @@ Properties	string Name [readonly]
 
 		string Type [readonly]
 
-			The device type (for example ethernet, wifi etc.)
+			The device type (for example "ethernet", "wifi" etc.)
+
+		string Policy [readwrite]
+
+			Setting of the device power policy. Possible values
+			are "off", "ignore" and "auto".
+
+			The policy defines on how the device is initialized
+			when brought up. 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", the device will be switched. 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 complex network setups.
 
 		boolean Powered [readwrite]
 
@@ -60,6 +78,14 @@ 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.
+
 		boolean Scanning [readonly]
 
 			Indicates if a device is scanning. Not all device
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 9365e66..7ebfa89 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -45,6 +45,19 @@ Properties	string State [readonly]
 			values are "online" if at least one connection exists
 			and "offline" if no device is connected.
 
+		boolean FlightMode [readwrite]
+
+			The flight mode indicates the global setting for
+			switching all radios on or off. Changing flight mode
+			to true results in powering down all devices. When
+			leaving flight mode the individual policy of each
+			device decides to switch the radio back on or not.
+
+			During flight mode, it is still possible to switch
+			certain technologies manually back on. For example
+			the limited usage of WiFi or Bluetooth devices might
+			be allowed in some situations.
+
 		array{object} Profiles [readonly]
 
 			List of profile object paths.
diff --git a/doc/network-api.txt b/doc/network-api.txt
index ce487dd..66ad6fb 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -53,7 +53,8 @@ Properties	string Name [readonly]
 
 		uint8 Strength [readonly]
 
-			Indicates the signal strength of the network.
+			Indicates the signal strength of the network. This
+			is a normalized value between 0 and 100.
 
 		object Device [readonly]
 
@@ -65,6 +66,16 @@ Properties	string Name [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
@@ -75,7 +86,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]
 
@@ -83,5 +94,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.