Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

formatBCE/Format-BLE-Tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

hacs_badge

Format-BLE-Tracker

Custom integration foor tracking BLE devices (bluetoooth tags, smartwatches, phones with Home Assistant Companion app) in Home Assistant Requires ESP32 tracking nodes installation: see https://github.com/formatBCE/ESP32_BLE_presense.

Prerequisites:

  1. Make sure you have MQTT server, working with your Home Assistant installation, and you can connect to it.
  2. Make sure you have 2.4 GHz WiFi network available in all places, where you plan to place your tracking nodes.
  3. Prepare and place ESP32 device(s) according to instructions at https://github.com/formatBCE/ESP32_BLE_presense.
  4. Write down MAC addresses or Proximity UUIDs for all devices that you want to track:
    • for dumb beacons (e.g. Tile) you can find MAC address in official app, or use amy Bluetooth tracker app on your phone too scrap one;
    • for smart beacons (e.g. Android phone with Home Assistant Companion application and BLE tracker enabled), you will need to copy Proximity UUID, because device MAC address is not exposed to public.

Installation:

  1. (Not available yet) HACS: Add this repository to HACS in Integrations -> (menu) -> Custom repositories:
  • Repository: URL of this repository
  • Category: Integration Install integration from Integration page.
  1. Manual: Copy the format_ble_tracker folder and all of its contents into your Home Assistant's custom_components folder. This is often located inside of your /config folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the custom_components folder might be located at /usr/share/hassio/homeassistant. It is possible that your custom_components folder does not exist. If that is the case, create the folder in the proper location, and then copy the format_ble_tracker folder and all of its contents inside the newly created custom_components folder. After it's done, restart HomeAssistant and relooad browser page forcefully (Ctrl+F5).

Usage:

In Home Assistant, go to "Devices and Services" -> "Add Integration". Search for "Format BLE Tracker" and click on it. In the configuratioon dialog, insert MAC address or UUID of tag, and (optionally) enter friendly name for this device.

All communication between tracker nodes and created device are automatic.

Integration will create device with three entities:

  1. Device Tracker entity for device. Will show Home status for this tag, if tag is visible for at least one of tracking nodes, or Away status.
  2. Sensor with current closest node name for this device (basically, current room name).
  3. Input slider for tuning data expiration period (from 1 minute to 10 minutes). This will affect the time from last visibility event till setting up Away mode. Use greater values, if you experience often changes Home to Away and back. By default set to 2 minutes.

Additionally, for each tracker node (ESP32 device) there will be device with current IP sensor created. It can be useful to determine availability of node. Also, you can visit device config web page right from Home Assistant device page.