mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
Split ble server docs (#1234)
This commit is contained in:
parent
3105bb5e90
commit
92a0fba463
@ -5,30 +5,22 @@ BLE Component
|
||||
: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.
|
||||
The ``esp32_ble`` component in ESPHome sets up the Bluetooth LE stack on the device so that a :doc:`esp32_ble_server`
|
||||
can run.
|
||||
|
||||
.. 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>`.
|
||||
No configuration variables.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`esp32_ble_server`
|
||||
- :doc:`esp32_improv`
|
||||
- :apiref:`esp32_ble/ble.h`
|
||||
- :ghedit:`Edit`
|
||||
|
32
components/esp32_ble_server.rst
Normal file
32
components/esp32_ble_server.rst
Normal file
@ -0,0 +1,32 @@
|
||||
BLE Server
|
||||
==========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Bluetooth LE GATT Server in ESPHome.
|
||||
:image: bluetooth.svg
|
||||
|
||||
The ``esp32_ble_server`` 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:
|
||||
------------------------
|
||||
|
||||
- **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_ble`
|
||||
- :doc:`esp32_improv`
|
||||
- :apiref:`esp32_ble/ble.h`
|
||||
- :ghedit:`Edit`
|
@ -8,7 +8,7 @@ Improv
|
||||
The ``esp32_improv`` component in ESPHome implements the open `Improv standard <https://www.improv-wifi.com/>`__
|
||||
for configuring Wi-Fi on an ESP32 device by using Bluetooth Low Energy to receive the credentials.
|
||||
|
||||
The ``esp32_improv`` component requires the :doc:`BLE Server <esp32_ble>` to be set up.
|
||||
The ``esp32_improv`` component will automatically set up the :doc:`BLE Server <esp32_ble>`.
|
||||
|
||||
|
||||
.. code-block:: yaml
|
||||
@ -17,9 +17,6 @@ The ``esp32_improv`` component requires the :doc:`BLE Server <esp32_ble>` to be
|
||||
wifi:
|
||||
# ...
|
||||
|
||||
esp32_ble:
|
||||
server: # A BLE server is required
|
||||
|
||||
esp32_improv:
|
||||
authorizer: binary_sensor_id
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user