MQTT Device Tracker

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 Variables

devices list Required

List of devices with their topic.

qos integer (Optional)

The QoS level of the topic.

payload_home string (Optional, default: home)

The payload value that represents the ‘home’ state for the device.

payload_not_home string (Optional, default: not_home)

The payload value that represents the ‘not_home’ state for the device.

source_type string (Optional)

Attribute of a device tracker that affects state when being used to track a person. Valid options are gps, router, bluetooth, or bluetooth_le.

Complete example configuration

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

Usage

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

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