=============
API Reference
=============

.. .. automodule:: simplepyble
.. autoclass:: simplepyble.Adapter
   :members:
   :undoc-members:

.. autoclass:: simplepyble.Peripheral
   :members:
   :undoc-members:

.. autoclass:: simplepyble.Service
   :members:
   :undoc-members:

.. autoclass:: simplepyble.Characteristic
   :members:
   :undoc-members:

.. autoclass:: simplepyble.Descriptor
   :members:
   :undoc-members:


Examples
========

To learn how to use SimplePyBLE, please refer to the `examples`_ provided
in the repository.

The following list briefly describes each example provided:

* `list_adapters`_: List all available adapters.
* `scan`_ : Scan for nearby BLE devices.
* `connect`_ : Connect to a BLE device and list its services and characteristics.
* `read`_: Read a characteristic's value.
* `write`_: Write a characteristic's value.
* `notify`_ : Enable notifications on a characteristic.

.. Links

.. _examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble

.. _list_adapters: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/list_adapters.py

.. _scan: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/scan.py

.. _connect: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/connect.py

.. _read: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/read.py

.. _write: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/write.py

.. _notify: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/notify.py
