esphome-docs/components/text_sensor/ble_scanner.rst
Otto Winter 6053f490b5
Update svg2png and seo.py (#1380)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
2021-11-16 15:19:33 +13:00

49 lines
1.4 KiB
ReStructuredText

ESP32 Bluetooth Low Energy Scanner
==================================
.. seo::
:description: Instructions for setting up BLE text sensors for the ESP32.
:image: bluetooth.svg
:keywords: ESP32
The ``ble_scanner`` text sensor platform lets you track reachable BLE devices.
See the :ref:`BLE Tracker Configuration variables <config-esp32_ble_tracker>` for
instructions for setting up scan parameters.
The sensor platform is similar to :doc:`/components/sensor/ble_rssi` but in contrast to that platform, this text sensor sends out all raw BLE scan information and does not filter devices.
The data this sensor publishes is intended to be processed by the remote (for example an MQTT client) and sends the data in JSON format.
.. code-block:: yaml
# Example configuration entry
esp32_ble_tracker:
text_sensor:
- platform: ble_scanner
name: "BLE Devices Scanner"
Example json log:
.. code-block:: json
{
"timestamp":1578254525,
"address":"D7:E7:E7:66:DD:33",
"rssi":"-80",
"name":"MI Band 2"
}
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the sensor.
- All other options from :ref:`Text Sensor <config-text_sensor>`.
See Also
--------
- :doc:`/components/esp32_ble_tracker`
- :doc:`/components/text_sensor/index`
- :apiref:`ble_scanner/ble_scanner.h`
- :ghedit:`Edit`