This Module allows reading and writing to GATT descriptors on devices such as fitness trackers, sensors, and anything implementing standard GATT Descriptor behavior.
pygatt provides a Pythonic API by wrapping two different backends:
gatttool command-line utility.Despite the popularity of BLE, we have yet to find a good programming
interface for it on desktop computers. Since most peripherals are
designed to work with smartphones, this space is neglected. One
interactive interface, BlueZ's gatttool, is functional but difficult
to use programmatically. BlueZ itself obviously works, but the interface
leaves something to be desired and only works in Linux.
Python 3.9 or greater
BlueZ 5.18 or greater (with gatttool) - required for the gatttool backend only.
GATTToolBackend requires Linux and sudo (i.e. not Windows compatible)
Install pygatt with pip from PyPI:
::
$ pip install pygattThe BlueZ backend is not supported by default as it requires
pexpect, which can only be installed in a UNIX-based environment. If
you wish to use that backend, install the optional dependencies with:
::
$ pip install "pygatt[GATTTOOL]"Install the latest development version of pygatt with pip:
::
$ pip install git+https://github.com/peplin/pygattThe documentation for pygatt consists of:
samples directoryThe BLEDevice and BLEBackend base classes are the primary interfaces for
users of the library.
100Hz).
The primary API for users of this library is provided by
pygatt.BLEBackend and pygatt.BLEDevice. After initializing an
instance of the preferred backend (available implementations are found
in pygatt.backends, use the BLEBackend.connect method to connect
to a device and get an instance of BLEDevice.
.. code:: python
import pygatt
# The BGAPI backend will attempt to auto-discover the serial device name of the
# attached BGAPI-compatible USB adapter.
adapter = pygatt.BGAPIBackend()
try:
adapter.start()
device = adapter.connect('01:23:45:67:89:ab')
value = device.char_read("a1e8f5b1-696b-4e4c-87c6-69dfe0b0093b")
finally:
adapter.stop()Note that not all backends support connecting to more than 1 device at
at time, so calling BLEBackend.connect again may terminate existing
connections.
Here's the same example using the GATTTool backend. It's identical except for the initialization of the backend:
.. code:: python
import pygatt
adapter = pygatt.GATTToolBackend()
try:
adapter.start()
device = adapter.connect('01:23:45:67:89:ab')
value = device.char_read("a1e8f5b1-696b-4e4c-87c6-69dfe0b0093b")
finally:
adapter.stop()This example uses the gatttool backend to connect to a device with a specific MAC address, subscribes for notifications on a characteristic, and prints the data returned in each notification.
.. code:: python
import pygatt
from binascii import hexlify
adapter = pygatt.GATTToolBackend()
def handle_data(handle, value):
"""
handle -- integer, characteristic read handle the data was received on
value -- bytearray, the data returned in the notification
"""
print("Received data: %s" % hexlify(value))
try:
adapter.start()
device = adapter.connect('01:23:45:67:89:ab')
device.subscribe("a1e8f5b1-696b-4e4c-87c6-69dfe0b0093b",
callback=handle_data)
# The subscription runs on a background thread. You must stop this main
# thread from exiting, otherwise you will not receive any messages, and
# the program will exit. Sleeping in a while loop like this is a simple
# solution that won't eat up unnecessary CPU, but there are many other
# ways to handle this in more complicated program. Multi-threaded
# programming is outside the scope of this README.
while True:
time.sleep(10)
finally:
adapter.stop()While debugging software using pygatt, it is often useful to see what's happening inside the library. You can enable debugging logging and have it printed to your terminal with this code:
.. code:: python
import pygatt
import logging
logging.basicConfig()
logging.getLogger('pygatt').setLevel(logging.DEBUG)If you are having trouble connecting to a device, it may use random addressing. Try changing the connection setup code to:
.. code:: python
device = adapter.connect('01:23:45:67:89:ab', address_type=pygatt.BLEAddressType.random)If you are experiencing unexplained timeouts with the gatttool backend, you may need to increase the supervisor timeouts:
::
echo 1000 > /sys/kernel/debug/bluetooth/hci0/supervision_timeoutCan't find BGAPI device in Windows
You may need to explicitly specify the COM port of your BGAPI-compatible
device in windows, e.g.:
.. code:: python
adapter = pygatt.BGAPIBackend(serial_port='COM9')
If you provide the COM port name, but still get an error such as
``WindowsError(2, 'The system cannot find the file specified.')``, try
changing the COM port of the device to a value under 10, e.g. ``COM9``.
Authors
-------
- Jeff Rowberg @jrowberg https://github.com/jrowberg/bglib
- Greg Albrecht @ampledata https://github.com/ampledata/pygatt
- Christopher Peplin @peplin https://github.com/peplin/pygatt
- Morten Kjaergaard @mkjaergaard https://github.com/mkjaergaard/pygatt
- Michael Saunby @msaunby https://github.com/msaunby/ble-sensor-pi
- Steven Sloboda https://github.com/sloboste
- Ilya Sukhanov @IlyaSukhanov
- @dcliftreaves
- Jonathan Dan
- Ilann Adjedj
- Ralph Hempel
- Rene Jacobsen
- Marcus Georgi
- Alexandre Barachant
- Michel Rivas Hernandez
- Jean Regisser
- David Martin
- Pieter Hooimeijer
- Thomas Li Fredriksen
- Markus Proeller
- lachtanek
- Andrea Merello
- Richard Mitchell
- Daniel Santos
- Andrew Connell
- Jakub Hrabec
- John Schoenberger
- Georgi Boiko
- Jose Phillips
Releasing to PyPI
-----------------
For the maintainers of the project, when you want to make a release:
- Merge all of the changes into ``master``.
- Update the version in ``setup.py``.
- Update the ``CHANGELOG.mkd``
- Tag the commit and push to GitHub (will need to push to a separate
branch of PR first since ``master`` is a protected branch).
- Travis CI will take care of the rest - it will build and deploy
tagged commits to PyPI automatically.
License
-------
Copyright 2015 Stratos Inc. and Orion Labs
Apache License, Version 2.0 and MIT License. See LICENSE.