Skip to main content

Bluetooth Low Energy platform Agnostic Klient

Project description

Bleak Logo Build and Test https://img.shields.io/pypi/v/bleak.svg PyPI - Downloads Documentation Status https://img.shields.io/badge/code%20style-black-000000.svg

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.

Installation

$ pip install bleak

Features

  • Supports Windows 10, version 16299 (Fall Creators Update) or greater

  • Supports Linux distributions with BlueZ >= 5.43

  • OS X/macOS support via Core Bluetooth API, from at least OS X version 10.11

  • Android backend compatible with python-for-android

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 BleakScanner

async def main():
    devices = await BleakScanner.discover()
    for d in devices:
        print(d)

asyncio.run(main())

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 = "2A24"

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

asyncio.run(main(address))

DO NOT NAME YOUR SCRIPT bleak.py! It will cause a circular import error.

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

Project details


Download files

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

Source Distribution

bleak-0.22.3.tar.gz (122.3 kB view details)

Uploaded Source

Built Distribution

bleak-0.22.3-py3-none-any.whl (142.7 kB view details)

Uploaded Python 3

File details

Details for the file bleak-0.22.3.tar.gz.

File metadata

  • Download URL: bleak-0.22.3.tar.gz
  • Upload date:
  • Size: 122.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for bleak-0.22.3.tar.gz
Algorithm Hash digest
SHA256 3149c3c19657e457727aa53d9d6aeb89658495822cd240afd8aeca4dd09c045c
MD5 261eb442ba16707ed00a21265cd337fc
BLAKE2b-256 fb9615750b50c0018338e2cce30de939130971ebfdf4f9d6d56c960f5657daad

See more details on using hashes here.

File details

Details for the file bleak-0.22.3-py3-none-any.whl.

File metadata

  • Download URL: bleak-0.22.3-py3-none-any.whl
  • Upload date:
  • Size: 142.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for bleak-0.22.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1e62a9f5e0c184826e6c906e341d8aca53793e4596eeaf4e0b191e7aca5c461c
MD5 9d75d766d469b0a3c4548c459c7bc3f5
BLAKE2b-256 0ace3adf9e742bb22e4a4b3435f24111cb46a1d12731ba655ee00bb5ab0308cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page