Skip to main content

Cross-platform, command-line and human-friendly Bluetooth Low Energy Explorer

Project description

Continuous Integration Python package version Supported Python versions Documentation Status Codecov coverage License

HumBLE Explorer

Human-friendly Bluetooth Low Energy Explorer

This is a cross-platform (Windows, Linux, macOS) human-friendly program to scan for Bluetooth Low Energy (BLE) advertisements on the command line. It’s mostly useful for people who develop BLE software or want to debug problems with BLE devices.

Human-friendly Bluetooth Low Energy Explorer in action

Installation

You can install HumBLE Explorer as a pip package from PyPI:

pip install humble-explorer

Usage

HumBLE Explorer understands some command-line arguments, which you can see with the --help option:

humble-explorer --help

Documentation

Read HumBLE Explorer’s online documentation.

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd humble-explorer
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

Don’t forget to tell your contributors to also install and use pre-commit.

Debugging code

You can debug HumBLE Explorer with Textual’s debug console.

To use the console, open up two terminal emulators. Run the following in one of the terminals:

textual console

You should see the Textual devtools welcome message.

In the other console, run HumBLE Explorer with:

TEXTUAL=devtools python3 src/humble_explorer/__main__.py

Learn more about Bluetooth Low Energy development

If you want to learn more about Bluetooth Low Energy development, read my book Develop your own Bluetooth Low Energy Applications for Raspberry Pi, ESP32 and nRF52 with Python, Arduino and Zephyr and the accompanying GitHub repository koenvervloesem/bluetooth-low-energy-applications.

Note

This project has been set up using PyScaffold 4.3.1. For details and usage information on PyScaffold see https://pyscaffold.org/.

License

This project is provided by Koen Vervloesem as open source software with the MIT license. See the LICENSE file for more information.

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

humble-explorer-0.2.0.tar.gz (253.7 kB view details)

Uploaded Source

Built Distribution

humble_explorer-0.2.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file humble-explorer-0.2.0.tar.gz.

File metadata

  • Download URL: humble-explorer-0.2.0.tar.gz
  • Upload date:
  • Size: 253.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for humble-explorer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 445bac969b088064a7caf5889165435195de75c56a6f7353e09e56e6d9010c61
MD5 dae0a2462b695ecd8d44a6102acc8762
BLAKE2b-256 36ff6c83f66cfa850b998a97c8dc7e2a02937d7a257c9ac12628d8eadef714b0

See more details on using hashes here.

File details

Details for the file humble_explorer-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for humble_explorer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1796b0b94e1347261c3fd0dc283a8f3624ce63c734cd9470f343648fb54998ca
MD5 3849dca0927cb322140390558925f842
BLAKE2b-256 0178fc4175b49879173442e2916c18c49acbf8519a4ecec5e01d7da9b000fafa

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