2024.12.5
Home ▸ Integrations ▸

MQTT JSON

The mqtt_json device tracker integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

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

Configuration Variables

Looking for your configuration file?
devices list Required

List of devices with their topic.

qos string (Optional)

The QoS level of the topic.

Usage

This platform receives JSON formatted payloads containing GPS information, for example:

{"longitude": 1.0,"gps_accuracy": 60,"latitude": 2.0,"battery_level": 99.9}

Where longitude is the longitude, latitude is the latitude, gps_accuracy is the accuracy in meters, battery_level is the current battery level of the device sending the update. longitude and latitude are required keys, gps_accuracy and battery_level are optional.

Related topics