jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Mqtt_room sensor component configuration (#7278)

Browse Source 
* Update Mqtt_room sensor component configuration

* 🚑 Fix error

* Fix typo
This commit is contained in:
Klaas Schoute 2018-10-30 21:09:54 +01:00 committed by Fabian Affolter
parent 2092dd0067
commit 1daa7a2ff3
1 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
source/_components/sensor.mqtt_room.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.27
ha_iot_class: depends
---
The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients.
## {% linkable_title Configuration %}
@ -31,13 +30,32 @@ sensor:
away_timeout: 60
```
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 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.
- **away_timeout** (*Optional*): The time in seconds after which the state should be set to `not_home` if there were no updates. `0` disables the check and is the default.
{% 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: false
default: room_presence
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 %}
Example JSON that should be published to the room topics: