https://github.com/koenvervloesem/bluetooth-numbers

An up-to-date listing of all the various Bluetooth Specification-related elements (Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs), that you can use in your Python projects instead of rolling your own.
https://github.com/koenvervloesem/bluetooth-numbers

assigned-numbers ble bluetooth bluetooth-low-energy oui oui-database oui-search ouilookup python python3 uuids

Last synced: 2 months ago
JSON representation

An up-to-date listing of all the various Bluetooth Specification-related elements (Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs), that you can use in your Python projects instead of rolling your own.

• Host: GitHub
• URL: https://github.com/koenvervloesem/bluetooth-numbers
• Owner: koenvervloesem
• License: mit
• Created: 2022-07-01T20:06:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-28T14:54:31.000Z (4 months ago)
• Last Synced: 2024-10-03T19:59:10.846Z (3 months ago)
• Topics: assigned-numbers, ble, bluetooth, bluetooth-low-energy, oui, oui-database, oui-search, ouilookup, python, python3, uuids
• Language: Python
• Homepage: https://bluetooth-numbers.readthedocs.io
• Size: 3.64 MB
• Stars: 16
• Watchers: 5
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
.. image:: https://github.com/koenvervloesem/bluetooth-numbers/workflows/tests/badge.svg

    :alt: Continuous Integration

    :target: https://github.com/koenvervloesem/bluetooth-numbers/actions

.. image:: https://codecov.io/gh/koenvervloesem/bluetooth-numbers/branch/main/graph/badge.svg?token=6NR980W2VX

    :alt: Code coverage

    :target: https://codecov.io/gh/koenvervloesem/bluetooth-numbers

.. image:: https://img.shields.io/pypi/v/bluetooth-numbers.svg

    :alt: Python package version

    :target: https://pypi.org/project/bluetooth-numbers/

.. image:: https://img.shields.io/pypi/pyversions/bluetooth-numbers.svg

    :alt: Supported Python versions

    :target: https://python.org/

.. image:: https://readthedocs.org/projects/bluetooth-numbers/badge/?version=latest

    :target: https://bluetooth-numbers.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

.. image:: https://img.shields.io/github/license/koenvervloesem/bluetooth-numbers.svg

    :alt: License

    :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/LICENSE.txt

.. inclusion-marker-before-numbers

.. image:: https://img.shields.io/badge/Companies-3236-blue

    :alt: Companies

    :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_companies.py

.. image:: https://img.shields.io/badge/Services-707-blue

    :alt: Services

    :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_services.py

.. image:: https://img.shields.io/badge/Characteristics-603-blue

    :alt: Characteristics

    :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_characteristics.py

.. image:: https://img.shields.io/badge/Descriptors-16-blue

    :alt: Descriptors

    :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_descriptors.py

.. image:: https://img.shields.io/badge/OUIs-33938-blue

    :alt: OUIs

    :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_ouis.py

.. inclusion-marker-after-numbers

|

=================

bluetooth-numbers

=================

    Python package with a wide set of numbers related to Bluetooth

This project offers a Python package with a wide set of numbers related to Bluetooth, so Python projects can easily use these numbers. The goal of this project is to provide a shared resource so various Python projects that deal with Bluetooth don't have to replicate this effort by rolling their own database and keeping it updated.

The following sources are used:

* Nordic Semiconductor's `Bluetooth Numbers Database `_ for Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs

* `Bluetooth Assigned Numbers `_ for SDO Service UUIDs and Member Service UUIDs

* The `IEEE database of OUIs `_ for prefixes of Bluetooth addresses

.. inclusion-marker-after-intro

Installation

============

You can install bluetooth-numbers as a package from PyPI with pip::

    pip install bluetooth-numbers

Usage

=====

Get the description of a company ID:

.. code-block:: python

	>>> from bluetooth_numbers import company

	>>> company[0x0499]

	'Ruuvi Innovations Ltd.'

Get the description of a service UUID:

.. code-block:: python

	>>> from bluetooth_numbers import service

	>>> from uuid import UUID

	>>> service[0x180F]

	'Battery Service'

	>>> service[UUID("6E400001-B5A3-F393-E0A9-E50E24DCCA9E")]

	'Nordic UART Service'

Get the description of a characteristic UUID:

.. code-block:: python

	>>> from bluetooth_numbers import characteristic

	>>> from uuid import UUID

	>>> characteristic[0x2A37]

	'Heart Rate Measurement'

	>>> characteristic[UUID("6E400002-B5A3-F393-E0A9-E50E24DCCA9E")]

	'UART RX Characteristic'

Get the description of a descriptor UUID:

.. code-block:: python

	>>> from bluetooth_numbers import descriptor

	>>> descriptor[0x2901]

	'Characteristic User Descriptor'

Get the description of an OUI:

.. code-block:: python

	>>> from bluetooth_numbers import oui

	>>> oui["58:2D:34"]

	'Qingping Electronics (Suzhou) Co., Ltd'

See the `module reference `_ for complete documentation.

.. inclusion-marker-before-license

License

=======

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

See also the `license for the Bluetooth Numbers Database `_ used in this package.