Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.config_integration Namespace Reference

Variables

tuple CLIENT_KEY_AUTH_MSG
 
 CONFIG_SCHEMA_BASE
 
string DEFAULT_TLS_PROTOCOL = "auto"
 
list DEPRECATED_CERTIFICATE_CONFIG_KEYS
 
list DEPRECATED_CONFIG_KEYS
 

Detailed Description

Support for MQTT platform config setup.

Variable Documentation

◆ CLIENT_KEY_AUTH_MSG

tuple homeassistant.components.mqtt.config_integration.CLIENT_KEY_AUTH_MSG
Initial value:
1 = (
2  "client_key and client_cert must both be present in the MQTT broker configuration"
3 )

Definition at line 64 of file config_integration.py.

◆ CONFIG_SCHEMA_BASE

homeassistant.components.mqtt.config_integration.CONFIG_SCHEMA_BASE
Initial value:
1 = vol.Schema(
2  {
3  Platform.ALARM_CONTROL_PANEL.value: vol.All(cv.ensure_list, [dict]),
4  Platform.BINARY_SENSOR.value: vol.All(cv.ensure_list, [dict]),
5  Platform.BUTTON.value: vol.All(cv.ensure_list, [dict]),
6  Platform.CAMERA.value: vol.All(cv.ensure_list, [dict]),
7  Platform.CLIMATE.value: vol.All(cv.ensure_list, [dict]),
8  Platform.COVER.value: vol.All(cv.ensure_list, [dict]),
9  Platform.DEVICE_TRACKER.value: vol.All(cv.ensure_list, [dict]),
10  Platform.EVENT.value: vol.All(cv.ensure_list, [dict]),
11  Platform.FAN.value: vol.All(cv.ensure_list, [dict]),
12  Platform.HUMIDIFIER.value: vol.All(cv.ensure_list, [dict]),
13  Platform.IMAGE.value: vol.All(cv.ensure_list, [dict]),
14  Platform.LAWN_MOWER.value: vol.All(cv.ensure_list, [dict]),
15  Platform.LIGHT.value: vol.All(cv.ensure_list, [dict]),
16  Platform.LOCK.value: vol.All(cv.ensure_list, [dict]),
17  Platform.NOTIFY.value: vol.All(cv.ensure_list, [dict]),
18  Platform.NUMBER.value: vol.All(cv.ensure_list, [dict]),
19  Platform.SCENE.value: vol.All(cv.ensure_list, [dict]),
20  Platform.SELECT.value: vol.All(cv.ensure_list, [dict]),
21  Platform.SENSOR.value: vol.All(cv.ensure_list, [dict]),
22  Platform.SIREN.value: vol.All(cv.ensure_list, [dict]),
23  Platform.SWITCH.value: vol.All(cv.ensure_list, [dict]),
24  Platform.TEXT.value: vol.All(cv.ensure_list, [dict]),
25  Platform.UPDATE.value: vol.All(cv.ensure_list, [dict]),
26  Platform.VACUUM.value: vol.All(cv.ensure_list, [dict]),
27  Platform.VALVE.value: vol.All(cv.ensure_list, [dict]),
28  Platform.WATER_HEATER.value: vol.All(cv.ensure_list, [dict]),
29  }
30 )

Definition at line 32 of file config_integration.py.

◆ DEFAULT_TLS_PROTOCOL

string homeassistant.components.mqtt.config_integration.DEFAULT_TLS_PROTOCOL = "auto"

Definition at line 30 of file config_integration.py.

◆ DEPRECATED_CERTIFICATE_CONFIG_KEYS

list homeassistant.components.mqtt.config_integration.DEPRECATED_CERTIFICATE_CONFIG_KEYS
Initial value:
1 = [
2  CONF_CERTIFICATE,
3  CONF_CLIENT_CERT,
4  CONF_CLIENT_KEY,
5 ]

Definition at line 83 of file config_integration.py.

◆ DEPRECATED_CONFIG_KEYS

list homeassistant.components.mqtt.config_integration.DEPRECATED_CONFIG_KEYS
Initial value:
1 = [
2  CONF_BIRTH_MESSAGE,
3  CONF_BROKER,
4  CONF_CLIENT_ID,
5  CONF_DISCOVERY,
6  CONF_DISCOVERY_PREFIX,
7  CONF_KEEPALIVE,
8  CONF_PASSWORD,
9  CONF_PORT,
10  CONF_PROTOCOL,
11  CONF_TLS_INSECURE,
12  CONF_USERNAME,
13  CONF_WILL_MESSAGE,
14 ]

Definition at line 68 of file config_integration.py.