2.3 KiB
title, description, logo, ha_category, ha_release, ha_iot_class, ha_domain
| title | description | logo | ha_category | ha_release | ha_iot_class | ha_domain | |
|---|---|---|---|---|---|---|---|
| MQTT Room Presence | Instructions on how to track room presence within Home Assistant. | mqtt.png |
|
0.27 | Configurable | mqtt_room |
The mqtt_room sensor platform allows you to detect the indoor location of devices using MQTT clients.
Configuration
To use this device tracker in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
sensor:
- platform: mqtt_room
device_id: 123testid
{% configuration %}
device_id:
description: The device id to track for this sensor.
required: true
type: string
name:
description: The name of the sensor.
required: false
default: Room Sensor
type: string
state_topic:
description: The topic that contains all subtopics for the rooms.
required: true
type: string
timeout:
description: "The time in seconds after which a room presence state is considered old. An example: device1 is reported at scanner1 with a distance of 1. No further updates are sent from scanner1. After 5 seconds scanner2 reports device1 with a distance of 2. The old location info is discarded in favor of the new scanner2 information as the timeout has passed."
required: false
default: 5
type: integer
away_timeout:
description: The time in seconds after which the state should be set to not_home if there were no updates. 0 disables the check.
required: false
default: 0
type: integer
{% endconfiguration %}
Usage
Example JSON that should be published to the room topics:
{
"id": "123testid",
"name": "Test Device",
"distance": 5.678
}
Setting up clients
This integration works with any software that is sending data in the given format. Each client should post the discovered devices in its own subtopic of the configured topic. Instead of developing your own application, you can also use any of these already existing clients:
- room-assistant: looks for Bluetooth LE beacons, based on Node.js
- Happy Bubbles Presence Server: presence detection server for Happy Bubbles BLE-scanning devices, based on Go
- ESP32-MQTT-room: runs on an ESP32, and looks for Bluetooth LE devices, based on C++/Arduino