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

Variables

string ATTR_DISCOVERY_HASH = "discovery_hash"
 
string ATTR_DISCOVERY_PAYLOAD = "discovery_payload"
 
string ATTR_DISCOVERY_TOPIC = "discovery_topic"
 
string ATTR_PAYLOAD = "payload"
 
string ATTR_QOS = "qos"
 
string ATTR_RETAIN = "retain"
 
string ATTR_SERIAL_NUMBER = "serial_number"
 
string ATTR_TOPIC = "topic"
 
string AVAILABILITY_ALL = "all"
 
string AVAILABILITY_ANY = "any"
 
string AVAILABILITY_LATEST = "latest"
 
list AVAILABILITY_MODES = [AVAILABILITY_ALL, AVAILABILITY_ANY, AVAILABILITY_LATEST]
 
string CONF_ACTION_TEMPLATE = "action_template"
 
string CONF_ACTION_TOPIC = "action_topic"
 
string CONF_AVAILABILITY = "availability"
 
string CONF_AVAILABILITY_MODE = "availability_mode"
 
string CONF_AVAILABILITY_TEMPLATE = "availability_template"
 
string CONF_AVAILABILITY_TOPIC = "availability_topic"
 
string CONF_BIRTH_MESSAGE = "birth_message"
 
string CONF_BROKER = "broker"
 
string CONF_CERTIFICATE = "certificate"
 
string CONF_CLIENT_CERT = "client_cert"
 
string CONF_CLIENT_KEY = "client_key"
 
string CONF_COMMAND_TEMPLATE = "command_template"
 
string CONF_COMMAND_TOPIC = "command_topic"
 
string CONF_COMPONENTS = "components"
 
string CONF_CONFIGURATION_URL = "configuration_url"
 
string CONF_CONNECTIONS = "connections"
 
string CONF_CURRENT_HUMIDITY_TEMPLATE = "current_humidity_template"
 
string CONF_CURRENT_HUMIDITY_TOPIC = "current_humidity_topic"
 
string CONF_CURRENT_TEMP_TEMPLATE = "current_temperature_template"
 
string CONF_CURRENT_TEMP_TOPIC = "current_temperature_topic"
 
string CONF_DEPRECATED_VIA_HUB = "via_hub"
 
string CONF_DISCOVERY_PREFIX = "discovery_prefix"
 
string CONF_ENABLED_BY_DEFAULT = "enabled_by_default"
 
string CONF_ENCODING = "encoding"
 
string CONF_ENTITY_PICTURE = "entity_picture"
 
string CONF_HW_VERSION = "hw_version"
 
string CONF_IDENTIFIERS = "identifiers"
 
string CONF_JSON_ATTRS_TEMPLATE = "json_attributes_template"
 
string CONF_JSON_ATTRS_TOPIC = "json_attributes_topic"
 
string CONF_KEEPALIVE = "keepalive"
 
string CONF_MANUFACTURER = "manufacturer"
 
string CONF_MODE_COMMAND_TEMPLATE = "mode_command_template"
 
string CONF_MODE_COMMAND_TOPIC = "mode_command_topic"
 
string CONF_MODE_LIST = "modes"
 
string CONF_MODE_STATE_TEMPLATE = "mode_state_template"
 
string CONF_MODE_STATE_TOPIC = "mode_state_topic"
 
string CONF_OBJECT_ID = "object_id"
 
string CONF_OPTIONS = "options"
 
string CONF_ORIGIN = "origin"
 
string CONF_PAYLOAD_AVAILABLE = "payload_available"
 
string CONF_PAYLOAD_CLOSE = "payload_close"
 
string CONF_PAYLOAD_NOT_AVAILABLE = "payload_not_available"
 
string CONF_PAYLOAD_OPEN = "payload_open"
 
string CONF_PAYLOAD_RESET = "payload_reset"
 
string CONF_PAYLOAD_STOP = "payload_stop"
 
string CONF_POSITION_CLOSED = "position_closed"
 
string CONF_POSITION_OPEN = "position_open"
 
string CONF_POWER_COMMAND_TEMPLATE = "power_command_template"
 
string CONF_POWER_COMMAND_TOPIC = "power_command_topic"
 
string CONF_PRECISION = "precision"
 
string CONF_QOS = ATTR_QOS
 
string CONF_RETAIN = ATTR_RETAIN
 
string CONF_SCHEMA = "schema"
 
string CONF_SERIAL_NUMBER = "serial_number"
 
string CONF_STATE_CLOSED = "state_closed"
 
string CONF_STATE_CLOSING = "state_closing"
 
string CONF_STATE_OPEN = "state_open"
 
string CONF_STATE_OPENING = "state_opening"
 
string CONF_STATE_TOPIC = "state_topic"
 
string CONF_STATE_VALUE_TEMPLATE = "state_value_template"
 
string CONF_SUGGESTED_AREA = "suggested_area"
 
string CONF_SUPPORT_URL = "support_url"
 
string CONF_SUPPORTED_FEATURES = "supported_features"
 
string CONF_SW_VERSION = "sw_version"
 
string CONF_TEMP_COMMAND_TEMPLATE = "temperature_command_template"
 
string CONF_TEMP_COMMAND_TOPIC = "temperature_command_topic"
 
string CONF_TEMP_INITIAL = "initial"
 
string CONF_TEMP_MAX = "max_temp"
 
string CONF_TEMP_MIN = "min_temp"
 
string CONF_TEMP_STATE_TEMPLATE = "temperature_state_template"
 
string CONF_TEMP_STATE_TOPIC = "temperature_state_topic"
 
string CONF_TLS_INSECURE = "tls_insecure"
 
string CONF_TOPIC = "topic"
 
string CONF_TRANSPORT = "transport"
 
string CONF_VIA_DEVICE = "via_device"
 
string CONF_WILL_MESSAGE = "will_message"
 
string CONF_WS_HEADERS = "ws_headers"
 
string CONF_WS_PATH = "ws_path"
 
dictionary DEFAULT_BIRTH
 
string DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"
 
bool DEFAULT_DISCOVERY = True
 
string DEFAULT_ENCODING = "utf-8"
 
int DEFAULT_KEEPALIVE = 60
 
bool DEFAULT_OPTIMISTIC = False
 
string DEFAULT_PAYLOAD_AVAILABLE = "online"
 
string DEFAULT_PAYLOAD_CLOSE = "CLOSE"
 
string DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"
 
string DEFAULT_PAYLOAD_OPEN = "OPEN"
 
int DEFAULT_PORT = 1883
 
int DEFAULT_POSITION_CLOSED = 0
 
int DEFAULT_POSITION_OPEN = 100
 
string DEFAULT_PREFIX = "homeassistant"
 
string DEFAULT_PROTOCOL = PROTOCOL_311
 
int DEFAULT_QOS = 0
 
bool DEFAULT_RETAIN = False
 
string DEFAULT_TRANSPORT = TRANSPORT_TCP
 
dictionary DEFAULT_WILL
 
string DEFAULT_WS_PATH = "/"
 
string DOMAIN = "mqtt"
 
list ENTITY_PLATFORMS
 
 LOGGER = logging.getLogger(__package__)
 
string MQTT_CONNECTION_STATE = "mqtt_connection_state"
 
string PAYLOAD_EMPTY_JSON = "{}"
 
string PAYLOAD_NONE = "None"
 
string PROTOCOL_31 = "3.1"
 
string PROTOCOL_311 = "3.1.1"
 
string PROTOCOL_5 = "5"
 
tuple SUPPORTED_COMPONENTS
 
list SUPPORTED_PROTOCOLS = [PROTOCOL_31, PROTOCOL_311, PROTOCOL_5]
 
tuple TEMPLATE_ERRORS = (jinja2.TemplateError, TemplateError, TypeError, ValueError)
 
string TRANSPORT_TCP = "tcp"
 
string TRANSPORT_WEBSOCKETS = "websockets"
 

Detailed Description

Constants used by multiple MQTT modules.

Variable Documentation

◆ ATTR_DISCOVERY_HASH

string homeassistant.components.mqtt.const.ATTR_DISCOVERY_HASH = "discovery_hash"

Definition at line 10 of file const.py.

◆ ATTR_DISCOVERY_PAYLOAD

string homeassistant.components.mqtt.const.ATTR_DISCOVERY_PAYLOAD = "discovery_payload"

Definition at line 11 of file const.py.

◆ ATTR_DISCOVERY_TOPIC

string homeassistant.components.mqtt.const.ATTR_DISCOVERY_TOPIC = "discovery_topic"

Definition at line 12 of file const.py.

◆ ATTR_PAYLOAD

string homeassistant.components.mqtt.const.ATTR_PAYLOAD = "payload"

Definition at line 13 of file const.py.

◆ ATTR_QOS

string homeassistant.components.mqtt.const.ATTR_QOS = "qos"

Definition at line 14 of file const.py.

◆ ATTR_RETAIN

string homeassistant.components.mqtt.const.ATTR_RETAIN = "retain"

Definition at line 15 of file const.py.

◆ ATTR_SERIAL_NUMBER

string homeassistant.components.mqtt.const.ATTR_SERIAL_NUMBER = "serial_number"

Definition at line 16 of file const.py.

◆ ATTR_TOPIC

string homeassistant.components.mqtt.const.ATTR_TOPIC = "topic"

Definition at line 17 of file const.py.

◆ AVAILABILITY_ALL

string homeassistant.components.mqtt.const.AVAILABILITY_ALL = "all"

Definition at line 19 of file const.py.

◆ AVAILABILITY_ANY

string homeassistant.components.mqtt.const.AVAILABILITY_ANY = "any"

Definition at line 20 of file const.py.

◆ AVAILABILITY_LATEST

string homeassistant.components.mqtt.const.AVAILABILITY_LATEST = "latest"

Definition at line 21 of file const.py.

◆ AVAILABILITY_MODES

list homeassistant.components.mqtt.const.AVAILABILITY_MODES = [AVAILABILITY_ALL, AVAILABILITY_ANY, AVAILABILITY_LATEST]

Definition at line 23 of file const.py.

◆ CONF_ACTION_TEMPLATE

string homeassistant.components.mqtt.const.CONF_ACTION_TEMPLATE = "action_template"

Definition at line 57 of file const.py.

◆ CONF_ACTION_TOPIC

string homeassistant.components.mqtt.const.CONF_ACTION_TOPIC = "action_topic"

Definition at line 58 of file const.py.

◆ CONF_AVAILABILITY

string homeassistant.components.mqtt.const.CONF_AVAILABILITY = "availability"

Definition at line 28 of file const.py.

◆ CONF_AVAILABILITY_MODE

string homeassistant.components.mqtt.const.CONF_AVAILABILITY_MODE = "availability_mode"

Definition at line 30 of file const.py.

◆ CONF_AVAILABILITY_TEMPLATE

string homeassistant.components.mqtt.const.CONF_AVAILABILITY_TEMPLATE = "availability_template"

Definition at line 31 of file const.py.

◆ CONF_AVAILABILITY_TOPIC

string homeassistant.components.mqtt.const.CONF_AVAILABILITY_TOPIC = "availability_topic"

Definition at line 32 of file const.py.

◆ CONF_BIRTH_MESSAGE

string homeassistant.components.mqtt.const.CONF_BIRTH_MESSAGE = "birth_message"

Definition at line 34 of file const.py.

◆ CONF_BROKER

string homeassistant.components.mqtt.const.CONF_BROKER = "broker"

Definition at line 33 of file const.py.

◆ CONF_CERTIFICATE

string homeassistant.components.mqtt.const.CONF_CERTIFICATE = "certificate"

Definition at line 90 of file const.py.

◆ CONF_CLIENT_CERT

string homeassistant.components.mqtt.const.CONF_CLIENT_CERT = "client_cert"

Definition at line 92 of file const.py.

◆ CONF_CLIENT_KEY

string homeassistant.components.mqtt.const.CONF_CLIENT_KEY = "client_key"

Definition at line 91 of file const.py.

◆ CONF_COMMAND_TEMPLATE

string homeassistant.components.mqtt.const.CONF_COMMAND_TEMPLATE = "command_template"

Definition at line 35 of file const.py.

◆ CONF_COMMAND_TOPIC

string homeassistant.components.mqtt.const.CONF_COMMAND_TOPIC = "command_topic"

Definition at line 36 of file const.py.

◆ CONF_COMPONENTS

string homeassistant.components.mqtt.const.CONF_COMPONENTS = "components"

Definition at line 93 of file const.py.

◆ CONF_CONFIGURATION_URL

string homeassistant.components.mqtt.const.CONF_CONFIGURATION_URL = "configuration_url"

Definition at line 106 of file const.py.

◆ CONF_CONNECTIONS

string homeassistant.components.mqtt.const.CONF_CONNECTIONS = "connections"

Definition at line 98 of file const.py.

◆ CONF_CURRENT_HUMIDITY_TEMPLATE

string homeassistant.components.mqtt.const.CONF_CURRENT_HUMIDITY_TEMPLATE = "current_humidity_template"

Definition at line 59 of file const.py.

◆ CONF_CURRENT_HUMIDITY_TOPIC

string homeassistant.components.mqtt.const.CONF_CURRENT_HUMIDITY_TOPIC = "current_humidity_topic"

Definition at line 60 of file const.py.

◆ CONF_CURRENT_TEMP_TEMPLATE

string homeassistant.components.mqtt.const.CONF_CURRENT_TEMP_TEMPLATE = "current_temperature_template"

Definition at line 61 of file const.py.

◆ CONF_CURRENT_TEMP_TOPIC

string homeassistant.components.mqtt.const.CONF_CURRENT_TEMP_TOPIC = "current_temperature_topic"

Definition at line 62 of file const.py.

◆ CONF_DEPRECATED_VIA_HUB

string homeassistant.components.mqtt.const.CONF_DEPRECATED_VIA_HUB = "via_hub"

Definition at line 104 of file const.py.

◆ CONF_DISCOVERY_PREFIX

string homeassistant.components.mqtt.const.CONF_DISCOVERY_PREFIX = "discovery_prefix"

Definition at line 37 of file const.py.

◆ CONF_ENABLED_BY_DEFAULT

string homeassistant.components.mqtt.const.CONF_ENABLED_BY_DEFAULT = "enabled_by_default"

Definition at line 63 of file const.py.

◆ CONF_ENCODING

string homeassistant.components.mqtt.const.CONF_ENCODING = "encoding"

Definition at line 38 of file const.py.

◆ CONF_ENTITY_PICTURE

string homeassistant.components.mqtt.const.CONF_ENTITY_PICTURE = "entity_picture"

Definition at line 64 of file const.py.

◆ CONF_HW_VERSION

string homeassistant.components.mqtt.const.CONF_HW_VERSION = "hw_version"

Definition at line 100 of file const.py.

◆ CONF_IDENTIFIERS

string homeassistant.components.mqtt.const.CONF_IDENTIFIERS = "identifiers"

Definition at line 97 of file const.py.

◆ CONF_JSON_ATTRS_TEMPLATE

string homeassistant.components.mqtt.const.CONF_JSON_ATTRS_TEMPLATE = "json_attributes_template"

Definition at line 40 of file const.py.

◆ CONF_JSON_ATTRS_TOPIC

string homeassistant.components.mqtt.const.CONF_JSON_ATTRS_TOPIC = "json_attributes_topic"

Definition at line 39 of file const.py.

◆ CONF_KEEPALIVE

string homeassistant.components.mqtt.const.CONF_KEEPALIVE = "keepalive"

Definition at line 41 of file const.py.

◆ CONF_MANUFACTURER

string homeassistant.components.mqtt.const.CONF_MANUFACTURER = "manufacturer"

Definition at line 99 of file const.py.

◆ CONF_MODE_COMMAND_TEMPLATE

string homeassistant.components.mqtt.const.CONF_MODE_COMMAND_TEMPLATE = "mode_command_template"

Definition at line 65 of file const.py.

◆ CONF_MODE_COMMAND_TOPIC

string homeassistant.components.mqtt.const.CONF_MODE_COMMAND_TOPIC = "mode_command_topic"

Definition at line 66 of file const.py.

◆ CONF_MODE_LIST

string homeassistant.components.mqtt.const.CONF_MODE_LIST = "modes"

Definition at line 67 of file const.py.

◆ CONF_MODE_STATE_TEMPLATE

string homeassistant.components.mqtt.const.CONF_MODE_STATE_TEMPLATE = "mode_state_template"

Definition at line 68 of file const.py.

◆ CONF_MODE_STATE_TOPIC

string homeassistant.components.mqtt.const.CONF_MODE_STATE_TOPIC = "mode_state_topic"

Definition at line 69 of file const.py.

◆ CONF_OBJECT_ID

string homeassistant.components.mqtt.const.CONF_OBJECT_ID = "object_id"

Definition at line 107 of file const.py.

◆ CONF_OPTIONS

string homeassistant.components.mqtt.const.CONF_OPTIONS = "options"

Definition at line 42 of file const.py.

◆ CONF_ORIGIN

string homeassistant.components.mqtt.const.CONF_ORIGIN = "origin"

Definition at line 43 of file const.py.

◆ CONF_PAYLOAD_AVAILABLE

string homeassistant.components.mqtt.const.CONF_PAYLOAD_AVAILABLE = "payload_available"

Definition at line 25 of file const.py.

◆ CONF_PAYLOAD_CLOSE

string homeassistant.components.mqtt.const.CONF_PAYLOAD_CLOSE = "payload_close"

Definition at line 70 of file const.py.

◆ CONF_PAYLOAD_NOT_AVAILABLE

string homeassistant.components.mqtt.const.CONF_PAYLOAD_NOT_AVAILABLE = "payload_not_available"

Definition at line 26 of file const.py.

◆ CONF_PAYLOAD_OPEN

string homeassistant.components.mqtt.const.CONF_PAYLOAD_OPEN = "payload_open"

Definition at line 71 of file const.py.

◆ CONF_PAYLOAD_RESET

string homeassistant.components.mqtt.const.CONF_PAYLOAD_RESET = "payload_reset"

Definition at line 54 of file const.py.

◆ CONF_PAYLOAD_STOP

string homeassistant.components.mqtt.const.CONF_PAYLOAD_STOP = "payload_stop"

Definition at line 72 of file const.py.

◆ CONF_POSITION_CLOSED

string homeassistant.components.mqtt.const.CONF_POSITION_CLOSED = "position_closed"

Definition at line 73 of file const.py.

◆ CONF_POSITION_OPEN

string homeassistant.components.mqtt.const.CONF_POSITION_OPEN = "position_open"

Definition at line 74 of file const.py.

◆ CONF_POWER_COMMAND_TEMPLATE

string homeassistant.components.mqtt.const.CONF_POWER_COMMAND_TEMPLATE = "power_command_template"

Definition at line 76 of file const.py.

◆ CONF_POWER_COMMAND_TOPIC

string homeassistant.components.mqtt.const.CONF_POWER_COMMAND_TOPIC = "power_command_topic"

Definition at line 75 of file const.py.

◆ CONF_PRECISION

string homeassistant.components.mqtt.const.CONF_PRECISION = "precision"

Definition at line 77 of file const.py.

◆ CONF_QOS

string homeassistant.components.mqtt.const.CONF_QOS = ATTR_QOS

Definition at line 44 of file const.py.

◆ CONF_RETAIN

string homeassistant.components.mqtt.const.CONF_RETAIN = ATTR_RETAIN

Definition at line 45 of file const.py.

◆ CONF_SCHEMA

string homeassistant.components.mqtt.const.CONF_SCHEMA = "schema"

Definition at line 46 of file const.py.

◆ CONF_SERIAL_NUMBER

string homeassistant.components.mqtt.const.CONF_SERIAL_NUMBER = "serial_number"

Definition at line 102 of file const.py.

◆ CONF_STATE_CLOSED

string homeassistant.components.mqtt.const.CONF_STATE_CLOSED = "state_closed"

Definition at line 78 of file const.py.

◆ CONF_STATE_CLOSING

string homeassistant.components.mqtt.const.CONF_STATE_CLOSING = "state_closing"

Definition at line 79 of file const.py.

◆ CONF_STATE_OPEN

string homeassistant.components.mqtt.const.CONF_STATE_OPEN = "state_open"

Definition at line 80 of file const.py.

◆ CONF_STATE_OPENING

string homeassistant.components.mqtt.const.CONF_STATE_OPENING = "state_opening"

Definition at line 81 of file const.py.

◆ CONF_STATE_TOPIC

string homeassistant.components.mqtt.const.CONF_STATE_TOPIC = "state_topic"

Definition at line 47 of file const.py.

◆ CONF_STATE_VALUE_TEMPLATE

string homeassistant.components.mqtt.const.CONF_STATE_VALUE_TEMPLATE = "state_value_template"

Definition at line 48 of file const.py.

◆ CONF_SUGGESTED_AREA

string homeassistant.components.mqtt.const.CONF_SUGGESTED_AREA = "suggested_area"

Definition at line 105 of file const.py.

◆ CONF_SUPPORT_URL

string homeassistant.components.mqtt.const.CONF_SUPPORT_URL = "support_url"

Definition at line 108 of file const.py.

◆ CONF_SUPPORTED_FEATURES

string homeassistant.components.mqtt.const.CONF_SUPPORTED_FEATURES = "supported_features"

Definition at line 55 of file const.py.

◆ CONF_SW_VERSION

string homeassistant.components.mqtt.const.CONF_SW_VERSION = "sw_version"

Definition at line 101 of file const.py.

◆ CONF_TEMP_COMMAND_TEMPLATE

string homeassistant.components.mqtt.const.CONF_TEMP_COMMAND_TEMPLATE = "temperature_command_template"

Definition at line 82 of file const.py.

◆ CONF_TEMP_COMMAND_TOPIC

string homeassistant.components.mqtt.const.CONF_TEMP_COMMAND_TOPIC = "temperature_command_topic"

Definition at line 83 of file const.py.

◆ CONF_TEMP_INITIAL

string homeassistant.components.mqtt.const.CONF_TEMP_INITIAL = "initial"

Definition at line 86 of file const.py.

◆ CONF_TEMP_MAX

string homeassistant.components.mqtt.const.CONF_TEMP_MAX = "max_temp"

Definition at line 87 of file const.py.

◆ CONF_TEMP_MIN

string homeassistant.components.mqtt.const.CONF_TEMP_MIN = "min_temp"

Definition at line 88 of file const.py.

◆ CONF_TEMP_STATE_TEMPLATE

string homeassistant.components.mqtt.const.CONF_TEMP_STATE_TEMPLATE = "temperature_state_template"

Definition at line 84 of file const.py.

◆ CONF_TEMP_STATE_TOPIC

string homeassistant.components.mqtt.const.CONF_TEMP_STATE_TOPIC = "temperature_state_topic"

Definition at line 85 of file const.py.

◆ CONF_TLS_INSECURE

string homeassistant.components.mqtt.const.CONF_TLS_INSECURE = "tls_insecure"

Definition at line 94 of file const.py.

◆ CONF_TOPIC

string homeassistant.components.mqtt.const.CONF_TOPIC = "topic"

Definition at line 49 of file const.py.

◆ CONF_TRANSPORT

string homeassistant.components.mqtt.const.CONF_TRANSPORT = "transport"

Definition at line 50 of file const.py.

◆ CONF_VIA_DEVICE

string homeassistant.components.mqtt.const.CONF_VIA_DEVICE = "via_device"

Definition at line 103 of file const.py.

◆ CONF_WILL_MESSAGE

string homeassistant.components.mqtt.const.CONF_WILL_MESSAGE = "will_message"

Definition at line 53 of file const.py.

◆ CONF_WS_HEADERS

string homeassistant.components.mqtt.const.CONF_WS_HEADERS = "ws_headers"

Definition at line 52 of file const.py.

◆ CONF_WS_PATH

string homeassistant.components.mqtt.const.CONF_WS_PATH = "ws_path"

Definition at line 51 of file const.py.

◆ DEFAULT_BIRTH

dictionary homeassistant.components.mqtt.const.DEFAULT_BIRTH
Initial value:
1 = {
2  ATTR_TOPIC: DEFAULT_BIRTH_WILL_TOPIC,
3  CONF_PAYLOAD: DEFAULT_PAYLOAD_AVAILABLE,
4  ATTR_QOS: DEFAULT_QOS,
5  ATTR_RETAIN: DEFAULT_RETAIN,
6 }

Definition at line 141 of file const.py.

◆ DEFAULT_BIRTH_WILL_TOPIC

string homeassistant.components.mqtt.const.DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"

Definition at line 111 of file const.py.

◆ DEFAULT_DISCOVERY

bool homeassistant.components.mqtt.const.DEFAULT_DISCOVERY = True

Definition at line 112 of file const.py.

◆ DEFAULT_ENCODING

string homeassistant.components.mqtt.const.DEFAULT_ENCODING = "utf-8"

Definition at line 113 of file const.py.

◆ DEFAULT_KEEPALIVE

int homeassistant.components.mqtt.const.DEFAULT_KEEPALIVE = 60

Definition at line 137 of file const.py.

◆ DEFAULT_OPTIMISTIC

bool homeassistant.components.mqtt.const.DEFAULT_OPTIMISTIC = False

Definition at line 114 of file const.py.

◆ DEFAULT_PAYLOAD_AVAILABLE

string homeassistant.components.mqtt.const.DEFAULT_PAYLOAD_AVAILABLE = "online"

Definition at line 116 of file const.py.

◆ DEFAULT_PAYLOAD_CLOSE

string homeassistant.components.mqtt.const.DEFAULT_PAYLOAD_CLOSE = "CLOSE"

Definition at line 117 of file const.py.

◆ DEFAULT_PAYLOAD_NOT_AVAILABLE

string homeassistant.components.mqtt.const.DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"

Definition at line 118 of file const.py.

◆ DEFAULT_PAYLOAD_OPEN

string homeassistant.components.mqtt.const.DEFAULT_PAYLOAD_OPEN = "OPEN"

Definition at line 119 of file const.py.

◆ DEFAULT_PORT

int homeassistant.components.mqtt.const.DEFAULT_PORT = 1883

Definition at line 120 of file const.py.

◆ DEFAULT_POSITION_CLOSED

int homeassistant.components.mqtt.const.DEFAULT_POSITION_CLOSED = 0

Definition at line 124 of file const.py.

◆ DEFAULT_POSITION_OPEN

int homeassistant.components.mqtt.const.DEFAULT_POSITION_OPEN = 100

Definition at line 125 of file const.py.

◆ DEFAULT_PREFIX

string homeassistant.components.mqtt.const.DEFAULT_PREFIX = "homeassistant"

Definition at line 110 of file const.py.

◆ DEFAULT_PROTOCOL

string homeassistant.components.mqtt.const.DEFAULT_PROTOCOL = PROTOCOL_311

Definition at line 138 of file const.py.

◆ DEFAULT_QOS

int homeassistant.components.mqtt.const.DEFAULT_QOS = 0

Definition at line 115 of file const.py.

◆ DEFAULT_RETAIN

bool homeassistant.components.mqtt.const.DEFAULT_RETAIN = False

Definition at line 121 of file const.py.

◆ DEFAULT_TRANSPORT

string homeassistant.components.mqtt.const.DEFAULT_TRANSPORT = TRANSPORT_TCP

Definition at line 139 of file const.py.

◆ DEFAULT_WILL

dictionary homeassistant.components.mqtt.const.DEFAULT_WILL
Initial value:
1 = {
2  ATTR_TOPIC: DEFAULT_BIRTH_WILL_TOPIC,
3  CONF_PAYLOAD: DEFAULT_PAYLOAD_NOT_AVAILABLE,
4  ATTR_QOS: DEFAULT_QOS,
5  ATTR_RETAIN: DEFAULT_RETAIN,
6 }

Definition at line 148 of file const.py.

◆ DEFAULT_WS_PATH

string homeassistant.components.mqtt.const.DEFAULT_WS_PATH = "/"

Definition at line 123 of file const.py.

◆ DOMAIN

string homeassistant.components.mqtt.const.DOMAIN = "mqtt"

Definition at line 155 of file const.py.

◆ ENTITY_PLATFORMS

list homeassistant.components.mqtt.const.ENTITY_PLATFORMS
Initial value:
1 = [
2  Platform.ALARM_CONTROL_PANEL,
3  Platform.BINARY_SENSOR,
4  Platform.BUTTON,
5  Platform.CAMERA,
6  Platform.CLIMATE,
7  Platform.COVER,
8  Platform.DEVICE_TRACKER,
9  Platform.EVENT,
10  Platform.FAN,
11  Platform.HUMIDIFIER,
12  Platform.IMAGE,
13  Platform.LIGHT,
14  Platform.LAWN_MOWER,
15  Platform.LOCK,
16  Platform.NOTIFY,
17  Platform.NUMBER,
18  Platform.SCENE,
19  Platform.SELECT,
20  Platform.SENSOR,
21  Platform.SIREN,
22  Platform.SWITCH,
23  Platform.TEXT,
24  Platform.UPDATE,
25  Platform.VACUUM,
26  Platform.VALVE,
27  Platform.WATER_HEATER,
28 ]

Definition at line 163 of file const.py.

◆ LOGGER

homeassistant.components.mqtt.const.LOGGER = logging.getLogger(__package__)

Definition at line 156 of file const.py.

◆ MQTT_CONNECTION_STATE

string homeassistant.components.mqtt.const.MQTT_CONNECTION_STATE = "mqtt_connection_state"

Definition at line 158 of file const.py.

◆ PAYLOAD_EMPTY_JSON

string homeassistant.components.mqtt.const.PAYLOAD_EMPTY_JSON = "{}"

Definition at line 160 of file const.py.

◆ PAYLOAD_NONE

string homeassistant.components.mqtt.const.PAYLOAD_NONE = "None"

Definition at line 161 of file const.py.

◆ PROTOCOL_31

string homeassistant.components.mqtt.const.PROTOCOL_31 = "3.1"

Definition at line 128 of file const.py.

◆ PROTOCOL_311

string homeassistant.components.mqtt.const.PROTOCOL_311 = "3.1.1"

Definition at line 129 of file const.py.

◆ PROTOCOL_5

string homeassistant.components.mqtt.const.PROTOCOL_5 = "5"

Definition at line 130 of file const.py.

◆ SUPPORTED_COMPONENTS

tuple homeassistant.components.mqtt.const.SUPPORTED_COMPONENTS
Initial value:
1 = (
2  "alarm_control_panel",
3  "binary_sensor",
4  "button",
5  "camera",
6  "climate",
7  "cover",
8  "device_automation",
9  "device_tracker",
10  "event",
11  "fan",
12  "humidifier",
13  "image",
14  "lawn_mower",
15  "light",
16  "lock",
17  "notify",
18  "number",
19  "scene",
20  "siren",
21  "select",
22  "sensor",
23  "switch",
24  "tag",
25  "text",
26  "update",
27  "vacuum",
28  "valve",
29  "water_heater",
30 )

Definition at line 194 of file const.py.

◆ SUPPORTED_PROTOCOLS

list homeassistant.components.mqtt.const.SUPPORTED_PROTOCOLS = [PROTOCOL_31, PROTOCOL_311, PROTOCOL_5]

Definition at line 131 of file const.py.

◆ TEMPLATE_ERRORS

tuple homeassistant.components.mqtt.const.TEMPLATE_ERRORS = (jinja2.TemplateError, TemplateError, TypeError, ValueError)

Definition at line 192 of file const.py.

◆ TRANSPORT_TCP

string homeassistant.components.mqtt.const.TRANSPORT_TCP = "tcp"

Definition at line 133 of file const.py.

◆ TRANSPORT_WEBSOCKETS

string homeassistant.components.mqtt.const.TRANSPORT_WEBSOCKETS = "websockets"

Definition at line 134 of file const.py.