1.8 KiB

title, description, ha_category, featured, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain, ha_platforms
title description ha_category featured ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_platforms
MQTT Instructions on how to setup MQTT within Home Assistant.
Hub
true pre 0.7 Local Push true
@emontnemery
mqtt
alarm_control_panel
binary_sensor
camera
climate
cover
fan
humidifier
lock
number
scene
sensor
select
switch

MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport.

Your first step to get MQTT and Home Assistant working is to choose a broker.

{% include integrations/config_flow.md %}

Manual configuration

Alternatively, if you want to manually configure MQTT, you will need to add the following to your configuration.yaml file.

To connect to your own MQTT broker:

# Example configuration.yaml entry
mqtt:
  broker: IP_ADDRESS_BROKER

Manual configuration is required when connecting to a broker over TLS.

# Example configuration.yaml entry
mqtt:
  certificate: "PATH_TO_CA.crt"
  broker: "IP_ADDRESS_BROKER"
  port: 8883
  username: "MQTT_USERNAME"
  password: !secret MQTT_PASSWORD

Additional features

Event event_mqtt_reloaded

Event event_mqtt_reloaded is fired when Manually configured MQTT entities have been reloaded and entities thus might have changed.

This event has no additional data.