ABleAdvertisement
=================

`ABleAdvertisements` are added to `ABlePeripheral` instances to configure advertising. The advertisement can be
configured using the methods below for tinkering with service uuids and data, the local name, manufacturing
data and there's more to come! The advertisement should be configured, then added to the peripheral before
starting the peripheral by calling `listen()`. There are also plugins which define specialized advertisements, see
the plugin category below for more details.

Please see the :ref:`Guide-Advertising` section in the programming guide for some examples to get started with
advertising with ABle!

Class Definition
++++++++++++++++

.. autoclass:: able.advertisement.ABleAdvertisement

Advertising Plugins
+++++++++++++++++++

These advertising plugins provide pre-configured `ABleAdvertisement` instances which are setup for specific
advertising types, feel free to open PRs with new plugins, there is interest right now for adding AltBeacons, Google's
URIBeacons, and more!

..  toctree::
    :maxdepth: 1

    iBeacons<plugins/ibeacon.rst>

Configuration
+++++++++++++

Service Data
************

.. autofunction:: able.advertisement.ABleAdvertisement.add_service_uuid
.. autofunction:: able.advertisement.ABleAdvertisement.add_service_data
.. autofunction:: able.advertisement.ABleAdvertisement.update_service_data

Manufacturer Data
*****************

.. autofunction:: able.advertisement.ABleAdvertisement.add_manufacturer_data