summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2010-11-05 11:44:47 +0100
committerMarcel Holtmann <marcel@holtmann.org>2010-11-05 11:44:47 +0100
commitfeae9ff3728fb9785521ea9d14d99caf4923af2e (patch)
treed779e04f6c18583271c1ef92bafedb41b32227ab /doc
parent93ef55a72cd091cd7dcf322f9c4adddfecd3f97c (diff)
downloadconnman-feae9ff3728fb9785521ea9d14d99caf4923af2e.tar.gz
connman-feae9ff3728fb9785521ea9d14d99caf4923af2e.tar.bz2
connman-feae9ff3728fb9785521ea9d14d99caf4923af2e.zip
Remove documentation for no longer existing interfaces
Diffstat (limited to 'doc')
-rw-r--r--doc/device-lowlevel-api.txt106
-rw-r--r--doc/network-lowlevel-api.txt74
-rw-r--r--doc/technology-api.txt4
3 files changed, 0 insertions, 184 deletions
diff --git a/doc/device-lowlevel-api.txt b/doc/device-lowlevel-api.txt
deleted file mode 100644
index f01751bb..00000000
--- a/doc/device-lowlevel-api.txt
+++ /dev/null
@@ -1,106 +0,0 @@
-Device hierarchy
-================
-
-Service org.moblin.connman
-Interface org.moblin.connman.Device
-Object path [variable prefix]/{device0,device1,...}
-
-Methods dict GetProperties()
-
- Returns properties for the device object. See
- the properties section for available properties.
-
- Possible Errors: [service].Error.InvalidArguments
-
- void SetProperty(string name, variant value)
-
- Changes the value of the specified property. Only
- properties that are listed as read-write are
- changeable. On success a PropertyChanged signal
- will be emitted.
-
- Possible Errors: [service].Error.InvalidArguments
- [service].Error.InvalidProperty
-
- void ProposeScan()
-
- Proposes to trigger a scan transaction.
-
- Possible Errors: [service].Error.InvalidArguments
-
-Signals PropertyChanged(string name, variant value)
-
- This signal indicates a changed value of the given
- property.
-
-Properties string Address [readonly]
-
- The address of the device.
-
- string Name [readonly]
-
- The device name (for example "Wireless" etc.)
-
- This name can be used for directly displaying it in
- the application. It has pure informational purpose
- and there is not guarantee that it is present.
-
- string Type [readonly]
-
- The device type (for example "ethernet", "wifi" etc.)
-
- string Interface [readonly]
-
- The device interface (for example "eth0" etc.)
-
- This value is for pure informational purposes. It
- is not guaranteed that it is always present.
-
- boolean Powered [readwrite]
-
- Switch a device on or off. This will also modify
- 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 Blocked [readonly]
-
- Indicates if a device transmission capability is
- blocked or not. This property is a translation of
- the device rfkill status. If it is hard or soft
- blocked, this property will be true.
-
- Once a device is blocked, enabling it will fail.
-
- uint16 ScanInterval [readwrite]
-
- The scan interval describes the time in seconds
- between automated scan attempts. Setting this
- value to 0 will disable the background scanning.
-
- The default value is 300 and so every 5 minutes
- a scan procedure will be triggered.
-
- This property is not available with all types
- of devices. Some might not support background
- scanning at all.
-
- boolean Scanning [readonly]
-
- Indicates if a device is scanning. Not all device
- types might support this. Also some hardware might
- execute background scanning without notifying the
- driver about it. Use this property only for visual
- indication.
-
- array{object} Networks [readonly]
-
- List of networks objects paths. Every object path
- represents a network in range or a known network.
diff --git a/doc/network-lowlevel-api.txt b/doc/network-lowlevel-api.txt
deleted file mode 100644
index 6572f0f1..00000000
--- a/doc/network-lowlevel-api.txt
+++ /dev/null
@@ -1,74 +0,0 @@
-Network hierarchy
-=================
-
-Service org.moblin.connman
-Interface org.moblin.connman.Network
-Object path [variable prefix]/{network0,network1,...}
-
-Methods dict GetProperties()
-
- Returns properties for the network object. See
- the properties section for available properties.
-
- Possible Errors: [service].Error.InvalidArguments
-
-Signals PropertyChanged(string name, variant value)
-
- This signal indicates a changed value of the given
- property.
-
-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 Connected [readonly]
-
- Indicates that this network is currently connected.
-
- 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]
-
- 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".
-
- string WiFi.Security [readonly]
-
- If the network type is WiFi, then this property is
- present and contains the security method or key
- management setting.
-
- Possible values are "none", "wep", "wpa" and "rsn".
-
- string WiFi.Passphrase [readonly]
-
- If the network type is WiFi and a passhrase is
- requires, then this property is present and contains
- the passphrase in clear text.
-
- For systems using PolicyKit, the access to this value
- will be protected by the security policy.
diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index 84084547..0c8789d3 100644
--- a/doc/technology-api.txt
+++ b/doc/technology-api.txt
@@ -35,7 +35,3 @@ Properties string State [readonly]
This information should only be used to determine
advanced properties or showing the correct icon
to the user.
-
- array{object} Devices [readonly]
-
- List of device objects.