core/homeassistant/components/mqtt/const.py

"""Constants used by multiple MQTT modules."""
from homeassistant.const import CONF_PAYLOAD

ATTR_DISCOVERY_HASH = "discovery_hash"
ATTR_DISCOVERY_PAYLOAD = "discovery_payload"
ATTR_DISCOVERY_TOPIC = "discovery_topic"
ATTR_PAYLOAD = "payload"
ATTR_QOS = "qos"
ATTR_RETAIN = "retain"
ATTR_TOPIC = "topic"

CONF_BROKER = "broker"
CONF_BIRTH_MESSAGE = "birth_message"
CONF_DISCOVERY = "discovery"
CONF_QOS = ATTR_QOS
CONF_RETAIN = ATTR_RETAIN
CONF_STATE_TOPIC = "state_topic"
CONF_WILL_MESSAGE = "will_message"

DATA_MQTT_CONFIG = "mqtt_config"

DEFAULT_PREFIX = "homeassistant"
DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"
DEFAULT_DISCOVERY = True
DEFAULT_QOS = 0
DEFAULT_PAYLOAD_AVAILABLE = "online"
DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"
DEFAULT_RETAIN = False

DEFAULT_BIRTH = {
    ATTR_TOPIC: DEFAULT_BIRTH_WILL_TOPIC,
    CONF_PAYLOAD: DEFAULT_PAYLOAD_AVAILABLE,
    ATTR_QOS: DEFAULT_QOS,
    ATTR_RETAIN: DEFAULT_RETAIN,
}

DEFAULT_WILL = {
    ATTR_TOPIC: DEFAULT_BIRTH_WILL_TOPIC,
    CONF_PAYLOAD: DEFAULT_PAYLOAD_NOT_AVAILABLE,
    ATTR_QOS: DEFAULT_QOS,
    ATTR_RETAIN: DEFAULT_RETAIN,
}

MQTT_CONNECTED = "mqtt_connected"
MQTT_DISCONNECTED = "mqtt_disconnected"

PROTOCOL_311 = "3.1.1"
MQTT config entry (#16594) * MQTT config entry * Solely rely on config entry * Improve wawrning * Lint * Lint2 2018-09-14 09:57:31 +00:00			`"""Constants used by multiple MQTT modules."""`
Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 18:16:03 +00:00			`from homeassistant.const import CONF_PAYLOAD`

Black 2019-07-31 19:25:30 +00:00			`ATTR_DISCOVERY_HASH = "discovery_hash"`
Add MQTT debug info (#33461) * Add MQTT debug info * Tweaks * Tweaks 2020-04-01 17:00:40 +00:00			`ATTR_DISCOVERY_PAYLOAD = "discovery_payload"`
Add MQTT WS command to remove device (#31989) * Add MQTT WS command to remove device * Review comments, fix test * Fix tests 2020-02-25 04:46:02 +00:00			`ATTR_DISCOVERY_TOPIC = "discovery_topic"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 00:49:01 +00:00			`ATTR_PAYLOAD = "payload"`
			`ATTR_QOS = "qos"`
			`ATTR_RETAIN = "retain"`
			`ATTR_TOPIC = "topic"`

			`CONF_BROKER = "broker"`
			`CONF_BIRTH_MESSAGE = "birth_message"`
			`CONF_DISCOVERY = "discovery"`
			`CONF_QOS = ATTR_QOS`
			`CONF_RETAIN = ATTR_RETAIN`
Black 2019-07-31 19:25:30 +00:00			`CONF_STATE_TOPIC = "state_topic"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 00:49:01 +00:00			`CONF_WILL_MESSAGE = "will_message"`

Get option flow defaults from yaml for non configured MQTT options (#40177) 2020-09-19 20:10:01 +00:00			`DATA_MQTT_CONFIG = "mqtt_config"`

Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 18:16:03 +00:00			`DEFAULT_PREFIX = "homeassistant"`
			`DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"`
Enable MQTT discovery by default (#41361) 2020-10-07 12:51:06 +00:00			`DEFAULT_DISCOVERY = True`
Move imports in mqtt component (#27835) * move imports to top-level in mqtt server * move imports to top-level in mqtt configflow * move imports to top-level in mqtt init * move imports to top-level in mqtt vacuum * move imports to top-level in mqtt light 2019-10-18 00:04:27 +00:00			`DEFAULT_QOS = 0`
Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 18:16:03 +00:00			`DEFAULT_PAYLOAD_AVAILABLE = "online"`
			`DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 00:49:01 +00:00			`DEFAULT_RETAIN = False`
Set state for MQTT entities to 'unavailable' when no connection to broker (#36479) * Report 'unavailable' state when not connected to MQTT broker * Fix tests * Rewrite to remove the polling * Add tests * Add some fixes 2020-06-07 07:21:16 +00:00
Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 18:16:03 +00:00			`DEFAULT_BIRTH = {`
			`ATTR_TOPIC: DEFAULT_BIRTH_WILL_TOPIC,`
			`CONF_PAYLOAD: DEFAULT_PAYLOAD_AVAILABLE,`
			`ATTR_QOS: DEFAULT_QOS,`
			`ATTR_RETAIN: DEFAULT_RETAIN,`
			`}`

			`DEFAULT_WILL = {`
			`ATTR_TOPIC: DEFAULT_BIRTH_WILL_TOPIC,`
			`CONF_PAYLOAD: DEFAULT_PAYLOAD_NOT_AVAILABLE,`
			`ATTR_QOS: DEFAULT_QOS,`
			`ATTR_RETAIN: DEFAULT_RETAIN,`
			`}`

Set state for MQTT entities to 'unavailable' when no connection to broker (#36479) * Report 'unavailable' state when not connected to MQTT broker * Fix tests * Rewrite to remove the polling * Add tests * Add some fixes 2020-06-07 07:21:16 +00:00			`MQTT_CONNECTED = "mqtt_connected"`
			`MQTT_DISCONNECTED = "mqtt_disconnected"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 00:49:01 +00:00
			`PROTOCOL_311 = "3.1.1"`