1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
bleak
=====
Bleak is an acronym for Bluetooth Low Energy platform Agnostic Klient.
* Free software: MIT license
* Documentation: https://bleak.readthedocs.io.
Bleak is a GATT client software, capable of connecting to BLE devices
acting as GATT servers. It is designed to provide a asynchronous,
cross-platform Python API to connect and communicate with e.g. sensors.
Operating System Support
------------------------
Bleak aims to work on most major operating systems via platform-specific backends.
Tier 1 support
~~~~~~~~~~~~~~
The following operating systems are supported and tested by the maintainers:
* Linux distributions with BlueZ >= 5.55
* Mac support via Core Bluetooth API, from at least macOS version 10.15
* Windows 10, version 16299 (Fall Creators Update) or greater
Tier 2 support
~~~~~~~~~~~~~~
The following operating systems are supported by the community, but not actively
tested by the maintainers:
* Android via Python4Android.
3rd party backends
~~~~~~~~~~~~~~~~~~
The following backends are implemented and maintained by 3rd parties:
* Bumble (a full Bluetooth stack implemented in Python) at `<https://github.com/vChavezB/bleak-bumble/>`_.
* ESPHome Bluetooth Proxy at `<https://github.com/Bluetooth-Devices/bleak-esphome>`_.
* Pythonista on iOS at `<https://github.com/o-murphy/bleak-pythonista>`_.
Features
--------
* Scan for devices advertising over BLE.
* Get name, service uuids, service data, manufacturer-specific data, transmit
power and RSSI from advertising packets.
* Connect to BLE peripherals.
* Read and write GATT characteristics and descriptors.
* Subscribe to notifications/indications from characteristics.
* Initiate pairing/bonding with devices (platform dependent).
Contents:
.. toctree::
:maxdepth: 2
installation
usage
api/index
backends/index
troubleshooting
contributing
authors
history
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
