mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
c7f6ab2457
* Add mqtt valve platform * No stop topic-reports_position and validation * Do not allow state_open, state_closed with position reporing valve * Allow open/close feature to be disabled * Follow up comments * Rename * Apply defaults in validator * Update docstr
194 lines
5.2 KiB
Python
194 lines
5.2 KiB
Python
"""Constants used by multiple MQTT modules."""
|
|
from homeassistant.const import CONF_PAYLOAD, Platform
|
|
|
|
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_DISCOVERY_PREFIX = "discovery_prefix"
|
|
CONF_ENCODING = "encoding"
|
|
CONF_KEEPALIVE = "keepalive"
|
|
CONF_ORIGIN = "origin"
|
|
CONF_QOS = ATTR_QOS
|
|
CONF_RETAIN = ATTR_RETAIN
|
|
CONF_SCHEMA = "schema"
|
|
CONF_STATE_TOPIC = "state_topic"
|
|
CONF_STATE_VALUE_TEMPLATE = "state_value_template"
|
|
CONF_TOPIC = "topic"
|
|
CONF_TRANSPORT = "transport"
|
|
CONF_WS_PATH = "ws_path"
|
|
CONF_WS_HEADERS = "ws_headers"
|
|
CONF_WILL_MESSAGE = "will_message"
|
|
CONF_PAYLOAD_RESET = "payload_reset"
|
|
CONF_SUPPORTED_FEATURES = "supported_features"
|
|
|
|
CONF_ACTION_TEMPLATE = "action_template"
|
|
CONF_ACTION_TOPIC = "action_topic"
|
|
CONF_CURRENT_HUMIDITY_TEMPLATE = "current_humidity_template"
|
|
CONF_CURRENT_HUMIDITY_TOPIC = "current_humidity_topic"
|
|
CONF_CURRENT_TEMP_TEMPLATE = "current_temperature_template"
|
|
CONF_CURRENT_TEMP_TOPIC = "current_temperature_topic"
|
|
CONF_MODE_COMMAND_TEMPLATE = "mode_command_template"
|
|
CONF_MODE_COMMAND_TOPIC = "mode_command_topic"
|
|
CONF_MODE_LIST = "modes"
|
|
CONF_MODE_STATE_TEMPLATE = "mode_state_template"
|
|
CONF_MODE_STATE_TOPIC = "mode_state_topic"
|
|
CONF_PAYLOAD_CLOSE = "payload_close"
|
|
CONF_PAYLOAD_OPEN = "payload_open"
|
|
CONF_PAYLOAD_STOP = "payload_stop"
|
|
CONF_POSITION_CLOSED = "position_closed"
|
|
CONF_POSITION_OPEN = "position_open"
|
|
CONF_POWER_COMMAND_TOPIC = "power_command_topic"
|
|
CONF_POWER_COMMAND_TEMPLATE = "power_command_template"
|
|
CONF_PRECISION = "precision"
|
|
CONF_STATE_CLOSED = "state_closed"
|
|
CONF_STATE_CLOSING = "state_closing"
|
|
CONF_STATE_OPEN = "state_open"
|
|
CONF_STATE_OPENING = "state_opening"
|
|
CONF_TEMP_COMMAND_TEMPLATE = "temperature_command_template"
|
|
CONF_TEMP_COMMAND_TOPIC = "temperature_command_topic"
|
|
CONF_TEMP_STATE_TEMPLATE = "temperature_state_template"
|
|
CONF_TEMP_STATE_TOPIC = "temperature_state_topic"
|
|
CONF_TEMP_INITIAL = "initial"
|
|
CONF_TEMP_MAX = "max_temp"
|
|
CONF_TEMP_MIN = "min_temp"
|
|
|
|
CONF_CERTIFICATE = "certificate"
|
|
CONF_CLIENT_KEY = "client_key"
|
|
CONF_CLIENT_CERT = "client_cert"
|
|
CONF_TLS_INSECURE = "tls_insecure"
|
|
|
|
# Device and integration info options
|
|
CONF_IDENTIFIERS = "identifiers"
|
|
CONF_CONNECTIONS = "connections"
|
|
CONF_MANUFACTURER = "manufacturer"
|
|
CONF_HW_VERSION = "hw_version"
|
|
CONF_SW_VERSION = "sw_version"
|
|
CONF_VIA_DEVICE = "via_device"
|
|
CONF_DEPRECATED_VIA_HUB = "via_hub"
|
|
CONF_SUGGESTED_AREA = "suggested_area"
|
|
CONF_CONFIGURATION_URL = "configuration_url"
|
|
CONF_OBJECT_ID = "object_id"
|
|
CONF_SUPPORT_URL = "support_url"
|
|
|
|
DATA_MQTT = "mqtt"
|
|
DATA_MQTT_AVAILABLE = "mqtt_client_available"
|
|
|
|
DEFAULT_PREFIX = "homeassistant"
|
|
DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"
|
|
DEFAULT_DISCOVERY = True
|
|
DEFAULT_ENCODING = "utf-8"
|
|
DEFAULT_OPTIMISTIC = False
|
|
DEFAULT_QOS = 0
|
|
DEFAULT_PAYLOAD_AVAILABLE = "online"
|
|
DEFAULT_PAYLOAD_CLOSE = "CLOSE"
|
|
DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"
|
|
DEFAULT_PAYLOAD_OPEN = "OPEN"
|
|
DEFAULT_PORT = 1883
|
|
DEFAULT_RETAIN = False
|
|
DEFAULT_WS_HEADERS: dict[str, str] = {}
|
|
DEFAULT_WS_PATH = "/"
|
|
DEFAULT_POSITION_CLOSED = 0
|
|
DEFAULT_POSITION_OPEN = 100
|
|
DEFAULT_RETAIN = False
|
|
|
|
PROTOCOL_31 = "3.1"
|
|
PROTOCOL_311 = "3.1.1"
|
|
PROTOCOL_5 = "5"
|
|
SUPPORTED_PROTOCOLS = [PROTOCOL_31, PROTOCOL_311, PROTOCOL_5]
|
|
|
|
TRANSPORT_TCP = "tcp"
|
|
TRANSPORT_WEBSOCKETS = "websockets"
|
|
|
|
DEFAULT_PORT = 1883
|
|
DEFAULT_KEEPALIVE = 60
|
|
DEFAULT_PROTOCOL = PROTOCOL_311
|
|
DEFAULT_TRANSPORT = TRANSPORT_TCP
|
|
|
|
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"
|
|
|
|
PLATFORMS = [
|
|
Platform.ALARM_CONTROL_PANEL,
|
|
Platform.BINARY_SENSOR,
|
|
Platform.BUTTON,
|
|
Platform.CAMERA,
|
|
Platform.CLIMATE,
|
|
Platform.DEVICE_TRACKER,
|
|
Platform.EVENT,
|
|
Platform.COVER,
|
|
Platform.FAN,
|
|
Platform.HUMIDIFIER,
|
|
Platform.IMAGE,
|
|
Platform.LAWN_MOWER,
|
|
Platform.LIGHT,
|
|
Platform.LOCK,
|
|
Platform.NUMBER,
|
|
Platform.SELECT,
|
|
Platform.SCENE,
|
|
Platform.SENSOR,
|
|
Platform.SIREN,
|
|
Platform.SWITCH,
|
|
Platform.TEXT,
|
|
Platform.UPDATE,
|
|
Platform.VACUUM,
|
|
Platform.VALVE,
|
|
Platform.WATER_HEATER,
|
|
]
|
|
|
|
RELOADABLE_PLATFORMS = [
|
|
Platform.ALARM_CONTROL_PANEL,
|
|
Platform.BINARY_SENSOR,
|
|
Platform.BUTTON,
|
|
Platform.CAMERA,
|
|
Platform.CLIMATE,
|
|
Platform.COVER,
|
|
Platform.DEVICE_TRACKER,
|
|
Platform.EVENT,
|
|
Platform.FAN,
|
|
Platform.HUMIDIFIER,
|
|
Platform.IMAGE,
|
|
Platform.LIGHT,
|
|
Platform.LAWN_MOWER,
|
|
Platform.LOCK,
|
|
Platform.NUMBER,
|
|
Platform.SCENE,
|
|
Platform.SELECT,
|
|
Platform.SENSOR,
|
|
Platform.SIREN,
|
|
Platform.SWITCH,
|
|
Platform.TEXT,
|
|
Platform.UPDATE,
|
|
Platform.VACUUM,
|
|
Platform.VALVE,
|
|
Platform.WATER_HEATER,
|
|
]
|