Skip to main content

Python library for Bluetooth Low Energy (BLE) on Linux

Project description

Build Status PyPI Version MIT License docs

A simple Python interface to BlueZ stack

Name and aim

The aim of this library is to provide an API to access to Bluez with zero boilerplate code.

Goal

To provide a simplified API to people that want to use Bluetooth functionality in their code. The library will use calls to the BlueZ D-Bus API and use ‘sensible’ defaults to help with that simplification. It aims to support the ability to create interesting STEM activities without needing to explain the BlueZ API or write an event loop.

In addition to the API, it will contain examples of how to connect to common Bluetooth Smart (BLE) objects around them (or at least easily accessible to them). These examples will need to be written without the need to sign (or break) non-disclosure agreements.

Status

While we want this to be easy to use it does not mean it easy to create. This library is still in the early stages so things might change and break. Apologies in advance! We will try to make it as stable as possible. However much of the functionality that is in BlueZ is still flagged as experimental. The library assumes you are using a Linux release with BlueZ 5.50. For example Raspberry Pi OS Buster

Getting Started

If you are here for the time, and especially if you are new to Bluetooth Low Energy, then a tutorial might be a good place to start. The following tutorial has been created based on the readily available hardware of a Raspberry Pi and a micro:bit. More details available at: https://ukbaz.github.io/howto/ubit_workshop.html

Examples

There are some other examples in the library if you are feeling adventurous

Adapter

adapter_example.py

This will check that it can find the Bluetooth adapter on the computer running the code. It will print to screen various information and check it is powered before scanning for nearby devices

GATT Client (Central role)

microbit_poll.py

This example uses the micro:bit API that has been written in bluezero. You will need a buzzer attached to pin 0 to get play_beep to work.

Beacon

eddystone_url_beacon.py

A Simple Eddystone URL beacon. You can be read the URL being broadcast with any Physical Web application on your Phone

Scanner

eddystone_scanner.py

This example scans for beacons using the common beacon formats of Eddystone URL, Eddystone UID, AltBeacon and iBeacon.

GATT Server (Peripheral role)

You will need to have modified the dbus configuration file to open the permissions for ‘ukBaz.bluezero’. This is covered in the System Setup section of the documentation

cpu_temperature.py

This example transmits the temperature of the CPU over the single characteristic. The method get_cpu_temperature() function creates randomly generated temperature values. Values are only updated when notification are switched on.

ble_uart.py

This example simulates a basic UART connection over two lines, TXD and RXD.

It is based on a proprietary UART service specification by Nordic Semiconductors. Data sent to and from this service can be viewed using the nRF UART apps from Nordic Semiconductors for Android and iOS.

It uses the Bluezero peripheral file (level 10) so should be easier than the previous CPU Temperature example that was a level 100.

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

bluezero-0.9.0.tar.gz (49.5 kB view details)

Uploaded Source

Built Distribution

bluezero-0.9.0-py2.py3-none-any.whl (41.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file bluezero-0.9.0.tar.gz.

File metadata

  • Download URL: bluezero-0.9.0.tar.gz
  • Upload date:
  • Size: 49.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for bluezero-0.9.0.tar.gz
Algorithm Hash digest
SHA256 2512935e094e3afd21ca9d4cb1b9aaa88a524e9538ae81305b2086f09f0eee17
MD5 8bace06486618fceca632aedc2733027
BLAKE2b-256 7b9cbfb3e1f92dd39bf3de8fc483a102bfae763fbf156177b77ed96b8a38bbb1

See more details on using hashes here.

File details

Details for the file bluezero-0.9.0-py2.py3-none-any.whl.

File metadata

  • Download URL: bluezero-0.9.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 41.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for bluezero-0.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a0042f7d685f1ec326fea07be795b220006c6bae3b66e8a83195b0399bbc3e04
MD5 5e7ed6368d4debea3c68c974fc088691
BLAKE2b-256 ac748d44c130d7a34be8ded3cfb3dfc5343daa47ecb57a75c82c17d954a12fc1

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