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

The following notes provide an overview of the architecture of some of
the higher-level classes in the library, as to facilitate their
understanding.

Standard API
============

.. doxygenclass:: SimpleBLE::Adapter
   :project: simpleble
   :members:
   :undoc-members:

.. doxygenclass:: SimpleBLE::Peripheral
   :project: simpleble
   :members:
   :undoc-members:

.. doxygenclass:: SimpleBLE::Service
   :project: simpleble
   :members:
   :undoc-members:

.. doxygenclass:: SimpleBLE::Characteristic
   :project: simpleble
   :members:
   :undoc-members:

.. doxygenclass:: SimpleBLE::Descriptor
   :project: simpleble
   :members:
   :undoc-members:

.. doxygentypedef:: SimpleBLE::ByteArray
   :project: simpleble

Safe API
========

.. doxygenclass:: SimpleBLE::Safe::Adapter
   :project: simpleble
   :members:
   :undoc-members:

.. doxygenclass:: SimpleBLE::Safe::Peripheral
   :project: simpleble
   :members:
   :undoc-members:

C API
========

.. doxygenfile:: adapter.h
   :project: simpleble

.. doxygenfile:: peripheral.h
   :project: simpleble

External API
============

.. doxygenclass:: kvn::bytearray
   :project: external
   :members:
   :undoc-members: