.. 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-3129-blue
:alt: Companies
:target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_companies.py
.. image:: https://img.shields.io/badge/Services-693-blue
:alt: Services
:target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_services.py
.. image:: https://img.shields.io/badge/Characteristics-602-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-33341-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 <https://github.com/NordicSemiconductor/bluetooth-numbers-database>`_ for Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs
* `Bluetooth Assigned Numbers <https://www.bluetooth.com/specifications/assigned-numbers/>`_ for SDO Service UUIDs and Member Service UUIDs
* The `IEEE database of OUIs <https://standards-oui.ieee.org/oui/oui.txt>`_ 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 <https://bluetooth-numbers.readthedocs.io/en/latest/api/modules.html>`_ 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 <https://github.com/koenvervloesem/bluetooth-numbers/blob/main/LICENSE.txt>`_ file for more information.
See also the `license for the Bluetooth Numbers Database <https://github.com/NordicSemiconductor/bluetooth-numbers-database/blob/master/LICENSE>`_ used in this package.
Raw data
{
"_id": null,
"home_page": "https://github.com/koenvervloesem/bluetooth-numbers",
"name": "bluetooth-numbers",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "bluetooth,ble,bluetooth-low-energy,uuids,oui,assigned-numbers,services,characteristics,descriptors",
"author": "Koen Vervloesem",
"author_email": "koen@vervloesem.eu",
"download_url": "https://files.pythonhosted.org/packages/a7/5d/c8df0da7291d0e97736c7babab7edc6e2867fb60b367df456a0ff7547c2e/bluetooth-numbers-1.1.1.tar.gz",
"platform": "any",
"description": ".. image:: https://github.com/koenvervloesem/bluetooth-numbers/workflows/tests/badge.svg\n :alt: Continuous Integration\n :target: https://github.com/koenvervloesem/bluetooth-numbers/actions\n.. image:: https://codecov.io/gh/koenvervloesem/bluetooth-numbers/branch/main/graph/badge.svg?token=6NR980W2VX\n :alt: Code coverage\n :target: https://codecov.io/gh/koenvervloesem/bluetooth-numbers\n.. image:: https://img.shields.io/pypi/v/bluetooth-numbers.svg\n :alt: Python package version\n :target: https://pypi.org/project/bluetooth-numbers/\n.. image:: https://img.shields.io/pypi/pyversions/bluetooth-numbers.svg\n :alt: Supported Python versions\n :target: https://python.org/\n.. image:: https://readthedocs.org/projects/bluetooth-numbers/badge/?version=latest\n :target: https://bluetooth-numbers.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://img.shields.io/github/license/koenvervloesem/bluetooth-numbers.svg\n :alt: License\n :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/LICENSE.txt\n\n.. inclusion-marker-before-numbers\n\n.. image:: https://img.shields.io/badge/Companies-3129-blue\n :alt: Companies\n :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_companies.py\n.. image:: https://img.shields.io/badge/Services-693-blue\n :alt: Services\n :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_services.py\n.. image:: https://img.shields.io/badge/Characteristics-602-blue\n :alt: Characteristics\n :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_characteristics.py\n.. image:: https://img.shields.io/badge/Descriptors-16-blue\n :alt: Descriptors\n :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_descriptors.py\n.. image:: https://img.shields.io/badge/OUIs-33341-blue\n :alt: OUIs\n :target: https://github.com/koenvervloesem/bluetooth-numbers/blob/main/src/bluetooth_numbers/_ouis.py\n\n.. inclusion-marker-after-numbers\n\n|\n\n=================\nbluetooth-numbers\n=================\n\n\n Python package with a wide set of numbers related to Bluetooth\n\n\nThis 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.\n\nThe following sources are used:\n\n* Nordic Semiconductor's `Bluetooth Numbers Database <https://github.com/NordicSemiconductor/bluetooth-numbers-database>`_ for Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs\n* `Bluetooth Assigned Numbers <https://www.bluetooth.com/specifications/assigned-numbers/>`_ for SDO Service UUIDs and Member Service UUIDs\n* The `IEEE database of OUIs <https://standards-oui.ieee.org/oui/oui.txt>`_ for prefixes of Bluetooth addresses\n\n.. inclusion-marker-after-intro\n\nInstallation\n============\n\nYou can install bluetooth-numbers as a package from PyPI with pip::\n\n pip install bluetooth-numbers\n\nUsage\n=====\n\nGet the description of a company ID:\n\n.. code-block:: python\n\n\t>>> from bluetooth_numbers import company\n\t>>> company[0x0499]\n\t'Ruuvi Innovations Ltd.'\n\nGet the description of a service UUID:\n\n.. code-block:: python\n\n\t>>> from bluetooth_numbers import service\n\t>>> from uuid import UUID\n\t>>> service[0x180F]\n\t'Battery Service'\n\t>>> service[UUID(\"6E400001-B5A3-F393-E0A9-E50E24DCCA9E\")]\n\t'Nordic UART Service'\n\nGet the description of a characteristic UUID:\n\n.. code-block:: python\n\n\t>>> from bluetooth_numbers import characteristic\n\t>>> from uuid import UUID\n\t>>> characteristic[0x2A37]\n\t'Heart Rate Measurement'\n\t>>> characteristic[UUID(\"6E400002-B5A3-F393-E0A9-E50E24DCCA9E\")]\n\t'UART RX Characteristic'\n\nGet the description of a descriptor UUID:\n\n.. code-block:: python\n\n\t>>> from bluetooth_numbers import descriptor\n\t>>> descriptor[0x2901]\n\t'Characteristic User Descriptor'\n\nGet the description of an OUI:\n\n.. code-block:: python\n\n\t>>> from bluetooth_numbers import oui\n\t>>> oui[\"58:2D:34\"]\n\t'Qingping Electronics (Suzhou) Co., Ltd'\n\nSee the `module reference <https://bluetooth-numbers.readthedocs.io/en/latest/api/modules.html>`_ for complete documentation.\n\n.. inclusion-marker-before-license\n\nLicense\n=======\n\nThis project is provided by Koen Vervloesem as open source software with the MIT license. See the `LICENSE <https://github.com/koenvervloesem/bluetooth-numbers/blob/main/LICENSE.txt>`_ file for more information.\n\nSee also the `license for the Bluetooth Numbers Database <https://github.com/NordicSemiconductor/bluetooth-numbers-database/blob/master/LICENSE>`_ used in this package.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package with a wide set of numbers related to Bluetooth",
"version": "1.1.1",
"project_urls": {
"Changelog": "https://github.com/koenvervloesem/bluetooth-numbers/blob/main/CHANGELOG.rst",
"Documentation": "https://bluetooth-numbers.readthedocs.io/",
"Download": "https://pypi.org/project/bluetooth-numbers/#files",
"Homepage": "https://github.com/koenvervloesem/bluetooth-numbers",
"Source": "https://github.com/koenvervloesem/bluetooth-numbers",
"Tracker": "https://github.com/koenvervloesem/bluetooth-numbers/issues"
},
"split_keywords": [
"bluetooth",
"ble",
"bluetooth-low-energy",
"uuids",
"oui",
"assigned-numbers",
"services",
"characteristics",
"descriptors"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52c38f9bd432fd441ffe33133661003f59689f1075e0967e2f5278cc90c81e37",
"md5": "ab0e2a4f5cc781f0cea16d84f09ac5d5",
"sha256": "0677d53e2c56011b005c107ee6d79577dd2e7b822afbb1336f6ef9b8eac3886c"
},
"downloads": -1,
"filename": "bluetooth_numbers-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab0e2a4f5cc781f0cea16d84f09ac5d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 474119,
"upload_time": "2023-06-17T20:05:05",
"upload_time_iso_8601": "2023-06-17T20:05:05.191484Z",
"url": "https://files.pythonhosted.org/packages/52/c3/8f9bd432fd441ffe33133661003f59689f1075e0967e2f5278cc90c81e37/bluetooth_numbers-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a75dc8df0da7291d0e97736c7babab7edc6e2867fb60b367df456a0ff7547c2e",
"md5": "df108b52209c8441058e74b9919a603d",
"sha256": "7b4a75bb6701b70f33b1b0e633a55e469abd108907cb7406fa8fce64bbee930a"
},
"downloads": -1,
"filename": "bluetooth-numbers-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "df108b52209c8441058e74b9919a603d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1939904,
"upload_time": "2023-06-17T20:05:07",
"upload_time_iso_8601": "2023-06-17T20:05:07.438201Z",
"url": "https://files.pythonhosted.org/packages/a7/5d/c8df0da7291d0e97736c7babab7edc6e2867fb60b367df456a0ff7547c2e/bluetooth-numbers-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-17 20:05:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "koenvervloesem",
"github_project": "bluetooth-numbers",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "bluetooth-numbers"
}
JSON
