Commit Graph

1090 Commits

Author SHA1 Message Date
Vibhav Pant
44a1930479 org.bluez.Device: Add documentation for GetServiceRecords() 2024-09-19 13:01:52 -04:00
Vibhav Pant
bf6bfc3356 org.bluez.Adapter: Add documentation for the Connectable property. 2024-09-19 12:57:26 -04:00
Luiz Augusto von Dentz
0ea4e4d52c doc: Remove Pygments dependency from manpage
This patch removes the Pygments dependency from l2cap/rfcomm.rst file.
When the code-block type is specified, the rst2man throws a warning
asking for Pygments package.

Fixes: https://github.com/bluez/bluez/issues/950
2024-09-18 14:48:06 -04:00
Frédéric Danis
7aa245979d doc: Add description of org.bluez.obex.Image
This new interface allows to get the image referenced in the audio
metadata ImgHandle available in org.bluez.MediaPlayer track properties.
The image handle is only available in track info if an OBEX session is
connected to the ObexPort port provided in  org.bluez.MediaPlayer
properties.
2024-09-17 11:38:03 -04:00
Frédéric Danis
1a681aa014 obexd: Add BIP client for AVRCP cover art download
The cover art image handle is available in the metadata of the track
when the OBEX BIP session is connected to the PSM port provided
in AVRCP SDP record and available as org.bluez.MediaPlayer property.

This service allows to get the thumbnail.
2024-09-17 10:54:30 -04:00
Frédéric Danis
5cd301e888 player: Add image handle support property
This is part of the metadata when the AVRCP target supports covert
art download and a OBEX BIP session is connected.
The image handle references the cover art associated to the track,
and is valid only during OBEX BIP session.
2024-09-16 13:18:11 -04:00
Frédéric Danis
4c05a0ff41 player: Add OBEX PSM port for cover art support
This parse the AVRCP Target SDP record for the L2CAP PSM to use with
the OBEX session to get the cover art.
2024-09-16 13:18:10 -04:00
Frédéric Danis
5d7d3ac25b obexd: Add PSM support to session create
An OBEX session can be connected to a RFCOMM channel or a L2CAP PSM.
2024-09-16 13:18:09 -04:00
Vlad Pruteanu
b48d366458 doc/media: Make QoS property readwrite
Update the QoS property to allow for write, so that fields such as
BCode can be updated.
2024-09-09 12:06:20 -04:00
Vlad Pruteanu
5c9431fc2b doc/media: Add Encryption and BCode fields to QoS property
This adds the missing QoS fields, Encryption and BCode.
2024-09-09 12:06:17 -04:00
Luiz Augusto von Dentz
c315b42e05 device: Promote Device.{AdvertisingData, AdvertisingFlags} to stable
This promotes AdvertisingData and AdvertisingFlags to stable so they can
be used by upper layers without having to enable experimental.
2024-08-14 14:44:19 -04:00
Luiz Augusto von Dentz
5236809407 org.bluez.GattCharacteristic: Add missing link option to ReadValue
Just like GattDescriptor.ReadValue characteristics also support link
option which indicates in what bearer the operation is taken place.
2024-08-13 10:33:32 -04:00
Vlad Pruteanu
c7e79fa8bf doc/media: Add 'Unselect' method
This adds the documentation for a new method, exclusive to transports
created by the Broadcast Sink. It would allow the user to terminate the
sync to a BIS, via a 2 step process. The first step is the call to this
method, which changes the transport's state to idle, with the second step
being done by the audio server which detects this change and releases
the transport.
2024-08-01 04:25:23 -04:00
Vlad Pruteanu
d7b7f3a395 doc/media: Add 'broadcasting' state and 'Select' method
This adds a new state for transports created by the Broadcast
Sink. Such transports will remain  in the 'idle' state until the
user calls 'Select' on them, at which point they will be moved to
'broadcasting'. This allows the user to select the desired BIS as
the audio server automatically acquires transports that are in this
state.
2024-08-01 04:25:17 -04:00
Iulia Tanasescu
66a76c268d doc: Add initial MediaAssistant rst
This adds initial documentation for the MediaAssistant D-Bus API, to
be used by a Broadcast Assistant application to interract with the
BlueZ implementation (BASS Client).
2024-07-09 10:35:53 -04:00
Luiz Augusto von Dentz
1a51250a7e org.bluez.LEAdvertisement: Promote experimental properties to stable
This promotes experimental properties to stable since they have been in
use for quite a while without any changes.
2024-06-28 12:46:38 -04:00
Luiz Augusto von Dentz
098ff00dea doc: Add initial RFCOMM(7) documentation
This adds initial documentation for RFCOMM sockets.
2024-05-23 13:22:19 -04:00
Luiz Augusto von Dentz
f5e59893e6 doc: Add initial L2CAP(7) documentation
This adds initial documentation for L2CAP sockets.
2024-05-23 13:22:14 -04:00
Luiz Augusto von Dentz
129b191663 org.bluez.Gatt: Add org.bluez.Error.ImproperlyConfigured error to
WriteValue

Some attributes may require to generate
BT_ERROR_CCC_IMPROPERLY_CONFIGURED when its CCC is not properly
configured so this adds the possibility to generate it by replying with
org.bluez.Error.ImproperlyConfigured error to WriteValue.
2024-04-26 17:41:11 -04:00
Luiz Augusto von Dentz
07efa6d35b org.bluez.MediaEndpoint: Add ChannelAllocation to SelectProperties
This adds ChannelAllocation to SelectProperties which when set can be
used by Endpoint implementation in the response as part of
Capabilities, note that it is not mandatory to use it so the Endpoint
may have its on logic to allocate channels.
2023-12-15 11:08:29 -05:00
Luiz Augusto von Dentz
345ad5e352 doc/obex-*-api: Rename to org.bluez.obex.*.rst
This renames obex-*-api.txt to org.bluez.obex.*.rst and generate
manpages org.bluez.obex.*.5.
2023-10-12 13:20:44 -07:00
Luiz Augusto von Dentz
ee27626c7a doc/admin-policy-api: Rename to org.bluez.AdminPolicy*.rst
This renames admin-policy-api.txt to org.bluez.AdminPolicy*.rst and
generate manpages org.bluez.AdminPolicy*.5.
2023-10-09 16:02:02 -07:00
Luiz Augusto von Dentz
87151d1904 doc/advertisement-monitor-api: Rename to org.bluez.AdvertisementMonitor*.rst
This renames advertisement-monitor-api.txt to
org.bluez.AdvertisementMonitor*.rst and generate manpages
org.bluez.AdvertisementMonitor*.5.
2023-10-09 15:58:42 -07:00
Luiz Augusto von Dentz
cba68babe1 doc/battery-api: Rename to org.bluez.Battery*.rst
This renames battery-api.txt to org.bluez.Battery*.rst and generate
manpages org.bluez.Battery*.5.
2023-10-09 15:55:25 -07:00
Luiz Augusto von Dentz
c6c412d6cc doc/gatt-api: Rename to org.bluez.Gatt*.rst
This renames gatt-api.txt to org.bluez.Gatt*.rst and generate manpages
org.bluez.Gatt*.5.
2023-10-09 15:51:16 -07:00
Luiz Augusto von Dentz
dec59a07fb doc/advertising-api: Rename to org.bluez.LEAdvertis*.rst
This renames advertising-api.txt to org.bluez.LEAdvertis*.rst and
generate manpages org.bluez.LEAdvertis*.5.
2023-10-09 15:47:58 -07:00
Luiz Augusto von Dentz
cfc76016b4 doc/input-api: Rename to org.bluez.Input.rst
This renames input-api.txt to org.bluez.Input.rst and generate manpages
org.bluez.Input.5.
2023-10-09 15:44:36 -07:00
Luiz Augusto von Dentz
6481b9095b doc/network-api: Rename to org.bluez.Network{Server}.rst
This renames network-api.txt to org.bluez.Network{Server}.rst and
generate manpages org.bluez.Network{Server}.5.
2023-10-09 15:02:05 -07:00
Luiz Augusto von Dentz
c5729e61b1 doc/profile-api: Rename to org.bluez.Profile{Manager}.rst
This renames profile-api.txt to org.bluez.Profile{Manager}.rst and
generate manpages org.bluez.Profile{Manager}.5.
2023-10-09 14:58:37 -07:00
Luiz Augusto von Dentz
42e2934c23 doc/agent-api: Rename to org.bluez.Agent{Manager}.rst
This renames agent-api.txt to org.bluez.Agent{Manager}.rst and generate
manpages org.bluez.Agent{Manager}.5.
2023-10-09 14:55:56 -07:00
Luiz Augusto von Dentz
359132ba89 doc/device-api: Rename to org.bluez.Device.rst
This renames device-api.txt to org.bluez.Device.rst and generate a
manpage org.bluez.Device.5.
2023-10-05 17:41:44 -07:00
Luiz Augusto von Dentz
6f7effa453 doc/adapter-api: Rename to org.bluez.Adapter.rst
This renames adapter-api.txt to org.bluez.Adapter.rst and generate a
manpage org.bluez.Adapter.5.
2023-10-05 17:41:44 -07:00
Pauli Virtanen
85460c32d1 doc: mark battery APIs non-experimental
Remove experimental status also from documentation.
2023-10-05 13:53:12 -07:00
Vibhav Pant
6393012d46 adapter-api: Add Manufacturer and Version properties
This adds Manufacturer and Version properties to org.bluez.Adapter1
interface.
2023-10-04 12:35:28 -07:00
Pauli Virtanen
6683305d82 doc: clarify org.bluez.MediaEndpoint documentation
Document the actual input and output parameter values used in
SelectProperties. These differ from SetConfiguration.

Mention SelectProperties is used for unicast only.

Document SetConfiguration input parameters.
2023-10-03 14:15:12 -07:00
Luiz Augusto von Dentz
32b6d7394e doc/set-api: Rename to org.bluez.DeviceSet
This renames set-api.rst to org.bluez.DeviceSet.rst and generate a
manpage org.bluez.DeviceSet.5.
2023-10-03 14:15:12 -07:00
Luiz Augusto von Dentz
32afb9df42 doc/MediaEndpoint: Move QoS capabilities to its own dict property
This moves QoS capabilities to its own dict property just as it was done
for MediaTransport QoS configuration.
2023-09-28 17:25:43 -07:00
Luiz Augusto von Dentz
3ca45476fa doc/media: Convert media-api.rst into manpages
This splits media-api.rst into org.bluez.Media<interface>.rst and
generate manpages for them.
2023-09-28 17:25:43 -07:00
Luiz Augusto von Dentz
676e8b0cf1 media-api: Update to reflect the last code changes
This reflect the last code changes adding the missing Broadcast
properties.
2023-09-28 17:25:43 -07:00
Luiz Augusto von Dentz
f479c2404e media-api: Convert to ReStructuredText format
This converts media-api.txt to media-api.rst.
2023-09-19 17:09:50 -07:00
Luiz Augusto von Dentz
530afa43ec media-api: Make QoS a single property
This moves QoS related properties to a single dictionary.
2023-08-28 16:32:11 -07:00
Luiz Augusto von Dentz
d68bfb6564 doc/test-runner: Update documentation using rst format
This updates test-runner documentation with a few examples using rst
format.
2023-08-15 12:08:34 -07:00
Simon Mikuda
255ef572ca adapter: Update ConnectDevice documentation 2023-07-31 10:33:25 -07:00
Simon Mikuda
cda5549f24 gatt-client: Add read-only handles to dbus
This can be usefull when mapping names for services and characteristics
to their handle numbers.
2023-07-28 15:36:19 -07:00
Pauli Virtanen
80f2fa14b6 doc/tester-config: enable DEBUG_KERNEL, PROVE_RCU, DEBUG_ATOMIC_SLEEP
Add more lock/sleep debugging to the default tester config.

Enable DEBUG_KERNEL since olddefconfig won't enable PROVE_LOCKING
without it. Enable PROVE_RCU to also check RCU usage. Enable
DEBUG_ATOMIC_SLEEP to catch those as well.
2023-07-05 10:48:31 -07:00
Luiz Augusto von Dentz
98383b917a mgmt-api: Update Device Found Event documentation
This updates Device Found Event documentation to mention the new flag
introduced to track when the event is generated due a interleaved Scan
Response that couldn't be merged.
2023-06-20 13:33:50 -07:00
Silviu Florian Barbulescu
f808fa0653 doc: Update Docs for BAP broadcast source
This adds broadcast properties to the SetConfiguration method and
bits for Broadcast support to the Supported_Settings bitmask.
2023-05-26 14:56:12 -07:00
Guiting Shen
d361604594 obexd: AuthorizePush: Support to return folder name for file storage
The obex agent usually returns the full path by getting the default
folder and filename from the Filename property of the transfer object
which is not convenient.

The patch helps that the obex agent can return the folder name suffixed
with '/' or new full path or even null which will use the default name
if new_name is NULL and the default folder if the new_folder is NULL in
opp_chkput().
2023-04-20 16:15:16 -07:00
Luiz Augusto von Dentz
23bc47437a advertising-api: Add rsi to SupportedIncludes
This adds "rsi" as possible value to SupportedIncludes so when it is
available it means client and set it on its Includes property so a
proper RSI is generated and included as part of the Advertising Data.
2023-04-05 15:56:11 -07:00
Pauli Virtanen
39260c3cfa doc: describe new ISO Transport properties
Document the currently undocumented transport QoS properties.
2023-03-17 09:36:01 -07:00