diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-03-07 14:39:14 +0000 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-03-07 14:39:14 +0000 |
| commit | 860a1fc8d94dc3edf90f90b4d8aacd6db4b9bd4c (patch) | |
| tree | 4074b122d7d5634c59fddbd87c2477cd0aedfc1a /doc | |
| parent | ed8b41b18ffaee05ed24bc3d29063666852c0659 (diff) | |
Update documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/adapter-api.txt | 18 | ||||
| -rw-r--r-- | doc/agent-api.txt | 21 | ||||
| -rw-r--r-- | doc/device-api.txt | 21 |
4 files changed, 43 insertions, 19 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index b66ceb7f..3b7bd904 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = adapter-api.txt device-api.txt +EXTRA_DIST = adapter-api.txt device-api.txt agent-api.txt MAINTAINERCLEANFILES = Makefile.in diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index 1f9cdd88..6c3976ba 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -1,11 +1,11 @@ BlueZ D-Bus Adapter API description *********************************** -Copyright (C) 2006-2008 Marcel Holtmann <marcel@holtmann.org> +Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org> Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg@nokia.com> Copyright (C) 2005-2006 Claudio Takahasi <claudio.takahasi@indt.org.br> -Copyright (C) 2005-2006 Eduardo Rocha <eduardo.rocha@indt.org.br> -Copyright (C) 2008-2008 Luiz von Dentz <luiz.dentz@indt.org.br> +Copyright (C) 2006-2007 Luiz von Dentz <luiz.dentz@indt.org.br> + Adapter hierarchy ================= @@ -60,7 +60,9 @@ Methods dict GetProperties() TBD - void RemoveDevice(object path) + void RemoveDevice(object + + TBD Signals DeviceCreated(object path) @@ -90,12 +92,12 @@ Signals DeviceCreated(object path) TBD -Properties string Name [readonly] +Properties string Address [readonly] - string Address [readonly] - - boolean PeriodicInquiry [readwrite] + string Name [readonly] string Mode [readwrite] uint32 DiscoverableTimeout [readwrite] + + boolean PeriodicInquiry [readwrite] diff --git a/doc/agent-api.txt b/doc/agent-api.txt new file mode 100644 index 00000000..24dc508b --- /dev/null +++ b/doc/agent-api.txt @@ -0,0 +1,21 @@ +BlueZ D-Bus Agent API description +********************************** + +Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org> +Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg@nokia.com> + + +Agent hierarchy +=============== + +Service unique name +Interface org.bluez.Agent +Object path freely definable + +Methods void Release() + + This method gets called when the service daemon + unregisters the agent. An agent can use it to do + cleanup tasks. There is no need to unregister the + agent, because when this method gets called it has + already been unregistered. diff --git a/doc/device-api.txt b/doc/device-api.txt index 82de22f4..49545ef5 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -1,13 +1,14 @@ BlueZ D-Bus Device API description ********************************** -Copyright (C) 2008-2008 Marcel Holtmann <marcel@holtmann.org> -Copyright (C) 2008-2008 Johan Hedberg <johan.hedberg@nokia.com> -Copyright (C) 2008-2008 Claudio Takahasi <claudio.takahasi@indt.org.br> -Copyright (C) 2008-2008 Luiz von Dentz <luiz.dentz@indt.org.br> +Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org> +Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg@nokia.com> +Copyright (C) 2005-2006 Claudio Takahasi <claudio.takahasi@indt.org.br> +Copyright (C) 2006-2007 Luiz von Dentz <luiz.dentz@indt.org.br> -Adapter hierarchy -================= + +Device hierarchy +================ Service org.bluez Interface org.bluez.Device @@ -33,9 +34,9 @@ Signals PropertyChanged(string name, variant value) TBD -Properties string Name [readonly] +Properties string Address [readonly] - string Address [readonly] + string Name [readonly] string Class [readonly] @@ -43,8 +44,8 @@ Properties string Name [readonly] boolean Paired [readonly] - boolean Trusted [readwrite] - boolean Connected [readonly] + boolean Trusted [readwrite] + string Alias [readwrite] |