From e8e9af12e3543c9228c73a64067800ea5cc46b94 Mon Sep 17 00:00:00 2001
From: Raman Gupta <7243222+raman325@users.noreply.github.com>
Date: Sun, 20 Oct 2019 09:53:53 -0400
Subject: [PATCH] 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

* :pencil2: 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

* :pencil2: Manual fix bad rebase

* :pencil2: Whitespace

* :pencil2: Whitespace


Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
---
 .../device_tracker.mqtt.markdown              | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown
index 5cdf62e3558..6694029cf0f 100644
--- a/source/_integrations/device_tracker.mqtt.markdown
+++ b/source/_integrations/device_tracker.mqtt.markdown
@@ -33,8 +33,31 @@ 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
+
+```yaml
+# 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):