Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-25 17:17:54 +01:00
Code Issues Projects Releases Wiki Activity

Split ble server docs (#1234)

Browse Source
This commit is contained in:
Jesse Hills 2021-06-12 08:31:35 +12:00 committed by GitHub
parent 3105bb5e90
commit 92a0fba463
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
components/esp32_ble.rst
View File

@ -5,30 +5,22 @@ BLE Component
:description: Instructions for setting up Bluetooth LE in ESPHome. :description: Instructions for setting up Bluetooth LE in ESPHome.
:image: bluetooth.svg :image: bluetooth.svg
The ``esp32_ble`` component in ESPHome sets up a simple BLE GATT server that exposes the device name, The ``esp32_ble`` component in ESPHome sets up the Bluetooth LE stack on the device so that a :doc:`esp32_ble_server`
manufacturer and board. This component allows other components to create their own services to expose can run.
data and control.
.. code-block:: yaml .. code-block:: yaml
# Example configuration # Example configuration
esp32_ble: esp32_ble:
server:
Configuration variables: No 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 See Also
-------- --------
- :doc:`esp32_ble_server`
- :doc:`esp32_improv` - :doc:`esp32_improv`
- :apiref:`esp32_ble/ble.h` - :apiref:`esp32_ble/ble.h`
- :ghedit:`Edit` - :ghedit:`Edit`

32
components/esp32_ble_server.rst Normal file
View 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`

5
components/esp32_improv.rst
View File

@ -8,7 +8,7 @@ Improv
The ``esp32_improv`` component in ESPHome implements the open `Improv standard <https://www.improv-wifi.com/>`__ 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. 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 .. code-block:: yaml
@ -17,9 +17,6 @@ The ``esp32_improv`` component requires the :doc:`BLE Server <esp32_ble>` to be
wifi: wifi:
# ... # ...
esp32_ble:
server: # A BLE server is required
esp32_improv: esp32_improv:
authorizer: binary_sensor_id authorizer: binary_sensor_id