Welcome to OralB-IO's documentation!
====================================

This small Python project includes an unofficial client for OralB toothbrushes
as well as an API to interact with these devices using Bluetooth Low Energy
(BLE).

This library features:

* :code:`oralbcli`: A CLI to discover and manage OralB toothbrushes,
* an asynchronous API to interact with these devices, and
* it includes most of the structs needed for communication.

.. note::
   This project was written using Python 3.12. All previous versions are
   marked as unsupported and haven't been approved yet.


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Resources

   usage.rst
   examples.rst
   API/index.rst

Installation
============

The Python package available with this project can be installed via pip:

.. code-block:: console

    pip install git+https://github.com/MatrixEditor/oralb-io.git


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`