Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-27 22:31:37 +01:00
Code Issues Projects Releases Wiki Activity

Add ESP32 scan parameters (#368)

Browse Source 
See https://github.com/esphome/esphome/pull/769
This commit is contained in:
Otto Winter 2019-10-19 16:33:02 +02:00 committed by GitHub
parent a81457eb87
commit 26b917dadc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
components/esp32_ble_tracker.rst
View File

@ -15,7 +15,6 @@ for information on how you can find out the MAC address of a device and track it
# Example configuration entry
esp32_ble_tracker:
scan_interval: 300s
binary_sensor:
- platform: esp32_ble_tracker
@ -57,8 +56,23 @@ for information on how you can find out the MAC address of a device and track it
Configuration variables:
------------------------
- **scan_interval** (*Optional*, :ref:`config-time`): The length of each scan.
If a device is not found within this time window, it will be marked as not present. Defaults to 300s.
- **scan_parameters** (*Optional*): Advanced parameters for configuring the scan behavior of the ESP32.
See also `this guide by Texax Instruments <http://dev.ti.com/tirex/content/simplelink_academy_cc2640r2sdk_1_12_01_16/modules/ble_scan_adv_basic/ble_scan_adv_basic.html#scanning>`__
for reference.
- **interval** (*Optional*, :ref:`config-time`): The interval between each consecutive scan window.
This is the time the ESP spends on each of the 3 BLE advertising channels.
Defaults to ``320ms``.
- **window** (*Optional*, :ref:`config-time`): The time the ESP is actively listening for packets
on a channel during each scan interval. If this is close to the ``interval`` value, the ESP will
spend more time listening to packets (but also consume more power).
- **duration** (*Optional*, :ref:`config-time`): The duration of each complete scan. This has no real
impact on the device but can be used to debug the BLE stack. Defaults to ``5min``.
- **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,
but also drains those devices' power a (tiny) bit more. Defaults to ``true``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this ESP32 BLE Hub.
See Also