hass-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_AVAILABILITY = "availability"
CONF_BROKER = "broker"
CONF_BIRTH_MESSAGE = "birth_message"
CONF_COMMAND_TEMPLATE = "command_template"
CONF_COMMAND_TOPIC = "command_topic"
CONF_ENCODING = "encoding"
CONF_QOS = ATTR_QOS
CONF_RETAIN = ATTR_RETAIN
CONF_STATE_TOPIC = "state_topic"
CONF_STATE_VALUE_TEMPLATE = "state_value_template"
CONF_TOPIC = "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_ENCODING = "utf-8"
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,
}

DOMAIN = "mqtt"

MQTT_CONNECTED = "mqtt_connected"
MQTT_DISCONNECTED = "mqtt_disconnected"

PAYLOAD_EMPTY_JSON = "{}"
PAYLOAD_NONE = "None"

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

Black 2019-07-31 12:25:30 -07:00			`ATTR_DISCOVERY_HASH = "discovery_hash"`
Add MQTT debug info (#33461) * Add MQTT debug info * Tweaks * Tweaks 2020-04-01 19:00:40 +02: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 05:46:02 +01:00			`ATTR_DISCOVERY_TOPIC = "discovery_topic"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02:00			`ATTR_PAYLOAD = "payload"`
			`ATTR_QOS = "qos"`
			`ATTR_RETAIN = "retain"`
			`ATTR_TOPIC = "topic"`

Allow MQTT discovery availability shortcut (#57479) * replace base in availability topic * add tests for availability shortcuts - fix import * group constants * simplified loop * Moving constants to .const * rename value to topic * move CONF_TOPIC to .const * move CONF_AVAILABILITY to .const * remove check for string * Silently ignore if no config topic is found. * CONF_TOPIC should be required 2021-10-11 23:37:31 +02:00			`CONF_AVAILABILITY = "availability"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02:00			`CONF_BROKER = "broker"`
			`CONF_BIRTH_MESSAGE = "birth_message"`
Move CONF_COMMAND_TEMPLATE to .const (#64558) 2022-01-20 16:15:26 +01:00			`CONF_COMMAND_TEMPLATE = "command_template"`
MQTT rework constants (#57529) * reference CONF_TOPIC to .const * Organize common mqtt constants 2021-10-12 11:26:38 +02:00			`CONF_COMMAND_TOPIC = "command_topic"`
Add mqtt sensor configurable state encoding for sensor and binary_sensor platform (#60447) * Add mqtt sensor state encoding * Make encoding attribute not specific to states * Move encoding attribute to schema base 2021-11-30 14:04:24 +01:00			`CONF_ENCODING = "encoding"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02:00			`CONF_QOS = ATTR_QOS`
			`CONF_RETAIN = ATTR_RETAIN`
Black 2019-07-31 12:25:30 -07:00			`CONF_STATE_TOPIC = "state_topic"`
Mqtt move to .const (#65631) 2022-02-10 09:18:35 +01:00			`CONF_STATE_VALUE_TEMPLATE = "state_value_template"`
Allow MQTT discovery availability shortcut (#57479) * replace base in availability topic * add tests for availability shortcuts - fix import * group constants * simplified loop * Moving constants to .const * rename value to topic * move CONF_TOPIC to .const * move CONF_AVAILABILITY to .const * remove check for string * Silently ignore if no config topic is found. * CONF_TOPIC should be required 2021-10-11 23:37:31 +02:00			`CONF_TOPIC = "topic"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02:00			`CONF_WILL_MESSAGE = "will_message"`

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

Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 20:16:03 +02:00			`DEFAULT_PREFIX = "homeassistant"`
			`DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"`
Enable MQTT discovery by default (#41361) 2020-10-07 14:51:06 +02:00			`DEFAULT_DISCOVERY = True`
Add mqtt sensor configurable state encoding for sensor and binary_sensor platform (#60447) * Add mqtt sensor state encoding * Make encoding attribute not specific to states * Move encoding attribute to schema base 2021-11-30 14:04:24 +01:00			`DEFAULT_ENCODING = "utf-8"`
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 11:04:27 +11:00			`DEFAULT_QOS = 0`
Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 20:16:03 +02:00			`DEFAULT_PAYLOAD_AVAILABLE = "online"`
			`DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02: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 11:21:16 +04:00
Adapt MQTT config flow to default birth and will (#37875) 2020-07-15 20:16:03 +02: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,`
			`}`

Add MQTT integration discovery (#41332) * Add MQTT integration discovery * Add script/hassfest/mqtt.py * Unsubscribe if config entry exists * Add homeassistant/generated/mqtt.py * Fix bad loop * Improve tests * Improve tests * Apply suggestions from code review Co-authored-by: Fabian Affolter <mail@fabian-affolter.ch> * Prevent initiating multiple config flows Co-authored-by: Fabian Affolter <mail@fabian-affolter.ch> 2020-10-07 18:30:51 +02:00			`DOMAIN = "mqtt"`

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 11:21:16 +04:00			`MQTT_CONNECTED = "mqtt_connected"`
			`MQTT_DISCONNECTED = "mqtt_disconnected"`
Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02:00
Add MQTT siren platform (#64440) * Add mqtt siren draft * fix tests * Intergrate notify platform * tests and fixes siren platform * Add tests notify platform * config parameters and abbreviations * remove duplicate key * undo move topic abbreviation * Move const CONF_MESSAGE_COMMAND_TEMPLATE * Remove notify service integration * Rework * Update homeassistant/components/mqtt/siren.py Co-authored-by: Erik Montnemery <erik@montnemery.com> * Publish JSON by default * Allow unknown state - rename value_template Co-authored-by: Erik Montnemery <erik@montnemery.com> 2022-01-31 10:31:57 +01:00			`PAYLOAD_EMPTY_JSON = "{}"`
			`PAYLOAD_NONE = "None"`

Support reconfiguring MQTT config entry (#36537) 2020-06-23 02:49:01 +02:00			`PROTOCOL_311 = "3.1.1"`