From b640d0a5a448a5fa119512ad76a915adf11d2c25 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 17 Jul 2009 01:42:27 +0200 Subject: Rename some API document to indicate that they are low-level API --- doc/Makefile.am | 7 ++- doc/connection-api.txt | 62 -------------------- doc/connection-lowlevel-api.txt | 62 ++++++++++++++++++++ doc/device-api.txt | 121 ---------------------------------------- doc/device-lowlevel-api.txt | 121 ++++++++++++++++++++++++++++++++++++++++ doc/network-api.txt | 92 ------------------------------ doc/network-lowlevel-api.txt | 92 ++++++++++++++++++++++++++++++ 7 files changed, 279 insertions(+), 278 deletions(-) delete mode 100644 doc/connection-api.txt create mode 100644 doc/connection-lowlevel-api.txt delete mode 100644 doc/device-api.txt create mode 100644 doc/device-lowlevel-api.txt delete mode 100644 doc/network-api.txt create mode 100644 doc/network-lowlevel-api.txt (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 98282373..0696488e 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -37,6 +37,7 @@ else EXTRA_DIST = $(DOC_MAIN_SGML_FILE) connman-introduction.xml endif -EXTRA_DIST += overview-api.txt behavior-api.txt manager-api.txt \ - device-api.txt network-api.txt service-api.txt \ - connection-api.txt profile-api.txt agent-api.txt plugin-api.txt +EXTRA_DIST += overview-api.txt behavior-api.txt plugin-api.txt \ + manager-api.txt profile-api.txt service-api.txt \ + device-lowlevel-api.txt network-lowlevel-api.txt \ + connection-lowlevel-api.txt agent-api.txt diff --git a/doc/connection-api.txt b/doc/connection-api.txt deleted file mode 100644 index 8e2e8bca..00000000 --- a/doc/connection-api.txt +++ /dev/null @@ -1,62 +0,0 @@ -Connection hierarchy -==================== - -Service org.moblin.connman -Interface org.moblin.connman.Connection -Object path [variable prefix]/{connection0,connection1,...} - -Methods dict GetProperties() - - Returns properties for the connection 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 Type [readonly] - - The connection type (for example wifi etc.) - - string Interface [readonly] - - The connection interface (for example "eth0" etc.) - - This value is for pure informational purposes. It - is not guaranteed that it is always present. - - uint8 Strength [readonly] - - Indicates the signal strength of the connection. - - This property is optional and not always present. - - boolean Default [readonly] - - Indicates if it is a default connection. It is - possible to have multiple default connections. - - object Device [readonly] - - The object path of the device this connection has - been established with. - - object Network [readonly] - - The object path of the network this connection - belongs to. - - This property is optional and not always present. - - string IPv4.Method [readonly] - - Indicates the way how the IPv4 settings were - configured. Possible values here are "dhcp" - and "static". - - string IPv4.Address [readonly] - - Shows the current configured IPv4 address. diff --git a/doc/connection-lowlevel-api.txt b/doc/connection-lowlevel-api.txt new file mode 100644 index 00000000..8e2e8bca --- /dev/null +++ b/doc/connection-lowlevel-api.txt @@ -0,0 +1,62 @@ +Connection hierarchy +==================== + +Service org.moblin.connman +Interface org.moblin.connman.Connection +Object path [variable prefix]/{connection0,connection1,...} + +Methods dict GetProperties() + + Returns properties for the connection 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 Type [readonly] + + The connection type (for example wifi etc.) + + string Interface [readonly] + + The connection interface (for example "eth0" etc.) + + This value is for pure informational purposes. It + is not guaranteed that it is always present. + + uint8 Strength [readonly] + + Indicates the signal strength of the connection. + + This property is optional and not always present. + + boolean Default [readonly] + + Indicates if it is a default connection. It is + possible to have multiple default connections. + + object Device [readonly] + + The object path of the device this connection has + been established with. + + object Network [readonly] + + The object path of the network this connection + belongs to. + + This property is optional and not always present. + + string IPv4.Method [readonly] + + Indicates the way how the IPv4 settings were + configured. Possible values here are "dhcp" + and "static". + + string IPv4.Address [readonly] + + Shows the current configured IPv4 address. diff --git a/doc/device-api.txt b/doc/device-api.txt deleted file mode 100644 index 72070c3b..00000000 --- a/doc/device-api.txt +++ /dev/null @@ -1,121 +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 JoinNetwork(dict network) - - Join network specified by the given properties. The - properties for WiFi networks can be WiFi.SSID, - WiFi.Security and WiFi.Passphrase. - - Possible Errors: [service].Error.InvalidArguments - - object CreateNetwork(dict network) - - Creates a network object from the specified - properties. Valid properties are WiFi.SSID, - WiFi.Security and WiFi.Passphrase. Check the - network interface description for details. - - Possible Errors: [service].Error.InvalidArguments - - void RemoveNetwork(object network) - - Removes a previously created network object. - - Possible Errors: [service].Error.InvalidArguments - [service].Error.DoesNotExist - - 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. - - 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/device-lowlevel-api.txt b/doc/device-lowlevel-api.txt new file mode 100644 index 00000000..72070c3b --- /dev/null +++ b/doc/device-lowlevel-api.txt @@ -0,0 +1,121 @@ +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 JoinNetwork(dict network) + + Join network specified by the given properties. The + properties for WiFi networks can be WiFi.SSID, + WiFi.Security and WiFi.Passphrase. + + Possible Errors: [service].Error.InvalidArguments + + object CreateNetwork(dict network) + + Creates a network object from the specified + properties. Valid properties are WiFi.SSID, + WiFi.Security and WiFi.Passphrase. Check the + network interface description for details. + + Possible Errors: [service].Error.InvalidArguments + + void RemoveNetwork(object network) + + Removes a previously created network object. + + Possible Errors: [service].Error.InvalidArguments + [service].Error.DoesNotExist + + 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. + + 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-api.txt b/doc/network-api.txt deleted file mode 100644 index 96fe20fc..00000000 --- a/doc/network-api.txt +++ /dev/null @@ -1,92 +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 - - 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. 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. -- cgit v1.2.3