Move MQTT light constants to const module (#140945)

Author: jbouwh

homeassistant/components/mqtt/const.py

@@ -56,20 +56,53 @@
 
 CONF_ACTION_TEMPLATE = "action_template"
 CONF_ACTION_TOPIC = "action_topic"
+CONF_BLUE_TEMPLATE = "blue_template"
+CONF_BRIGHTNESS_COMMAND_TEMPLATE = "brightness_command_template"
+CONF_BRIGHTNESS_COMMAND_TOPIC = "brightness_command_topic"
+CONF_BRIGHTNESS_SCALE = "brightness_scale"
+CONF_BRIGHTNESS_STATE_TOPIC = "brightness_state_topic"
+CONF_BRIGHTNESS_TEMPLATE = "brightness_template"
+CONF_BRIGHTNESS_VALUE_TEMPLATE = "brightness_value_template"
+CONF_COLOR_MODE = "color_mode"
+CONF_COLOR_MODE_STATE_TOPIC = "color_mode_state_topic"
+CONF_COLOR_MODE_VALUE_TEMPLATE = "color_mode_value_template"
+CONF_COLOR_TEMP_COMMAND_TEMPLATE = "color_temp_command_template"
+CONF_COLOR_TEMP_COMMAND_TOPIC = "color_temp_command_topic"
 CONF_COLOR_TEMP_KELVIN = "color_temp_kelvin"
+CONF_COLOR_TEMP_TEMPLATE = "color_temp_template"
+CONF_COLOR_TEMP_STATE_TOPIC = "color_temp_state_topic"
+CONF_COLOR_TEMP_VALUE_TEMPLATE = "color_temp_value_template"
+CONF_COMMAND_OFF_TEMPLATE = "command_off_template"
+CONF_COMMAND_ON_TEMPLATE = "command_on_template"
 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_ENABLED_BY_DEFAULT = "enabled_by_default"
+CONF_EFFECT_COMMAND_TEMPLATE = "effect_command_template"
+CONF_EFFECT_COMMAND_TOPIC = "effect_command_topic"
+CONF_EFFECT_LIST = "effect_list"
+CONF_EFFECT_STATE_TOPIC = "effect_state_topic"
+CONF_EFFECT_TEMPLATE = "effect_template"
+CONF_EFFECT_VALUE_TEMPLATE = "effect_value_template"
 CONF_ENTITY_PICTURE = "entity_picture"
+CONF_FLASH_TIME_LONG = "flash_time_long"
+CONF_FLASH_TIME_SHORT = "flash_time_short"
+CONF_GREEN_TEMPLATE = "green_template"
+CONF_HS_COMMAND_TEMPLATE = "hs_command_template"
+CONF_HS_COMMAND_TOPIC = "hs_command_topic"
+CONF_HS_STATE_TOPIC = "hs_state_topic"
+CONF_HS_VALUE_TEMPLATE = "hs_value_template"
 CONF_MAX_KELVIN = "max_kelvin"
+CONF_MAX_MIREDS = "max_mireds"
 CONF_MIN_KELVIN = "min_kelvin"
+CONF_MIN_MIREDS = "min_mireds"
 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_ON_COMMAND_TYPE = "on_command_type"
 CONF_PAYLOAD_CLOSE = "payload_close"
 CONF_PAYLOAD_OPEN = "payload_open"
 CONF_PAYLOAD_STOP = "payload_stop"
@@ -78,18 +111,39 @@
 CONF_POWER_COMMAND_TOPIC = "power_command_topic"
 CONF_POWER_COMMAND_TEMPLATE = "power_command_template"
 CONF_PRECISION = "precision"
+CONF_RED_TEMPLATE = "red_template"
+CONF_RGB_COMMAND_TEMPLATE = "rgb_command_template"
+CONF_RGB_COMMAND_TOPIC = "rgb_command_topic"
+CONF_RGB_STATE_TOPIC = "rgb_state_topic"
+CONF_RGB_VALUE_TEMPLATE = "rgb_value_template"
+CONF_RGBW_COMMAND_TEMPLATE = "rgbw_command_template"
+CONF_RGBW_COMMAND_TOPIC = "rgbw_command_topic"
+CONF_RGBW_STATE_TOPIC = "rgbw_state_topic"
+CONF_RGBW_VALUE_TEMPLATE = "rgbw_value_template"
+CONF_RGBWW_COMMAND_TEMPLATE = "rgbww_command_template"
+CONF_RGBWW_COMMAND_TOPIC = "rgbww_command_topic"
+CONF_RGBWW_STATE_TOPIC = "rgbww_state_topic"
+CONF_RGBWW_VALUE_TEMPLATE = "rgbww_value_template"
 CONF_STATE_CLOSED = "state_closed"
 CONF_STATE_CLOSING = "state_closing"
 CONF_STATE_OPEN = "state_open"
 CONF_STATE_OPENING = "state_opening"
+CONF_SUPPORTED_COLOR_MODES = "supported_color_modes"
 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_XY_COMMAND_TEMPLATE = "xy_command_template"
+CONF_XY_COMMAND_TOPIC = "xy_command_topic"
+CONF_XY_STATE_TOPIC = "xy_state_topic"
+CONF_XY_VALUE_TEMPLATE = "xy_value_template"
+CONF_WHITE_COMMAND_TOPIC = "white_command_topic"
+CONF_WHITE_SCALE = "white_scale"
 
+# Config flow constants
 CONF_CERTIFICATE = "certificate"
 CONF_CLIENT_KEY = "client_key"
 CONF_CLIENT_CERT = "client_cert"
@@ -110,15 +164,23 @@
 CONF_OBJECT_ID = "object_id"
 CONF_SUPPORT_URL = "support_url"
 
+DEFAULT_BRIGHTNESS = False
+DEFAULT_BRIGHTNESS_SCALE = 255
 DEFAULT_PREFIX = "homeassistant"
 DEFAULT_BIRTH_WILL_TOPIC = DEFAULT_PREFIX + "/status"
 DEFAULT_DISCOVERY = True
+DEFAULT_EFFECT = False
 DEFAULT_ENCODING = "utf-8"
+DEFAULT_FLASH_TIME_LONG = 10
+DEFAULT_FLASH_TIME_SHORT = 2
 DEFAULT_OPTIMISTIC = False
+DEFAULT_ON_COMMAND_TYPE = "last"
 DEFAULT_QOS = 0
 DEFAULT_PAYLOAD_AVAILABLE = "online"
 DEFAULT_PAYLOAD_CLOSE = "CLOSE"
 DEFAULT_PAYLOAD_NOT_AVAILABLE = "offline"
+DEFAULT_PAYLOAD_OFF = "OFF"
+DEFAULT_PAYLOAD_ON = "ON"
 DEFAULT_PAYLOAD_OPEN = "OPEN"
 DEFAULT_PORT = 1883
 DEFAULT_RETAIN = False
@@ -127,6 +189,7 @@
 DEFAULT_POSITION_CLOSED = 0
 DEFAULT_POSITION_OPEN = 100
 DEFAULT_RETAIN = False
+DEFAULT_WHITE_SCALE = 255
 
 PROTOCOL_31 = "3.1"
 PROTOCOL_311 = "3.1.1"

homeassistant/components/mqtt/light/schema_basic.py

@@ -51,12 +51,58 @@
 from .. import subscription
 from ..config import MQTT_RW_SCHEMA
 from ..const import (
+    CONF_BRIGHTNESS_COMMAND_TEMPLATE,
+    CONF_BRIGHTNESS_COMMAND_TOPIC,
+    CONF_BRIGHTNESS_SCALE,
+    CONF_BRIGHTNESS_STATE_TOPIC,
+    CONF_BRIGHTNESS_VALUE_TEMPLATE,
+    CONF_COLOR_MODE_STATE_TOPIC,
+    CONF_COLOR_MODE_VALUE_TEMPLATE,
+    CONF_COLOR_TEMP_COMMAND_TEMPLATE,
+    CONF_COLOR_TEMP_COMMAND_TOPIC,
     CONF_COLOR_TEMP_KELVIN,
+    CONF_COLOR_TEMP_STATE_TOPIC,
+    CONF_COLOR_TEMP_VALUE_TEMPLATE,
     CONF_COMMAND_TOPIC,
+    CONF_EFFECT_COMMAND_TEMPLATE,
+    CONF_EFFECT_COMMAND_TOPIC,
+    CONF_EFFECT_LIST,
+    CONF_EFFECT_STATE_TOPIC,
+    CONF_EFFECT_VALUE_TEMPLATE,
+    CONF_HS_COMMAND_TEMPLATE,
+    CONF_HS_COMMAND_TOPIC,
+    CONF_HS_STATE_TOPIC,
+    CONF_HS_VALUE_TEMPLATE,
     CONF_MAX_KELVIN,
+    CONF_MAX_MIREDS,
     CONF_MIN_KELVIN,
+    CONF_MIN_MIREDS,
+    CONF_ON_COMMAND_TYPE,
+    CONF_RGB_COMMAND_TEMPLATE,
+    CONF_RGB_COMMAND_TOPIC,
+    CONF_RGB_STATE_TOPIC,
+    CONF_RGB_VALUE_TEMPLATE,
+    CONF_RGBW_COMMAND_TEMPLATE,
+    CONF_RGBW_COMMAND_TOPIC,
+    CONF_RGBW_STATE_TOPIC,
+    CONF_RGBW_VALUE_TEMPLATE,
+    CONF_RGBWW_COMMAND_TEMPLATE,
+    CONF_RGBWW_COMMAND_TOPIC,
+    CONF_RGBWW_STATE_TOPIC,
+    CONF_RGBWW_VALUE_TEMPLATE,
     CONF_STATE_TOPIC,
     CONF_STATE_VALUE_TEMPLATE,
+    CONF_WHITE_COMMAND_TOPIC,
+    CONF_WHITE_SCALE,
+    CONF_XY_COMMAND_TEMPLATE,
+    CONF_XY_COMMAND_TOPIC,
+    CONF_XY_STATE_TOPIC,
+    CONF_XY_VALUE_TEMPLATE,
+    DEFAULT_BRIGHTNESS_SCALE,
+    DEFAULT_ON_COMMAND_TYPE,
+    DEFAULT_PAYLOAD_OFF,
+    DEFAULT_PAYLOAD_ON,
+    DEFAULT_WHITE_SCALE,
     PAYLOAD_NONE,
 )
 from ..entity import MqttEntity
@@ -74,47 +120,7 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-CONF_BRIGHTNESS_COMMAND_TEMPLATE = "brightness_command_template"
-CONF_BRIGHTNESS_COMMAND_TOPIC = "brightness_command_topic"
-CONF_BRIGHTNESS_SCALE = "brightness_scale"
-CONF_BRIGHTNESS_STATE_TOPIC = "brightness_state_topic"
-CONF_BRIGHTNESS_VALUE_TEMPLATE = "brightness_value_template"
-CONF_COLOR_MODE_STATE_TOPIC = "color_mode_state_topic"
-CONF_COLOR_MODE_VALUE_TEMPLATE = "color_mode_value_template"
-CONF_COLOR_TEMP_COMMAND_TEMPLATE = "color_temp_command_template"
-CONF_COLOR_TEMP_COMMAND_TOPIC = "color_temp_command_topic"
-CONF_COLOR_TEMP_STATE_TOPIC = "color_temp_state_topic"
-CONF_COLOR_TEMP_VALUE_TEMPLATE = "color_temp_value_template"
-CONF_EFFECT_COMMAND_TEMPLATE = "effect_command_template"
-CONF_EFFECT_COMMAND_TOPIC = "effect_command_topic"
-CONF_EFFECT_LIST = "effect_list"
-CONF_EFFECT_STATE_TOPIC = "effect_state_topic"
-CONF_EFFECT_VALUE_TEMPLATE = "effect_value_template"
-CONF_HS_COMMAND_TEMPLATE = "hs_command_template"
-CONF_HS_COMMAND_TOPIC = "hs_command_topic"
-CONF_HS_STATE_TOPIC = "hs_state_topic"
-CONF_HS_VALUE_TEMPLATE = "hs_value_template"
-CONF_MAX_MIREDS = "max_mireds"
-CONF_MIN_MIREDS = "min_mireds"
-CONF_RGB_COMMAND_TEMPLATE = "rgb_command_template"
-CONF_RGB_COMMAND_TOPIC = "rgb_command_topic"
-CONF_RGB_STATE_TOPIC = "rgb_state_topic"
-CONF_RGB_VALUE_TEMPLATE = "rgb_value_template"
-CONF_RGBW_COMMAND_TEMPLATE = "rgbw_command_template"
-CONF_RGBW_COMMAND_TOPIC = "rgbw_command_topic"
-CONF_RGBW_STATE_TOPIC = "rgbw_state_topic"
-CONF_RGBW_VALUE_TEMPLATE = "rgbw_value_template"
-CONF_RGBWW_COMMAND_TEMPLATE = "rgbww_command_template"
-CONF_RGBWW_COMMAND_TOPIC = "rgbww_command_topic"
-CONF_RGBWW_STATE_TOPIC = "rgbww_state_topic"
-CONF_RGBWW_VALUE_TEMPLATE = "rgbww_value_template"
-CONF_XY_COMMAND_TEMPLATE = "xy_command_template"
-CONF_XY_COMMAND_TOPIC = "xy_command_topic"
-CONF_XY_STATE_TOPIC = "xy_state_topic"
-CONF_XY_VALUE_TEMPLATE = "xy_value_template"
-CONF_WHITE_COMMAND_TOPIC = "white_command_topic"
-CONF_WHITE_SCALE = "white_scale"
-CONF_ON_COMMAND_TYPE = "on_command_type"
+DEFAULT_NAME = "MQTT LightEntity"
 
 MQTT_LIGHT_ATTRIBUTES_BLOCKED = frozenset(
     {
@@ -137,13 +143,6 @@
     }
 )
 
-DEFAULT_BRIGHTNESS_SCALE = 255
-DEFAULT_NAME = "MQTT LightEntity"
-DEFAULT_PAYLOAD_OFF = "OFF"
-DEFAULT_PAYLOAD_ON = "ON"
-DEFAULT_WHITE_SCALE = 255
-DEFAULT_ON_COMMAND_TYPE = "last"
-
 VALUES_ON_COMMAND_TYPE = ["first", "last", "brightness"]
 
 COMMAND_TEMPLATE_KEYS = [

homeassistant/components/mqtt/light/schema_json.py

@@ -55,13 +55,26 @@
 from .. import subscription
 from ..config import DEFAULT_QOS, DEFAULT_RETAIN, MQTT_RW_SCHEMA
 from ..const import (
+    CONF_COLOR_MODE,
     CONF_COLOR_TEMP_KELVIN,
     CONF_COMMAND_TOPIC,
+    CONF_EFFECT_LIST,
+    CONF_FLASH_TIME_LONG,
+    CONF_FLASH_TIME_SHORT,
     CONF_MAX_KELVIN,
+    CONF_MAX_MIREDS,
     CONF_MIN_KELVIN,
+    CONF_MIN_MIREDS,
     CONF_QOS,
     CONF_RETAIN,
     CONF_STATE_TOPIC,
+    CONF_SUPPORTED_COLOR_MODES,
+    DEFAULT_BRIGHTNESS,
+    DEFAULT_BRIGHTNESS_SCALE,
+    DEFAULT_EFFECT,
+    DEFAULT_FLASH_TIME_LONG,
+    DEFAULT_FLASH_TIME_SHORT,
+    DEFAULT_WHITE_SCALE,
 )
 from ..entity import MqttEntity
 from ..models import ReceiveMessage
@@ -78,25 +91,7 @@
 
 DOMAIN = "mqtt_json"
 
-DEFAULT_BRIGHTNESS = False
-DEFAULT_EFFECT = False
-DEFAULT_FLASH_TIME_LONG = 10
-DEFAULT_FLASH_TIME_SHORT = 2
 DEFAULT_NAME = "MQTT JSON Light"
-DEFAULT_BRIGHTNESS_SCALE = 255
-DEFAULT_WHITE_SCALE = 255
-
-CONF_COLOR_MODE = "color_mode"
-CONF_SUPPORTED_COLOR_MODES = "supported_color_modes"
-
-CONF_EFFECT_LIST = "effect_list"
-
-CONF_FLASH_TIME_LONG = "flash_time_long"
-CONF_FLASH_TIME_SHORT = "flash_time_short"
-
-CONF_MAX_MIREDS = "max_mireds"
-CONF_MIN_MIREDS = "min_mireds"
-
 
 _PLATFORM_SCHEMA_BASE = (
     MQTT_RW_SCHEMA.extend(

homeassistant/components/mqtt/light/schema_template.py

@@ -40,10 +40,21 @@
 from .. import subscription
 from ..config import MQTT_RW_SCHEMA
 from ..const import (
+    CONF_BLUE_TEMPLATE,
+    CONF_BRIGHTNESS_TEMPLATE,
     CONF_COLOR_TEMP_KELVIN,
+    CONF_COLOR_TEMP_TEMPLATE,
+    CONF_COMMAND_OFF_TEMPLATE,
+    CONF_COMMAND_ON_TEMPLATE,
     CONF_COMMAND_TOPIC,
+    CONF_EFFECT_LIST,
+    CONF_EFFECT_TEMPLATE,
+    CONF_GREEN_TEMPLATE,
     CONF_MAX_KELVIN,
+    CONF_MAX_MIREDS,
     CONF_MIN_KELVIN,
+    CONF_MIN_MIREDS,
+    CONF_RED_TEMPLATE,
     CONF_STATE_TOPIC,
     PAYLOAD_NONE,
 )
@@ -64,18 +75,6 @@
 
 DEFAULT_NAME = "MQTT Template Light"
 
-CONF_BLUE_TEMPLATE = "blue_template"
-CONF_BRIGHTNESS_TEMPLATE = "brightness_template"
-CONF_COLOR_TEMP_TEMPLATE = "color_temp_template"
-CONF_COMMAND_OFF_TEMPLATE = "command_off_template"
-CONF_COMMAND_ON_TEMPLATE = "command_on_template"
-CONF_EFFECT_LIST = "effect_list"
-CONF_EFFECT_TEMPLATE = "effect_template"
-CONF_GREEN_TEMPLATE = "green_template"
-CONF_MAX_MIREDS = "max_mireds"
-CONF_MIN_MIREDS = "min_mireds"
-CONF_RED_TEMPLATE = "red_template"
-
 COMMAND_TEMPLATES = (CONF_COMMAND_ON_TEMPLATE, CONF_COMMAND_OFF_TEMPLATE)
 VALUE_TEMPLATES = (
     CONF_BLUE_TEMPLATE,