Skip to content

MQTT

The mqtt block. See Interface Reference for the topics published.

MqttConfig

MQTT broker connection, the mqtt block

host

host: str = '${oc.env:MQTT_HOST,localhost}'

Broker host name or IP address, from MQTT_HOST

user

user: str = f'${{oc.env:MQTT_USER,{MISSING}}}'

Broker user name, from MQTT_USER, the one mandatory setting

password

password: str | None = "${oc.env:MQTT_PASS,''}"

Broker password, from MQTT_PASS

port

port: int = '${oc.decode:${oc.env:MQTT_PORT,1883}}'

Broker port, from MQTT_PORT

topic_root

topic_root: str = 'updates2mqtt'

First level of every topic Updates2MQTT publishes, other than Home Assistant discovery and healthcheck

protocol

protocol: str = '${oc.env:MQTT_VERSION,3.11}'

MQTT protocol version, 3.1, 3.11 or 5, from MQTT_VERSION

transport

transport: str = "${oc.env:MQTT_TRANSPORT,'tcp'}"

tcp, websockets or unix, from MQTT_TRANSPORT

connect_timeout

connect_timeout: float = 20

Seconds to wait for the broker to accept a connection

keepalive

keepalive: int = 30

Seconds between MQTT keepalive pings

tls_mode

tls_mode: TlsMode = '${oc.env:MQTT_TLS_MODE,off}'

TLS for the broker connection, from MQTT_TLS_MODE

ca_certs

ca_certs: str | None = "${oc.env:MQTT_CA_CERTS,''}"

CA certificate bundle file to verify the broker, from MQTT_CA_CERTS

client_cert

client_cert: str | None = "${oc.env:MQTT_CLIENT_CERT,''}"

Client certificate file for mutual TLS, from MQTT_CLIENT_CERT

client_key

client_key: str | None = "${oc.env:MQTT_CLIENT_KEY,''}"

Client private key file for mutual TLS, from MQTT_CLIENT_KEY

client_key_password

client_key_password: str | None = (
    "${oc.env:MQTT_CLIENT_KEY_PASS,''}"
)

Password for the client private key, from MQTT_CLIENT_KEY_PASS

cert_reqs

cert_reqs: VerifyMode = (
    "${oc.env:MQTT_CERT_REQUIRED,CERT_REQUIRED}"
)

Broker certificate verification, CERT_REQUIRED, CERT_OPTIONAL or CERT_NONE, from MQTT_CERT_REQUIRED

TlsMode

MQTT broker TLS, matched case insensitively

ON

ON = auto()

TLS with certificate verification

OFF

OFF = auto()

Plain TCP

INSECURE

INSECURE = auto()

TLS without verifying the broker’s certificate or host name