Skip to content

gh-132099: Fix documentation for the BTPROTO_HCI protocol #132118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 13, 2025
Merged

gh-132099: Fix documentation for the BTPROTO_HCI protocol #132118

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9ad9c06
gh-132099: Fix documentation for the BTPROTO_HCI protocol
serhiy-storchaka Apr 5, 2025
1c32480
Apply suggestions from code review
serhiy-storchaka Apr 5, 2025
e17e43e
Update Doc/library/socket.rst
serhiy-storchaka Apr 5, 2025
0e8b750
Update Doc/library/socket.rst
serhiy-storchaka Apr 5, 2025
7bd9d06
Clean up.
serhiy-storchaka Apr 5, 2025
ac626d4
Merge branch 'main' into docs-bluetooth-hci
serhiy-storchaka Apr 13, 2025
113b9b4
More tweaking.
serhiy-storchaka Apr 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,19 +149,25 @@ created. Socket addresses are represented as follows:
:const:`BDADDR_LE_RANDOM`.

.. versionchanged:: 3.14
Added ``cid`` and ``bdaddr_type`` fields.
Added ``cid`` and ``bdaddr_type`` fields.

- :const:`BTPROTO_RFCOMM` accepts ``(bdaddr, channel)`` where ``bdaddr``
is the Bluetooth address as a string and ``channel`` is an integer.

- :const:`BTPROTO_HCI` accepts ``(device_id,)`` where ``device_id`` is
either an integer or a string with the Bluetooth address of the
interface. (This depends on your OS; NetBSD and DragonFlyBSD expect
a Bluetooth address while everything else expects an integer.)
- :const:`BTPROTO_HCI` accepts a format that depends on your OS.

- On Linux it accepts a tuple ``(device_id,)`` where ``device_id``
is an integer specifying the number of the Bluetooth device.
- On FreeBSD, NetBSD and DragonFly BSD it accepts ``bdaddr`` where ``bdaddr``
is a :class:`bytes` object containing the Bluetooth address in a
string format. (ex. ``b'12:23:34:45:56:67'``)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. availability:: Linux, FreeBSD, NetBSD, DragonFlyBSD

Do we want to list officially unsupported os'es here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no availability directive for BTPROTO_L2CAP and BTPROTO_SCO, and I am not sure what we could write there.

.. versionchanged:: 3.2
NetBSD and DragonFlyBSD support added.

.. versionchanged:: 3.13.3
FreeBSD support added.

- :const:`BTPROTO_SCO` accepts ``bdaddr`` where ``bdaddr`` is a
:class:`bytes` object containing the Bluetooth address in a
string format. (ex. ``b'12:23:34:45:56:67'``)
Expand Down Expand Up @@ -662,16 +668,15 @@ Constants
These constants describe the Bluetooth address type when binding or
connecting a :const:`BTPROTO_L2CAP` socket.

.. versionadded:: 3.14
.. versionadded:: 3.14

.. data:: HCI_FILTER
HCI_TIME_STAMP
HCI_DATA_DIR

For use with :const:`BTPROTO_HCI`. :const:`HCI_FILTER` is not
available for NetBSD or DragonFlyBSD. :const:`HCI_TIME_STAMP` and
:const:`HCI_DATA_DIR` are not available for FreeBSD, NetBSD, or
DragonFlyBSD.
For use with :const:`BTPROTO_HCI`. :const:`!HCI_FILTER` is only
available on Linux and FreeBSD. :const:`!HCI_TIME_STAMP` and
:const:`!HCI_DATA_DIR` are only available on Linux.

.. data:: AF_QIPCRTR

Expand Down
Loading