summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
Commit message (Collapse)AuthorAgeFilesLines
* device-api: Add Set propertyLuiz Augusto von Dentz2023-03-101-0/+10
| | | | | This adds Set property so clients are able to identify when a device belongs to a set.
* device-api: Clarify Paired/Bonded documentationLuiz Augusto von Dentz2022-05-041-7/+6
| | | | | This attempt to clarify the distinction of Paired and Bonded properties.
* doc: add "Bonded" flag to dbus propertyZhengping Jiang2022-05-041-1/+11
| | | | | | | | Bonded flag is used to indicate the link key or ltk of the remote device has been stored. Reviewed-by: Sonny Sasaka <sonnysasaka@chromium.org> Reviewed-by: Yun-Hao Chung <howardchung@chromium.org>
* doc/device-api: Add WakeAllowedAbhishek Pandit-Subedi2020-07-071-0/+5
| | | | | Add documentation for WakeAllowed, which allows a device to wake the system from suspend.
* doc/device-api: Add AdvertisingData propertyLuiz Augusto von Dentz2018-05-021-0/+16
| | | | | This adds AdvertisingData which exposes data being advertised which is may be useful for profiles not handled by bluetoothd.
* Add AddressType property for Adapter1 and Device1 interfacesSzymon Janc2017-12-191-0/+13
| | | | | This provides information about address type being used. It is needed for L2CAP sockets and PTS testing purposes.
* device: Don't disable auto-connect for trusted devicesLuiz Augusto von Dentz2017-11-201-3/+3
| | | | | Trusted shall indicate if the device is allowed connect in any circumstance, even if the user has called device.Disconnect.
* doc/device-api: Document behavior of Disconnect method with LELuiz Augusto von Dentz2017-11-201-0/+4
| | | | | If and LE device is disconnected using device.Device method it won't be able to reconnect by itself.
* doc/device-api: Add AdvertisingFlagsPuthikorn Voravootivat2016-10-201-0/+4
| | | | This exposed Advertising Flags to BlueZ Device API
* doc/device-api: Document Connect behavior for dual-modeLuiz Augusto von Dentz2016-08-251-0/+14
| | | | Adds description of how Device1.Connect behave with dual-mode devices.
* core/device: Promote LE related properties to stableLuiz Augusto von Dentz2016-07-291-2/+2
| | | | | | This promotes ManufacturerData, ServiceData, TxPower and ServicesResolved to stable since those might be needed in order to take advantage of the GATT D-Bus APIs.
* doc/device-api: Replace GattServices with ServicesDiscovered propertyLuiz Augusto von Dentz2016-03-141-6/+3
| | | | | | | | | | | | | | GattServices is not really doing was it was meant to do which was to track progress of service discovery since it only worked for the very first time a device is connected but since we no longer remove the attributes an application would have the false impression the service are all resolved by the time it reconnects when in fact the service may have changed. Furthermore object tracking like it is doing has been obsolete by ObjectManager so this propose to replace the service discovery tracking with a boolean property which works both with SDP as well as GATT discovery.
* doc/device-api: Add GattServicesArman Uguray2015-05-051-0/+8
| | | | | | | This patch introduces the GattServices property that contains the object paths of exported GattService1 objects. The purpose of this property is to signal when all GATT services on a remote device have been discovered.
* doc/device-api: Add TxPowerJakub Pawlowski2015-04-231-0/+5
| | | | This adds TxPower from advertisement data.
* doc/device-api: Add ServiceData and ManufacturerDataLuiz Augusto von Dentz2015-04-171-0/+11
| | | | This adds ServiceData and ManufacturerData from advertisement data.
* doc/device-api: Update possible errors for DisconnectProfileJakub Sitnicki2015-01-271-3/+3
| | | | Make API documentation reflect the current implementation.
* doc/device-api: Update possible errors for ConnectProfileJakub Sitnicki2015-01-271-3/+5
| | | | Make API documentation reflect the current implementation.
* doc: Remove bogus DeviceFound signal referenceJohan Hedberg2014-07-291-3/+3
|
* doc: Update RSSI property description.Lukasz Rymanowski2014-05-231-1/+1
| | | | | | RSSI property applies to either inquiry or advertising packets and this should be stated here especially that we plan to add connection RSSI property.
* doc: Add missing Device1.Pair errorJohan Hedberg2013-12-041-0/+1
|
* doc: Document missing errors returned by the Device1 API.Alex Deymo2013-05-101-0/+7
| | | | | | | | | | There were two groups of missing error messages in the documentation: * For org.bluez.Device1.DisconnectProfile: This method could certainly call btd_error_not_supported or btd_error_failed returning those errors. * For org.bluez.Device1.Pair: The pairing process could certainly call new_authentication_return which can return (and actualy does) five other different errors.
* doc: Fix optional properties not marked as suchMikel Astiz2013-04-251-2/+2
| | | | | | | Commit 826023de56896e83f35ae69a73d6a120a2f5b11e made some of the device's properties optional but the documentation was not updated accordingly. More specifically, the properties 'Name' and 'UUIDs' won't be present if the information is not available.
* doc: Add missing device RSSI propertySzymon Janc2013-02-141-0/+5
| | | | RSSI property was not documented in device API.
* doc: Remove CancelConnect function from device APISzymon Janc2013-02-141-5/+3
| | | | This method is not implemented and Disconnect can be used instead.
* doc: Fix device disconnect descriptionSzymon Janc2013-02-141-4/+6
| | | | Document what Disconnect() function actually does.
* doc: Clarify device connect descriptionSzymon Janc2013-02-141-1/+6
| | | | | Describe behaviour when some profiles are already connected. Clarify that it returns success if at least one profile was connected.
* doc: Fix annotation for optional device propertiesMarcel Holtmann2012-12-291-3/+3
|
* doc: Remove individual Device ID propertiesMarcel Holtmann2012-12-291-18/+0
|
* doc: Add entry for modalias propertiesMarcel Holtmann2012-12-291-0/+5
|
* doc: Rephrase the reset handling of device alias propertyMarcel Holtmann2012-12-291-2/+1
|
* doc: Change VendorSource value into a stringMarcel Holtmann2012-12-221-4/+6
|
* doc: Remove non-existent Services Device propertyJohan Hedberg2012-12-201-4/+0
|
* doc: Add missing error returns to Device1.CancelPairingJohan Hedberg2012-12-201-0/+3
|
* doc: Fix minor typo in device-apiJohan Hedberg2012-12-191-1/+1
|
* doc: Remove pointless copyright statements from core APIsMarcel Holtmann2012-12-191-5/+0
|
* doc: Add comment to favor Alias over Name property for devicesMarcel Holtmann2012-12-191-0/+7
|
* doc: Clarify ConnectProfile UUID parameterJohan Hedberg2012-12-181-2/+2
|
* core: Remove DisconnectRequested signalJohan Hedberg2012-12-181-12/+0
| | | | | This signal is not needed anymore thanks to the RequestDisconnect callback of the Profile interface.
* doc: Fix minor formatting issue in device APIJohan Hedberg2012-12-181-0/+1
|
* doc: Remove parameters for device pairing methodMarcel Holtmann2012-12-151-8/+11
|
* core: Remove D-Bus service discovery methodsJohan Hedberg2012-12-131-26/+1
|
* dbus: Rename to org.bluez.Device1Mikel Astiz2012-12-051-1/+1
| | | | | Trivially add the numbering suffix to org.bluez.Device according to the proposal for BlueZ 5.
* doc: Update to match latest BlueZ 5 APIJohan Hedberg2012-10-171-26/+4
|
* doc: Update adapter and device D-Bus APIsJohan Hedberg2012-10-121-0/+9
|
* core: Add initial Device.Pair() implementationJohan Hedberg2012-10-091-0/+18
| | | | This will ultimately replace Adapter.CreatePairedDevice()
* doc: Mark optional properties in Device interfaceLucas De Marchi2012-10-061-7/+7
|
* doc: Add profile API documentationJohan Hedberg2012-09-251-0/+23
|
* core: Add Device.Connect methodJohan Hedberg2012-09-251-0/+12
|
* adapter: Add Appearance property for LE devicesBruna Moreira2012-07-291-0/+4
| | | | | | For LE devices, the Class property is not applicable so it was replaced by the correct one: Appearance property. If no appearance is supplied in Adv Data, the Appearance property is set to zero and icon to null.
* Remove documentation about Node APIGustavo Padovan2012-07-191-38/+0
| | | | Node API was never implemented.