home-assistant.io/source/_integrations/device_tracker.mqtt.markdown
Raman Gupta e8e9af12e3 Update MQTT Device Tracker mapping payloads to zones/states (#10581)
* Add action_topic and action_template parameters to configuration

* updated possible action_topic values to be more accurate

* update MQTT device tracker documentation to add custom payload to location mapping parameter

* update new parameter name

* revert MQTT climate changes that are submitted in separate PR

* support for payload_home, payload_not_home, and payload_custom

* fix grammar

* move optional fields to complete configuration example

* fix tabs

* ✏️ Tweak

* fix parameter type as designed

* change parameter types

* match formatting of original doc

* match formatting of original doc

* match formatting of original doc

* update docs based on code changes

* change parameter name for custom mapping payloads to other zones and improve description

* update complete configuration example to reflect parameter name change

* revert description for 'devices' and simplify explanation for 'payload_other_zones'

* fix qos parameter value in example

* remove 'payload_other_zones' per balloobs review

* final cleanup

* ✏️ Manual fix bad rebase

* ✏️ Whitespace

* ✏️ Whitespace


Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2019-10-20 15:53:53 +02:00

1.6 KiB

title, description, logo, ha_category, ha_iot_class, ha_release
title description logo ha_category ha_iot_class ha_release
MQTT Device Tracker Instructions on how to use MQTT to track devices in Home Assistant. mqtt.png
Presence Detection
Configurable 0.7.3

The mqtt device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device.

Configuration

To use this device tracker in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
device_tracker:
  - platform: mqtt
    devices:
      paulus_oneplus: 'location/paulus'
      annetherese_n4: 'location/annetherese'

{% configuration %} devices: description: List of devices with their topic. required: true type: list qos: description: The QoS level of the topic. required: false type: integer payload_home: description: The payload value that represents the 'home' state for the device. required: false type: string default: 'home' payload_not_home: description: The payload value that represents the 'not_home' state for the device. required: false type: string default: 'not_home' {% endconfiguration %}

Complete example configuration

# Complete configuration.yaml entry
device_tracker:
  devices:
    paulus_oneplus: 'location/paulus'
    annetherese_n4: 'location/annetherese'
  qos: 1
  payload_home: 'present'
  payload_not_home: 'not present'

Usage

Example JSON you can publish to the topic (e.g., via mqtt.publish service):

{
  "topic": "location/paulus",
  "payload": "home"
}