summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-12-28 02:13:50 +0100
committerMarcel Holtmann <marcel@holtmann.org>2008-12-28 02:13:50 +0100
commitc867b6b07870792c5efe275e2f79cb9ba9595164 (patch)
tree12514194ed69961cb82e2885e79ff9fa6ae46343 /doc/device-api.txt
parentf0444b7be4f6b38137796489b2c6a258b431af27 (diff)
downloadconnman-c867b6b07870792c5efe275e2f79cb9ba9595164.tar.gz
connman-c867b6b07870792c5efe275e2f79cb9ba9595164.tar.bz2
connman-c867b6b07870792c5efe275e2f79cb9ba9595164.zip
Add manual policy to device settings
Diffstat (limited to 'doc/device-api.txt')
-rw-r--r--doc/device-api.txt24
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt
index 7d1b86fc..6d8f348a 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -63,21 +63,29 @@ Properties string Name [readonly]
string Policy [readwrite]
- Setting of the device power policy. Possible values
- are "off", "ignore" and "auto".
+ Setting of the device power and connection policy.
+ Possible values are "ignore", "off", "auto"
+ and "manual".
The policy defines on how the device is initialized
- when brought up. The actual device power state can
- be changed independently to this value.
+ when brought up and how it connects. 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.
+ to "auto" or "manual", the device will be switched
+ on. 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.
+ system. For example for complex network setups.
+
+ Devices that can connect to various networks, the
+ difference between "auto" or "manual" defines if
+ known networks are connected automatically or not.
+ For simple devices like Ethernet cards, setting
+ the "manual" policy might fail.
boolean Powered [readwrite]