Home Assistant Unofficial Reference 2024.12.1
const.py File Reference

Go to the source code of this file.

Namespaces

 homeassistant.components.mqtt.const
 

Variables

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