mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-08 12:08:58 +00:00
a8897a4b1f
* Added page for the new room tracker component * Added info about using it together with Owntracks * Updated room presence documentation to new sensor implementation * Changed name to mqtt_room * Changed category to Presence Detection
1.8 KiB
1.8 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | MQTT Room Presence | Instructions on how to track room presence within Home Assistant. | 2016-08-21 03:58 | true | false | true | true | mqtt.png | Presence Detection | 0.27 | depends |
The mqtt_room sensor platform allows you to detect the indoor location of devices using MQTT clients.
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
name: 'Cool device'
state_topic: 'room_presence'
timeout: 5
Configuration variables:
- device_id (Required): The device id to track for this sensor.
- name (Optional): The name of the sensor.
- state_topic (Optional): The topic that contains all subtopics for the rooms.
- timeout (Optional): 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 secoonds scanner2 reports device with a distance of 2. The old location info is discarded in favor of the new scanner2 information as the timeout has passed.
Example JSON that should be published to the room topics:
{
"id": "123testid",
"name": "Test Device",
"distance": 5.678
}
{% linkable_title Setting up clients %}
This component 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