From 19e7dbecf4b38bf64458a34ea005a8aca0bc8974 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 7 Mar 2008 14:28:43 +0000 Subject: Move documentation into doc directory --- doc/Makefile.am | 2 + doc/adapter-api.txt | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/device-api.txt | 50 +++++++++++++++++++++++++ hcid/adapter-api.txt | 101 --------------------------------------------------- hcid/device-api.txt | 50 ------------------------- 5 files changed, 153 insertions(+), 151 deletions(-) create mode 100644 doc/adapter-api.txt create mode 100644 doc/device-api.txt delete mode 100644 hcid/adapter-api.txt delete mode 100644 hcid/device-api.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index 02742923..b66ceb7f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,2 +1,4 @@ +EXTRA_DIST = adapter-api.txt device-api.txt + MAINTAINERCLEANFILES = Makefile.in diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt new file mode 100644 index 00000000..1f9cdd88 --- /dev/null +++ b/doc/adapter-api.txt @@ -0,0 +1,101 @@ +BlueZ D-Bus Adapter API description +*********************************** + +Copyright (C) 2006-2008 Marcel Holtmann +Copyright (C) 2005-2006 Johan Hedberg +Copyright (C) 2005-2006 Claudio Takahasi +Copyright (C) 2005-2006 Eduardo Rocha +Copyright (C) 2008-2008 Luiz von Dentz + +Adapter hierarchy +================= + +Service org.bluez +Interface org.bluez.Adapter +Object path /org/bluez/{hci0,hci1,...} + +Methods dict GetProperties() + + TBD + + void SetProperty(string name, variant value) + + TBD + + array{object} ListDevices() + + TBD + + void DiscoverDevices() + + This method starts the device discovery procedure. This + includes an inquiry procedure and remote device name + resolving. + + On start up this process will generate a DiscoveryStarted + signal and then return RemoteDeviceFound and also + RemoteNameUpdated signals. If the procedure has been + finished an DiscoveryCompleted signal will be sent. + + Possible errors: org.bluez.Error.NotReady + org.bluez.Error.Failed + org.bluez.Error.InProgress + org.bluez.Error.NoSuchAdapter + + void CancelDiscovery() + + This method will cancel any previous DiscoverDevices + or DiscoverDevicesWithoutNameResolving actions. + + Possible errors: org.bluez.Error.NotReady + org.bluez.Error.Failed + org.bluez.Error.NotAuthorized + org.bluez.Error.NoSuchAdapter + + object CreateDevice(string address) + + TBD + + object CreateDeviceWithAgent(string address, object path) + + TBD + + void RemoveDevice(object path) + +Signals DeviceCreated(object path) + + TBD + + DeviceRemoved(object path) + + TBD + + PropertyChanged(string name, variant value) + + TBD + + DiscoveryStarted() + + TBD + + DiscoveryCompleted() + + TBD + + DeviceFound(string address, dict values) + + TBD + + DeviceDisappeared(string address) + + TBD + +Properties string Name [readonly] + + string Address [readonly] + + boolean PeriodicInquiry [readwrite] + + string Mode [readwrite] + + uint32 DiscoverableTimeout [readwrite] diff --git a/doc/device-api.txt b/doc/device-api.txt new file mode 100644 index 00000000..82de22f4 --- /dev/null +++ b/doc/device-api.txt @@ -0,0 +1,50 @@ +BlueZ D-Bus Device API description +********************************** + +Copyright (C) 2008-2008 Marcel Holtmann +Copyright (C) 2008-2008 Johan Hedberg +Copyright (C) 2008-2008 Claudio Takahasi +Copyright (C) 2008-2008 Luiz von Dentz + +Adapter hierarchy +================= + +Service org.bluez +Interface org.bluez.Device +Object path /org/bluez/{hci0,hci1,...}/{dev_XX_XX_XX_XX_XX_XX...} + +Methods dict GetProperties() + + TBD + + void SetProperty(string name, variant value) + + TBD + + void Disconnect() + + TBD + +Signals PropertyChanged(string name, variant value) + + TBD + + DisconnectRequested() + + TBD + +Properties string Name [readonly] + + string Address [readonly] + + string Class [readonly] + + array{string} UUIDS [readwrite] + + boolean Paired [readonly] + + boolean Trusted [readwrite] + + boolean Connected [readonly] + + string Alias [readwrite] diff --git a/hcid/adapter-api.txt b/hcid/adapter-api.txt deleted file mode 100644 index 1f9cdd88..00000000 --- a/hcid/adapter-api.txt +++ /dev/null @@ -1,101 +0,0 @@ -BlueZ D-Bus Adapter API description -*********************************** - -Copyright (C) 2006-2008 Marcel Holtmann -Copyright (C) 2005-2006 Johan Hedberg -Copyright (C) 2005-2006 Claudio Takahasi -Copyright (C) 2005-2006 Eduardo Rocha -Copyright (C) 2008-2008 Luiz von Dentz - -Adapter hierarchy -================= - -Service org.bluez -Interface org.bluez.Adapter -Object path /org/bluez/{hci0,hci1,...} - -Methods dict GetProperties() - - TBD - - void SetProperty(string name, variant value) - - TBD - - array{object} ListDevices() - - TBD - - void DiscoverDevices() - - This method starts the device discovery procedure. This - includes an inquiry procedure and remote device name - resolving. - - On start up this process will generate a DiscoveryStarted - signal and then return RemoteDeviceFound and also - RemoteNameUpdated signals. If the procedure has been - finished an DiscoveryCompleted signal will be sent. - - Possible errors: org.bluez.Error.NotReady - org.bluez.Error.Failed - org.bluez.Error.InProgress - org.bluez.Error.NoSuchAdapter - - void CancelDiscovery() - - This method will cancel any previous DiscoverDevices - or DiscoverDevicesWithoutNameResolving actions. - - Possible errors: org.bluez.Error.NotReady - org.bluez.Error.Failed - org.bluez.Error.NotAuthorized - org.bluez.Error.NoSuchAdapter - - object CreateDevice(string address) - - TBD - - object CreateDeviceWithAgent(string address, object path) - - TBD - - void RemoveDevice(object path) - -Signals DeviceCreated(object path) - - TBD - - DeviceRemoved(object path) - - TBD - - PropertyChanged(string name, variant value) - - TBD - - DiscoveryStarted() - - TBD - - DiscoveryCompleted() - - TBD - - DeviceFound(string address, dict values) - - TBD - - DeviceDisappeared(string address) - - TBD - -Properties string Name [readonly] - - string Address [readonly] - - boolean PeriodicInquiry [readwrite] - - string Mode [readwrite] - - uint32 DiscoverableTimeout [readwrite] diff --git a/hcid/device-api.txt b/hcid/device-api.txt deleted file mode 100644 index 82de22f4..00000000 --- a/hcid/device-api.txt +++ /dev/null @@ -1,50 +0,0 @@ -BlueZ D-Bus Device API description -********************************** - -Copyright (C) 2008-2008 Marcel Holtmann -Copyright (C) 2008-2008 Johan Hedberg -Copyright (C) 2008-2008 Claudio Takahasi -Copyright (C) 2008-2008 Luiz von Dentz - -Adapter hierarchy -================= - -Service org.bluez -Interface org.bluez.Device -Object path /org/bluez/{hci0,hci1,...}/{dev_XX_XX_XX_XX_XX_XX...} - -Methods dict GetProperties() - - TBD - - void SetProperty(string name, variant value) - - TBD - - void Disconnect() - - TBD - -Signals PropertyChanged(string name, variant value) - - TBD - - DisconnectRequested() - - TBD - -Properties string Name [readonly] - - string Address [readonly] - - string Class [readonly] - - array{string} UUIDS [readwrite] - - boolean Paired [readonly] - - boolean Trusted [readwrite] - - boolean Connected [readonly] - - string Alias [readwrite] -- cgit