From 07041f5a50955742a8cd160f466b75d5b9c2005c Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 13 Mar 2008 18:45:08 +0000 Subject: Add documention for manager API --- doc/manager-api.txt | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 doc/manager-api.txt (limited to 'doc/manager-api.txt') diff --git a/doc/manager-api.txt b/doc/manager-api.txt new file mode 100644 index 00000000..b62e6dfb --- /dev/null +++ b/doc/manager-api.txt @@ -0,0 +1,51 @@ +BlueZ D-Bus Manager API description +*********************************** + +Copyright (C) 2004-2008 Marcel Holtmann +Copyright (C) 2005-2006 Johan Hedberg +Copyright (C) 2005-2006 Claudio Takahasi +Copyright (C) 2006-2007 Luiz von Dentz + + +Manager hierarchy +================= + +Service org.bluez +Interface org.bluez.Manager +Object path /org/bluez + +Methods string DefaultAdapter() + + Returns object path for the default adapter. + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.NoSuchAdapter + + string FindAdapter(string pattern) + + Returns object path for the specified adapter. Valid + patterns are "hci0" or "00:11:22:33:44:55". + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.NoSuchAdapter + + array{string} ListAdapters() + + Returns list of adapter object paths under /org/bluez + + Possible errors: org.bluez.Error.InvalidArguments + org.bluez.Error.Failed + org.bluez.Error.OutOfMemory + +Signals void AdapterAdded(string path) + + Parameter is object path of added adapter. + + void AdapterRemoved(string path) + + Parameter is object path of removed adapter. + + void DefaultAdapterChanged(string path) + + Parameter is object path of the new default adapter, + or an empty string if there is no available adapters. -- cgit From 4fe9f126fa4b007d8c3ed33f5d7bf79d06c492be Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 13 Mar 2008 19:04:56 +0000 Subject: Fix manager signal documentation --- doc/manager-api.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/manager-api.txt') diff --git a/doc/manager-api.txt b/doc/manager-api.txt index b62e6dfb..9de1de9b 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -37,15 +37,15 @@ Methods string DefaultAdapter() org.bluez.Error.Failed org.bluez.Error.OutOfMemory -Signals void AdapterAdded(string path) +Signals AdapterAdded(string path) Parameter is object path of added adapter. - void AdapterRemoved(string path) + AdapterRemoved(string path) Parameter is object path of removed adapter. - void DefaultAdapterChanged(string path) + DefaultAdapterChanged(string path) Parameter is object path of the new default adapter, or an empty string if there is no available adapters. -- cgit From 8f9e79080f516142cc74446078b6ab9e68c9c0f4 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 13 Mar 2008 22:36:55 +0000 Subject: Make sure to use the object path type --- doc/manager-api.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc/manager-api.txt') diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 9de1de9b..9869cd91 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -14,14 +14,14 @@ Service org.bluez Interface org.bluez.Manager Object path /org/bluez -Methods string DefaultAdapter() +Methods object DefaultAdapter() Returns object path for the default adapter. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NoSuchAdapter - string FindAdapter(string pattern) + object FindAdapter(string pattern) Returns object path for the specified adapter. Valid patterns are "hci0" or "00:11:22:33:44:55". @@ -29,7 +29,7 @@ Methods string DefaultAdapter() Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NoSuchAdapter - array{string} ListAdapters() + array{object} ListAdapters() Returns list of adapter object paths under /org/bluez @@ -37,15 +37,15 @@ Methods string DefaultAdapter() org.bluez.Error.Failed org.bluez.Error.OutOfMemory -Signals AdapterAdded(string path) +Signals AdapterAdded(object adapter) Parameter is object path of added adapter. - AdapterRemoved(string path) + AdapterRemoved(object adapter) Parameter is object path of removed adapter. - DefaultAdapterChanged(string path) + DefaultAdapterChanged(object adapter) Parameter is object path of the new default adapter, or an empty string if there is no available adapters. -- cgit From c02f77b6ef70f49d18b20e23caaccf685a150ea1 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Thu, 13 Mar 2008 22:47:35 +0000 Subject: Use root as path for the new manager interface --- doc/manager-api.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/manager-api.txt') diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 9869cd91..458fa4ac 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -12,7 +12,7 @@ Manager hierarchy Service org.bluez Interface org.bluez.Manager -Object path /org/bluez +Object path / Methods object DefaultAdapter() -- cgit From 3dbf6d5d3b4dfd2e41a28911832a2ba2fd95f7a7 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 14 Mar 2008 20:15:44 +0000 Subject: Mention the special of DefaultAdapterChanged and no adapters --- doc/manager-api.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc/manager-api.txt') diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 458fa4ac..ba45504a 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -49,3 +49,8 @@ Signals AdapterAdded(object adapter) Parameter is object path of the new default adapter, or an empty string if there is no available adapters. + + In case all adapters are removed this signal will not + be emitted. The AdapterRemoved signal has to be used + to detect that no default adapter is selected or + available anymore. -- cgit