ESP32 Bluetooth Low Energy Tracker Hub

The esp32_ble_tracker component creates a global hub so that you can track bluetooth low energy devices using your ESP32 node.

See Setting up devices for information on how you can find out the MAC address of a device and track it using ESPHome.

# Example configuration entry
esp32_ble_tracker:

binary_sensor:
  - platform: ble_presence
    mac_address: AC:37:43:77:5F:4C
    name: "ESP32 BLE Presence Google Home Mini"

sensor:
  - platform: ble_rssi
    mac_address: AC:37:43:77:5F:4C
    name: "BLE Google Home Mini RSSI value"

Note

The first time this component is enabled for an ESP32, the code partition needs to be resized. Please flash the ESP32 via USB when adding this to your configuration. After that, you can use OTA updates again.

Configuration variables:

  • scan_parameters (Optional): Advanced parameters for configuring the scan behavior of the ESP32. See also this guide by Texas Instruments for reference.

    • interval (Optional, 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, 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, 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, ID): Manually specify the ID for this ESP32 BLE Hub.

Automations:

ESP32 Bluetooth Low Energy Tracker Automation

on_ble_advertise

This automation will be triggered when a Bluetooth advertising is received. A variable x of type esp32_ble_tracker::ESPBTDevice is passed to the automation for use in lambdas.

esp32_ble_tracker:
  on_ble_advertise:
    - mac_address: 11:22:33:44:55:66
      then:
        - lambda: |-
            ESP_LOGD("ble_adv", "New BLE device");
            ESP_LOGD("ble_adv", "  address: %s", x.address_str().c_str());
            ESP_LOGD("ble_adv", "  name: %s", x.get_name().c_str());
            ESP_LOGD("ble_adv", "  Advertised service UUIDs:");
            for (auto uuid : x.get_service_uuids()) {
                ESP_LOGD("ble_adv", "    - %s", uuid.to_string().c_str());
            }
            ESP_LOGD("ble_adv", "  Advertised service data:");
            for (auto data : x.get_service_datas()) {
                ESP_LOGD("ble_adv", "    - %s: (length %i)", data.uuid.to_string().c_str(), data.data.size());
            }
            ESP_LOGD("ble_adv", "  Advertised manufacturer data:");
            for (auto data : x.get_manufacturer_datas()) {
                ESP_LOGD("ble_adv", "    - %s: (length %i)", data.uuid.to_string().c_str(), data.data.size());
            }

Configuration variables:

  • mac_address (Optional, MAC Address): The MAC address to filter for this automation.

  • See Automation.

on_ble_manufacturer_data_advertise

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.

sensor:
  - platform: template
    name: "BLE Sensor"
    id: ble_sensor

esp32_ble_tracker:
  on_ble_manufacturer_data_advertise:
    - mac_address: 11:22:33:44:55:66
      manufacturer_id: 0590
      then:
        - lambda: |-
            if (x[0] != 0x7b || x[1] != 0x61) return;
            int value = x[2] + (x[3] << 8);
            id(ble_sensor).publish_state(value);

Configuration variables:

  • mac_address (Optional, MAC Address): The MAC address to filter for this automation.

  • manufacturer_id (Required, string) 16 bit, 32 bit, or 128 bit BLE Manufacturer ID.

  • See Automation.

on_ble_on_ble_service_data_advertise

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.

sensor:
  - platform: template
    name: "BLE Sensor"
    id: ble_sensor

esp32_ble_tracker:
  on_ble_service_data_advertise:
    - mac_address: 11:22:33:44:55:66
      service_uuid: 181A
      then:
        - lambda: 'id(ble_sensor).publish_state(x[0]);'

Configuration variables:

  • mac_address (Optional, MAC Address): The MAC address to filter for this automation.

  • service_uuid (Required, string) 16 bit, 32 bit, or 128 bit BLE Service UUID.

  • See Automation.