Rename some API document to indicate that they are low-level API

1 files changed, 92 insertions, 0 deletions

diff --git a/doc/network-lowlevel-api.txt b/doc/network-lowlevel-api.txt
new file mode 100644
index 00000000..96fe20fc
--- /dev/null
+++ b/doc/network-lowlevel-api.txt
@@ -0,0 +1,92 @@
+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
+
+		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
+
+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, 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
+			present and contains the security method or key
+			management setting.
+
+			For scanned networks this value is read only, but in
+			case the network was manually created it is also
+			changeable.
+
+			Possible values are "none", "wep", "wpa" and "rsn".
+
+		string WiFi.Passphrase [readwrite]
+
+			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.