esphome-docs/components/esp32_ble.rst
Jesse Hills cb129194da
Add docs for Improv and new BLE base/server (#1203)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2021-06-08 11:56:31 +12:00

35 lines
941 B
ReStructuredText

BLE Component
=============
.. seo::
:description: Instructions for setting up Bluetooth LE in ESPHome.
:image: bluetooth.svg
The ``esp32_ble`` component in ESPHome sets up a simple BLE GATT server that exposes the device name,
manufacturer and board. This component allows other components to create their own services to expose
data and control.
.. code-block:: yaml
# Example configuration
esp32_ble:
server:
Configuration variables:
------------------------
- **server** (*Optional*): Starts the BLE GATT server
- **manufacturer** (*Optional*, string): The name of the manufacturer/firmware creator. Defaults to ``ESPHome``.
- **model** (*Optional*, string): The model name of the device. Defaults to the friendly name of the ``board`` chosen
in the :ref:`core configuration <esphome-configuration_variables>`.
See Also
--------
- :doc:`esp32_improv`
- :apiref:`esp32_ble/ble.h`
- :ghedit:`Edit`