diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/adapter-api.txt | 101 | ||||
| -rw-r--r-- | doc/device-api.txt | 50 | 
3 files changed, 153 insertions, 0 deletions
| 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 <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> + +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 <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> + +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] | 
