mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-14 20:21:25 +01:00
esp32_ble_tracker updates for new functionality (#2192)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
parent
ca8a5ee051
commit
2496f269a9
@ -73,6 +73,8 @@ Configuration variables:
|
|||||||
- **active** (*Optional*, boolean): Whether to actively send scan requests to request more data
|
- **active** (*Optional*, boolean): Whether to actively send scan requests to request more data
|
||||||
after having received an advertising packet. With some devices this is necessary to receive all data,
|
after having received an advertising packet. With some devices this is necessary to receive all data,
|
||||||
but also drains those devices' power a (tiny) bit more. Defaults to ``true``.
|
but also drains those devices' power a (tiny) bit more. Defaults to ``true``.
|
||||||
|
- **continuous** (*Optional*, boolean): Whether to scan continuously (forever) or to only scan when
|
||||||
|
asked to start a scan (with start_scan action). Defaults to ``true``.
|
||||||
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this ESP32 BLE Hub.
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this ESP32 BLE Hub.
|
||||||
|
|
||||||
@ -86,14 +88,17 @@ Automations:
|
|||||||
- **on_ble_service_data_advertise** (*Optional*, :ref:`Automation <automation>`): An automation to
|
- **on_ble_service_data_advertise** (*Optional*, :ref:`Automation <automation>`): An automation to
|
||||||
perform when a Bluetooth advertising with service data is received. See
|
perform when a Bluetooth advertising with service data is received. See
|
||||||
:ref:`esp32_ble_tracker-on_ble_service_data_advertise`.
|
:ref:`esp32_ble_tracker-on_ble_service_data_advertise`.
|
||||||
|
- **on_scan_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform when
|
||||||
|
a BLE scan has completed (the duration of the scan). This works with continuous set to true or false.
|
||||||
|
|
||||||
|
|
||||||
ESP32 Bluetooth Low Energy Tracker Automation
|
ESP32 Bluetooth Low Energy Tracker Automation
|
||||||
---------------------------------------------
|
---------------------------------------------
|
||||||
|
|
||||||
.. _esp32_ble_tracker-on_ble_advertise:
|
.. _esp32_ble_tracker-on_ble_advertise:
|
||||||
|
|
||||||
``on_ble_advertise``
|
``on_ble_advertise`` Trigger
|
||||||
********************
|
************************************************
|
||||||
|
|
||||||
This automation will be triggered when a Bluetooth advertising is received. A variable ``x`` of type
|
This automation will be triggered when a Bluetooth advertising is received. A variable ``x`` of type
|
||||||
:apiclass:`esp32_ble_tracker::ESPBTDevice` is passed to the automation for use in lambdas.
|
:apiclass:`esp32_ble_tracker::ESPBTDevice` is passed to the automation for use in lambdas.
|
||||||
@ -128,8 +133,8 @@ Configuration variables:
|
|||||||
|
|
||||||
.. _esp32_ble_tracker-on_ble_manufacturer_data_advertise:
|
.. _esp32_ble_tracker-on_ble_manufacturer_data_advertise:
|
||||||
|
|
||||||
``on_ble_manufacturer_data_advertise``
|
``on_ble_manufacturer_data_advertise`` Trigger
|
||||||
**************************************
|
************************************************
|
||||||
|
|
||||||
This automation will be triggered when a Bluetooth advertising with manufcaturer data is received. A
|
This automation will be triggered when a Bluetooth advertising with manufcaturer data is received. A
|
||||||
variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for use in lambdas.
|
variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for use in lambdas.
|
||||||
@ -159,8 +164,8 @@ Configuration variables:
|
|||||||
|
|
||||||
.. _esp32_ble_tracker-on_ble_service_data_advertise:
|
.. _esp32_ble_tracker-on_ble_service_data_advertise:
|
||||||
|
|
||||||
``on_ble_service_data_advertise``
|
``on_ble_service_data_advertise`` Trigger
|
||||||
*********************************
|
************************************************
|
||||||
|
|
||||||
This automation will be triggered when a Bluetooth advertising with service data is received. A
|
This automation will be triggered when a Bluetooth advertising with service data is received. A
|
||||||
variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for use in lambdas.
|
variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for use in lambdas.
|
||||||
@ -185,6 +190,63 @@ Configuration variables:
|
|||||||
- **service_uuid** (**Required**, string): 16 bit, 32 bit, or 128 bit BLE Service UUID.
|
- **service_uuid** (**Required**, string): 16 bit, 32 bit, or 128 bit BLE Service UUID.
|
||||||
- See :ref:`Automation <automation>`.
|
- See :ref:`Automation <automation>`.
|
||||||
|
|
||||||
|
``on_scan_end`` Trigger
|
||||||
|
************************************************
|
||||||
|
|
||||||
|
This automation will be triggered when a Bluetooth scanning sequence has completed. If running
|
||||||
|
with continuous set to true, this will trigger every time the scan completes (the duration of
|
||||||
|
a scan).
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
esp32_ble_tracker:
|
||||||
|
on_scan_end:
|
||||||
|
- then:
|
||||||
|
- lambda: |-
|
||||||
|
ESP_LOGD("ble_auto", "The scan has ended!");
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
|
||||||
|
- None
|
||||||
|
|
||||||
|
- See :ref:`Automation <automation>`.
|
||||||
|
|
||||||
|
``esp32_ble_tracker.start_scan`` Action
|
||||||
|
************************************************
|
||||||
|
|
||||||
|
Start a single Bluetooth scan. If there is a scan already in progress, then the action is ignored.
|
||||||
|
This should be used with continuous set to false.
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
esp32_ble_tracker:
|
||||||
|
scan_parameters:
|
||||||
|
continuous: false
|
||||||
|
|
||||||
|
time:
|
||||||
|
- platform: sntp
|
||||||
|
on_time:
|
||||||
|
- seconds: 1
|
||||||
|
minutes: /1
|
||||||
|
then:
|
||||||
|
- esp32_ble_tracker.start_scan
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
|
||||||
|
- **continuous** (*Optional*, boolean): Whether to start the scan in continuous mode. Defaults to ``false``
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This action can also be written in :ref:`lambdas <config-lambda>`:
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
esp32_ble_tracker:
|
||||||
|
id: ble_tracker_id
|
||||||
|
|
||||||
|
.. code-block:: cpp
|
||||||
|
|
||||||
|
id(ble_tracker_id).start_scan()
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user