Eddystone Beacon


The eddystone_temperature sensor platform reads temperature information from Bluetooth LE advertisements transmitted by Eddystone beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature). All beacons that support the Eddystone protocol, have a temperature sensor and can transmit TLM frames are compatible with this platform. For example Gimbal, Estimote or kontakt.io. For more manufacturers see this overview by Google.

Requirements

As this platform uses bluez to scan for Bluetooth LE devices a Linux OS with bluez installed is required. In addition to that, the libbluetooth headers need to be installed:

$ sudo apt-get install libbluetooth-dev

Scanning for Bluetooth LE devices also requires special permissions. To grant these to the python executable execute the following:

$ sudo apt-get install libcap2-bin
$ sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3))

To use your Eddystone beacon in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: eddystone_temperature
    bt_device_id: 0  # optional
    beacons:
      living_room:
        namespace: "112233445566778899AA"
        instance: "000000000001"
      kitchen:
        namespace: "112233445566778899AA"
        instance: "000000000002"

Configuration Variables

bt_device_id

(integer)(Optional)The id of the Bluetooth device that should be used for scanning (hciX). You can find the correct one using hcitool dev.

Default value: 0

beacons

(list)(Required)The beacons that should be monitored.

entry

(list)(Required)Name of the beacon.

namespace

(string)(Required)Namespace ID of the beacon in hexadecimal notation. Must be exactly 20 characters (10 bytes) long.

instance

(string)(Required)Instance ID of the beacon in hexadecimal notation. Must be exactly 12 characters (6 bytes) long.

name

(string)(Optional)Friendly name of the beacon.