Skip to content

Commit 666c85a

Browse files
authored
Update BlueZ documentation links (#1480)
BlueZ changed their docs from txt to rst so update the links accordingly.
1 parent a2d677e commit 666c85a

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

bleak/backends/bluezdbus/advertisement_monitor.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
---------------------
44
55
This module contains types associated with the BlueZ D-Bus `advertisement
6-
monitor api <https://github.com/bluez/bluez/blob/master/doc/advertisement-monitor-api.txt>`.
6+
monitor api <https://github.com/bluez/bluez/blob/master/doc/org.bluez.AdvertisementMonitor.rst>`.
77
"""
88

99
import logging
@@ -22,7 +22,7 @@ class OrPattern(NamedTuple):
2222
"""
2323
BlueZ advertisement monitor or-pattern.
2424
25-
https://github.com/bluez/bluez/blob/master/doc/advertisement-monitor-api.txt
25+
https://github.com/bluez/bluez/blob/master/doc/org.bluez.AdvertisementMonitor.rst#arrayuint8-uint8-arraybyte-patterns-read-only-optional
2626
"""
2727

2828
start_position: int

bleak/backends/bluezdbus/defs.py

+8-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424

2525
# D-Bus properties for interfaces
26-
# https://github.com/bluez/bluez/blob/master/doc/adapter-api.txt
26+
# https://github.com/bluez/bluez/blob/master/doc/org.bluez.Adapter.rst
2727

2828

2929
class Adapter1(TypedDict):
@@ -43,7 +43,7 @@ class Adapter1(TypedDict):
4343
ExperimentalFeatures: List[str]
4444

4545

46-
# https://github.com/bluez/bluez/blob/master/doc/advertisement-monitor-api.txt
46+
# https://github.com/bluez/bluez/blob/master/doc/org.bluez.AdvertisementMonitor.rst
4747

4848

4949
class AdvertisementMonitor1(TypedDict):
@@ -56,20 +56,23 @@ class AdvertisementMonitor1(TypedDict):
5656
Patterns: List[Tuple[int, int, bytes]]
5757

5858

59+
# https://github.com/bluez/bluez/blob/master/doc/org.bluez.AdvertisementMonitorManager.rst
60+
61+
5962
class AdvertisementMonitorManager1(TypedDict):
6063
SupportedMonitorTypes: List[str]
6164
SupportedFeatures: List[str]
6265

6366

64-
# https://github.com/bluez/bluez/blob/master/doc/battery-api.txt
67+
# https://github.com/bluez/bluez/blob/master/doc/org.bluez.Battery.rst
6568

6669

6770
class Battery1(TypedDict):
6871
SupportedMonitorTypes: List[str]
6972
SupportedFeatures: List[str]
7073

7174

72-
# https://github.com/bluez/bluez/blob/master/doc/device-api.txt
75+
# https://github.com/bluez/bluez/blob/master/doc/org.bluez.Device.rst
7376

7477

7578
class Device1(TypedDict):
@@ -99,7 +102,7 @@ class Device1(TypedDict):
99102
AdvertisingData: Dict[int, bytes]
100103

101104

102-
# https://github.com/bluez/bluez/blob/master/doc/gatt-api.txt
105+
# https://github.com/bluez/bluez/blob/master/doc/org.bluez.GattService.rst
103106

104107

105108
class GattService1(TypedDict):

bleak/backends/bluezdbus/scanner.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class BlueZDiscoveryFilters(TypedDict, total=False):
1919
Dictionary of arguments for the ``org.bluez.Adapter1.SetDiscoveryFilter``
2020
D-Bus method.
2121
22-
https://github.com/bluez/bluez/blob/master/doc/adapter-api.txt
22+
https://github.com/bluez/bluez/blob/master/doc/org.bluez.Adapter.rst#void-setdiscoveryfilterdict-filter
2323
"""
2424

2525
UUIDs: List[str]
@@ -93,7 +93,7 @@ class BleakScannerBlueZDBus(BaseBleakScanner):
9393
9494
For possible values for `filters`, see the parameters to the
9595
``SetDiscoveryFilter`` method in the `BlueZ docs
96-
<https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/adapter-api.txt?h=5.48&id=0d1e3b9c5754022c779da129025d493a198d49cf>`_
96+
<https://github.com/bluez/bluez/blob/master/doc/org.bluez.Adapter.rst#void-setdiscoveryfilterdict-filter>`_
9797
9898
Args:
9999
detection_callback:
@@ -201,7 +201,7 @@ def set_scanning_filter(self, **kwargs) -> None:
201201
202202
For possible values for `filters`, see the parameters to the
203203
``SetDiscoveryFilter`` method in the `BlueZ docs
204-
<https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/adapter-api.txt?h=5.48&id=0d1e3b9c5754022c779da129025d493a198d49cf>`_
204+
<https://github.com/bluez/bluez/blob/master/doc/org.bluez.Adapter.rst#void-setdiscoveryfilterdict-filter>`_
205205
206206
See variant types here: <https://python-dbus-next.readthedocs.io/en/latest/type-system/>
207207

0 commit comments

Comments
 (0)