Mqtt light refactor

homeassistant/components/light/mqtt/__init__.py

@@ -0,0 +1,72 @@
+"""
+Support for MQTT lights.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/light.mqtt/
+"""
+import logging
+
+import voluptuous as vol
+
+from homeassistant.components import light
+from homeassistant.components.mqtt import ATTR_DISCOVERY_HASH
+from homeassistant.components.mqtt.discovery import MQTT_DISCOVERY_NEW
+from homeassistant.helpers.dispatcher import async_dispatcher_connect
+from homeassistant.helpers.typing import HomeAssistantType, ConfigType
+
+from . import schema_basic
+from . import schema_json
+from . import schema_template
+
+_LOGGER = logging.getLogger(__name__)
+
+DEPENDENCIES = ['mqtt']
+
+CONF_SCHEMA = 'schema'
+
+
+def validate_mqtt_light(value):
+ """Validate MQTT light schema."""
+ schemas = {
+ 'basic': schema_basic.PLATFORM_SCHEMA_BASIC,
+ 'json': schema_json.PLATFORM_SCHEMA_JSON,
+ 'template': schema_template.PLATFORM_SCHEMA_TEMPLATE,
+ }
+ return schemas[value[CONF_SCHEMA]](value)
+
+
+PLATFORM_SCHEMA = vol.All(vol.Schema({
+ vol.Optional(CONF_SCHEMA, default='basic'): vol.All(
+ vol.Lower, vol.Any('basic', 'json', 'template'))
+}, extra=vol.ALLOW_EXTRA), validate_mqtt_light)
+
+
+async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
+ async_add_entities, discovery_info=None):
+ """Set up MQTT light through configuration.yaml."""
+ await _async_setup_entity(hass, config, async_add_entities)
+
+
+async def async_setup_entry(hass, config_entry, async_add_entities):
+ """Set up MQTT light dynamically through MQTT discovery."""
+ async def async_discover(discovery_payload):
+ """Discover and add a MQTT light."""
+ config = PLATFORM_SCHEMA(discovery_payload)
+ await _async_setup_entity(hass, config, async_add_entities,
+ discovery_payload[ATTR_DISCOVERY_HASH])
+
+ async_dispatcher_connect(
+ hass, MQTT_DISCOVERY_NEW.format(light.DOMAIN, 'mqtt'),
+ async_discover)
+
+
+async def _async_setup_entity(hass, config, async_add_entities,
+ discovery_hash=None):
+ """Set up a MQTT Light."""
+ setup_entity = {
+ 'basic': schema_basic.async_setup_entity_basic,
+ 'json': schema_json.async_setup_entity_json,
+ 'template': schema_template.async_setup_entity_template,
+ }
+ await setup_entity[config['schema']](
+ hass, config, async_add_entities, discovery_hash)

homeassistant/components/light/mqtt.py → homeassistant/components/light/mqtt/schema_basic.py

@@ -9,7 +9,7 @@
 import voluptuous as vol
 
 from homeassistant.core import callback
-from homeassistant.components import mqtt, light
+from homeassistant.components import mqtt
 from homeassistant.components.light import (
  ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_EFFECT, ATTR_HS_COLOR,
  ATTR_WHITE_VALUE, Light, SUPPORT_BRIGHTNESS, SUPPORT_COLOR_TEMP,
@@ -19,13 +19,10 @@
  CONF_OPTIMISTIC, CONF_PAYLOAD_OFF, CONF_PAYLOAD_ON, STATE_ON,
  CONF_RGB, CONF_STATE, CONF_VALUE_TEMPLATE, CONF_WHITE_VALUE, CONF_XY)
 from homeassistant.components.mqtt import (
- ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_COMMAND_TOPIC,
- CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, CONF_RETAIN,
- CONF_STATE_TOPIC, MqttAvailability, MqttDiscoveryUpdate)
-from homeassistant.components.mqtt.discovery import MQTT_DISCOVERY_NEW
+ CONF_AVAILABILITY_TOPIC, CONF_COMMAND_TOPIC, CONF_PAYLOAD_AVAILABLE,
+ CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, CONF_RETAIN, CONF_STATE_TOPIC,
+ MqttAvailability, MqttDiscoveryUpdate)
 from homeassistant.helpers.restore_state import async_get_last_state
-from homeassistant.helpers.dispatcher import async_dispatcher_connect
-from homeassistant.helpers.typing import HomeAssistantType, ConfigType
 import homeassistant.helpers.config_validation as cv
 import homeassistant.util.color as color_util
 
@@ -72,7 +69,7 @@
 
 VALUES_ON_COMMAND_TYPE = ['first', 'last', 'brightness']
 
-PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
+PLATFORM_SCHEMA_BASIC = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
  vol.Optional(CONF_BRIGHTNESS_COMMAND_TOPIC): mqtt.valid_publish_topic,
  vol.Optional(CONF_BRIGHTNESS_SCALE, default=DEFAULT_BRIGHTNESS_SCALE):
  vol.All(vol.Coerce(int), vol.Range(min=1)),
@@ -111,27 +108,8 @@
 }).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
 
 
-async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
- async_add_entities, discovery_info=None):
- """Set up MQTT light through configuration.yaml."""
- await _async_setup_entity(hass, config, async_add_entities)
-
-
-async def async_setup_entry(hass, config_entry, async_add_entities):
- """Set up MQTT light dynamically through MQTT discovery."""
- async def async_discover(discovery_payload):
- """Discover and add a MQTT light."""
- config = PLATFORM_SCHEMA(discovery_payload)
- await _async_setup_entity(hass, config, async_add_entities,
- discovery_payload[ATTR_DISCOVERY_HASH])
-
- async_dispatcher_connect(
- hass, MQTT_DISCOVERY_NEW.format(light.DOMAIN, 'mqtt'),
- async_discover)
-
-
-async def _async_setup_entity(hass, config, async_add_entities,
- discovery_hash=None):
+async def async_setup_entity_basic(hass, config, async_add_entities,
+ discovery_hash=None):
  """Set up a MQTT Light."""
  config.setdefault(
  CONF_STATE_VALUE_TEMPLATE, config.get(CONF_VALUE_TEMPLATE))
@@ -688,7 +666,7 @@ async def async_turn_on(self, **kwargs):
  should_update = True
 
  if self._optimistic:
- # Optimistically assume that switch has changed state.
+ # Optimistically assume that the light has changed state.
  self._state = True
  should_update = True
 
@@ -705,6 +683,6 @@ async def async_turn_off(self, **kwargs):
  self._qos, self._retain)
 
  if self._optimistic:
- # Optimistically assume that switch has changed state.
+ # Optimistically assume that the light has changed state.
  self._state = False
  self.async_schedule_update_ha_state()

homeassistant/components/light/mqtt_json.py → homeassistant/components/light/mqtt/schema_json.py

@@ -14,14 +14,12 @@
 from homeassistant.components.light import (
  ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_EFFECT, ATTR_FLASH, ATTR_HS_COLOR,
  ATTR_TRANSITION, ATTR_WHITE_VALUE, FLASH_LONG, FLASH_SHORT,
- PLATFORM_SCHEMA, SUPPORT_BRIGHTNESS, SUPPORT_COLOR, SUPPORT_COLOR_TEMP,
- SUPPORT_EFFECT, SUPPORT_FLASH, SUPPORT_TRANSITION, SUPPORT_WHITE_VALUE,
- Light)
-from homeassistant.components.light.mqtt import CONF_BRIGHTNESS_SCALE
+ SUPPORT_BRIGHTNESS, SUPPORT_COLOR, SUPPORT_COLOR_TEMP, SUPPORT_EFFECT,
+ SUPPORT_FLASH, SUPPORT_TRANSITION, SUPPORT_WHITE_VALUE, Light)
 from homeassistant.components.mqtt import (
- ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_COMMAND_TOPIC,
- CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, CONF_RETAIN,
- CONF_STATE_TOPIC, MqttAvailability, MqttDiscoveryUpdate)
+ CONF_AVAILABILITY_TOPIC, CONF_COMMAND_TOPIC, CONF_PAYLOAD_AVAILABLE,
+ CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, CONF_RETAIN, CONF_STATE_TOPIC,
+ MqttAvailability, MqttDiscoveryUpdate)
 from homeassistant.const import (
  CONF_BRIGHTNESS, CONF_COLOR_TEMP, CONF_EFFECT, CONF_NAME, CONF_OPTIMISTIC,
  CONF_RGB, CONF_WHITE_VALUE, CONF_XY, STATE_ON)
@@ -31,6 +29,8 @@
 from homeassistant.helpers.typing import ConfigType, HomeAssistantType
 import homeassistant.util.color as color_util
 
+from .schema_basic import CONF_BRIGHTNESS_SCALE
+
 _LOGGER = logging.getLogger(__name__)
 
 DOMAIN = 'mqtt_json'
@@ -58,7 +58,7 @@
 CONF_UNIQUE_ID = 'unique_id'
 
 # Stealing some of these from the base MQTT configs.
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+PLATFORM_SCHEMA_JSON = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
  vol.Optional(CONF_BRIGHTNESS, default=DEFAULT_BRIGHTNESS): cv.boolean,
  vol.Optional(CONF_BRIGHTNESS_SCALE, default=DEFAULT_BRIGHTNESS_SCALE):
  vol.All(vol.Coerce(int), vol.Range(min=1)),
@@ -84,17 +84,10 @@
 }).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
 
 
-async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
- async_add_entities, discovery_info=None):
+async def async_setup_entity_json(hass: HomeAssistantType, config: ConfigType,
+  async_add_entities, discovery_hash):
  """Set up a MQTT JSON Light."""
- if discovery_info is not None:
- config = PLATFORM_SCHEMA(discovery_info)
-
- discovery_hash = None
- if discovery_info is not None and ATTR_DISCOVERY_HASH in discovery_info:
- discovery_hash = discovery_info[ATTR_DISCOVERY_HASH]
-
- async_add_entities([MqttJson(
+ async_add_entities([MqttLightJson(
  config.get(CONF_NAME),
  config.get(CONF_UNIQUE_ID),
  config.get(CONF_EFFECT_LIST),
@@ -128,7 +121,7 @@ async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
  )])
 
 
-class MqttJson(MqttAvailability, MqttDiscoveryUpdate, Light):
+class MqttLightJson(MqttAvailability, MqttDiscoveryUpdate, Light):
  """Representation of a MQTT JSON light."""
 
  def __init__(self, name, unique_id, effect_list, topic, qos, retain,

homeassistant/components/light/mqtt_template.py → homeassistant/components/light/mqtt/schema_template.py

@@ -11,7 +11,7 @@
 from homeassistant.components import mqtt
 from homeassistant.components.light import (
  ATTR_BRIGHTNESS, ATTR_COLOR_TEMP, ATTR_EFFECT, ATTR_FLASH,
- ATTR_HS_COLOR, ATTR_TRANSITION, ATTR_WHITE_VALUE, Light, PLATFORM_SCHEMA,
+ ATTR_HS_COLOR, ATTR_TRANSITION, ATTR_WHITE_VALUE, Light,
  SUPPORT_BRIGHTNESS, SUPPORT_COLOR_TEMP, SUPPORT_EFFECT, SUPPORT_FLASH,
  SUPPORT_COLOR, SUPPORT_TRANSITION, SUPPORT_WHITE_VALUE)
 from homeassistant.const import CONF_NAME, CONF_OPTIMISTIC, STATE_ON, STATE_OFF
@@ -44,7 +44,7 @@
 CONF_STATE_TEMPLATE = 'state_template'
 CONF_WHITE_VALUE_TEMPLATE = 'white_value_template'
 
-PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+PLATFORM_SCHEMA_TEMPLATE = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
  vol.Optional(CONF_BLUE_TEMPLATE): cv.template,
  vol.Optional(CONF_BRIGHTNESS_TEMPLATE): cv.template,
  vol.Optional(CONF_COLOR_TEMP_TEMPLATE): cv.template,
@@ -66,12 +66,9 @@
 }).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
 
 
-async def async_setup_platform(hass, config, async_add_entities,
- discovery_info=None):
+async def async_setup_entity_template(hass, config, async_add_entities,
+  discovery_hash):
  """Set up a MQTT Template light."""
- if discovery_info is not None:
- config = PLATFORM_SCHEMA(discovery_info)
-
  async_add_entities([MqttTemplate(
  hass,
  config.get(CONF_NAME),

homeassistant/components/mqtt/discovery.py

@@ -27,32 +27,26 @@
  'light', 'sensor', 'switch', 'lock', 'climate',
  'alarm_control_panel']
 
-ALLOWED_PLATFORMS = {
- 'binary_sensor': ['mqtt'],
- 'camera': ['mqtt'],
- 'cover': ['mqtt'],
- 'fan': ['mqtt'],
- 'light': ['mqtt', 'mqtt_json', 'mqtt_template'],
- 'lock': ['mqtt'],
- 'sensor': ['mqtt'],
- 'switch': ['mqtt'],
- 'climate': ['mqtt'],
- 'alarm_control_panel': ['mqtt'],
-}
+CONFIG_ENTRY_COMPONENTS = [
+ 'binary_sensor',
+ 'camera',
+ 'cover',
+ 'light',
+ 'lock',
+ 'sensor',
+ 'switch',
+ 'climate',
+ 'alarm_control_panel',
+ 'fan',
+]
 
-CONFIG_ENTRY_PLATFORMS = {
- 'binary_sensor': ['mqtt'],
- 'camera': ['mqtt'],
- 'cover': ['mqtt'],
- 'light': ['mqtt'],
- 'lock': ['mqtt'],
- 'sensor': ['mqtt'],
- 'switch': ['mqtt'],
- 'climate': ['mqtt'],
- 'alarm_control_panel': ['mqtt'],
- 'fan': ['mqtt'],
+DEPRECATED_PLATFORM_TO_SCHEMA = {
+ 'mqtt': 'basic',
+ 'mqtt_json': 'json',
+ 'mqtt_template': 'template',
 }
 
+
 ALREADY_DISCOVERED = 'mqtt_discovered_components'
 DATA_CONFIG_ENTRY_LOCK = 'mqtt_config_entry_lock'
 CONFIG_ENTRY_IS_SETUP = 'mqtt_config_entry_is_setup'
@@ -216,12 +210,15 @@ async def async_device_message_received(topic, payload, qos):
  discovery_hash = (component, discovery_id)
 
  if payload:
- platform = payload.get(CONF_PLATFORM, 'mqtt')
- if platform not in ALLOWED_PLATFORMS.get(component, []):
- _LOGGER.warning("Platform %s (component %s) is not allowed",
- platform, component)
- return
- payload[CONF_PLATFORM] = platform
+ if CONF_PLATFORM in payload:
+ platform = payload[CONF_PLATFORM]
+ if platform in DEPRECATED_PLATFORM_TO_SCHEMA:
+ schema = DEPRECATED_PLATFORM_TO_SCHEMA[platform]
+ payload['schema'] = schema
+ _LOGGER.warning('"platform": "%s" is deprecated, '
+ 'replace with "schema":"%s"',
+ platform, schema)
+ payload[CONF_PLATFORM] = 'mqtt'
 
  if CONF_STATE_TOPIC not in payload:
  payload[CONF_STATE_TOPIC] = '{}/{}/{}{}/state'.format(
@@ -244,20 +241,20 @@ async def async_device_message_received(topic, payload, qos):
  _LOGGER.info("Found new component: %s %s", component, discovery_id)
  hass.data[ALREADY_DISCOVERED][discovery_hash] = None
 
- if platform not in CONFIG_ENTRY_PLATFORMS.get(component, []):
+ if component not in CONFIG_ENTRY_COMPONENTS:
  await async_load_platform(
- hass, component, platform, payload, hass_config)
+ hass, component, 'mqtt', payload, hass_config)
  return
 
- config_entries_key = '{}.{}'.format(component, platform)
+ config_entries_key = '{}.{}'.format(component, 'mqtt')
  async with hass.data[DATA_CONFIG_ENTRY_LOCK]:
  if config_entries_key not in hass.data[CONFIG_ENTRY_IS_SETUP]:
  await hass.config_entries.async_forward_entry_setup(
  config_entry, component)
  hass.data[CONFIG_ENTRY_IS_SETUP].add(config_entries_key)
 
  async_dispatcher_send(hass, MQTT_DISCOVERY_NEW.format(
- component, platform), payload)
+ component, 'mqtt'), payload)
 
  hass.data[DATA_CONFIG_ENTRY_LOCK] = asyncio.Lock()
  hass.data[CONFIG_ENTRY_IS_SETUP] = set()

tests/components/light/test_mqtt.py

@@ -585,7 +585,8 @@ async def test_sending_mqtt_commands_and_optimistic(hass, mqtt_mock):
  'effect': 'random',
  'color_temp': 100,
  'white_value': 50})
- with patch('homeassistant.components.light.mqtt.async_get_last_state',
+ with patch('homeassistant.components.light.mqtt.schema_basic'
+ '.async_get_last_state',
  return_value=mock_coro(fake_state)):
  with assert_setup_component(1, light.DOMAIN):
  assert await async_setup_component(hass, light.DOMAIN, config)
@@ -1063,3 +1064,20 @@ async def test_discovery_removal_light(hass, mqtt_mock, caplog):
 
  state = hass.states.get('light.beer')
  assert state is None
+
+
+async def test_discovery_deprecated(hass, mqtt_mock, caplog):
+ """Test removal of discovered mqtt_json lights."""
+ entry = MockConfigEntry(domain=mqtt.DOMAIN)
+ await async_start(hass, 'homeassistant', {'mqtt': {}}, entry)
+ data = (
+ '{ "name": "Beer",'
+ ' "platform": "mqtt",'
+ ' "command_topic": "test_topic"}'
+ )
+ async_fire_mqtt_message(hass, 'homeassistant/light/bla/config',
+ data)
+ await hass.async_block_till_done()
+ state = hass.states.get('light.beer')
+ assert state is not None
+ assert state.name == 'Beer'