Skip to main content

Bluetooth Low Energy platform Agnostic Klient

Project description

bleak

Bleak Logo

https://img.shields.io/pypi/v/bleak.svg https://img.shields.io/travis/hbldh/bleak.svg https://ci.appveyor.com/api/projects/status/ujrddq7n2uqqy3bh?svg=true Documentation Status Updates

** This is a fork of the original Bleak library ** by Henrik Blidh, with some modifications to support my needs for my BrickNil project. It has been packaged up for distribution with that project on PyPI. All credit to Henrik for his development of this wonderful asyncio package.

Also credit is due to David Lechner for his work on getting Windows 10 support working.

Bleak is an acronym for Bluetooth Low Energy platform Agnostic Klient.

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.

Be warned: Bleak is still in an early state of implementation.

Installation

$ pip install bleak

Features

  • Supports Windows 10, version 16299 (Fall Creators Update)
  • Supports Linux distributions with BlueZ >= 5.43
  • Plans on macOS support via Core Bluetooth API (see develop branch for progress)

Bleak supports reading, writing and getting notifications from GATT servers, as well as a function for discovering BLE devices.

Usage

To discover Bluetooth devices that can be connected to:

import asyncio
from bleak import discover

async def run():
    devices = await discover()
    for d in devices:
        print(d)

loop = asyncio.get_event_loop()
loop.run_until_complete(run())

Connect to a Bluetooth device and read its model number:

import asyncio
from bleak import BleakClient

address = "24:71:89:cc:09:05"
MODEL_NBR_UUID = "00002a24-0000-1000-8000-00805f9b34fb"

async def run(address, loop):
    async with BleakClient(address, loop=loop) as client:
        model_number = await client.read_gatt_char(MODEL_NBR_UUID)
        print("Model Number: {0}".format("".join(map(chr, model_number))))

loop = asyncio.get_event_loop()
loop.run_until_complete(run(address, loop))

See examples folder for more code, among other example code for connecting to a TI SensorTag CC2650

History

0.3.1 (2019-04-01)

  • Win10 support
  • Changes to get more device information

0.2.4 (2018-11-30)

  • Fix for issue #52: Timing issue getting characteristics
  • Additional fix for issue #51.
  • Bugfix for string method for BLEDevice.

0.2.3 (2018-11-28)

  • Fix for issue #51: dpkg-query not found on all Linux systems

0.2.2 (2018-11-08)

  • Made it compliant with Python 3.5 by removing f-strings

0.2.1 (2018-06-28)

  • Improved logging on .NET discover method
  • Some type annotation fixes in .NET code

0.2.0 (2018-04-26)

  • Project added to Github
  • First version on PyPI.
  • Working Linux (BlueZ DBus API) backend.
  • Working Windows (UWP Bluetooth API) backend.

0.1.0 (2017-10-23)

  • Bleak created.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bricknil-bleak, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size bricknil_bleak-0.3.1-py2.py3-none-any.whl (37.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page