mirror of
https://git.kernel.org/pub/scm/bluetooth/bluez.git
synced 2024-11-17 09:14:32 +08:00
Add new D-Bus API documentation.
This commit is contained in:
parent
f65e1c7a1f
commit
ca2431c284
97
hcid/adapter-api.txt
Normal file
97
hcid/adapter-api.txt
Normal file
@ -0,0 +1,97 @@
|
||||
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
|
||||
|
||||
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]
|
50
hcid/device-api.txt
Normal file
50
hcid/device-api.txt
Normal file
@ -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]
|
Loading…
Reference in New Issue
Block a user