diff --git a/homeassistant/components/lock/mqtt.py b/homeassistant/components/lock/mqtt.py index 28849c88159..ad5ba34dbb0 100644 --- a/homeassistant/components/lock/mqtt.py +++ b/homeassistant/components/lock/mqtt.py @@ -11,11 +11,12 @@ import voluptuous as vol from homeassistant.core import callback from homeassistant.components.lock import LockDevice from homeassistant.components.mqtt import ( - ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_STATE_TOPIC, - CONF_COMMAND_TOPIC, CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE, - CONF_QOS, CONF_RETAIN, MqttAvailability, MqttDiscoveryUpdate) + 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, + MqttEntityDeviceInfo) from homeassistant.const import ( - CONF_NAME, CONF_OPTIMISTIC, CONF_VALUE_TEMPLATE) + CONF_DEVICE, CONF_NAME, CONF_OPTIMISTIC, CONF_VALUE_TEMPLATE) from homeassistant.components import mqtt, lock from homeassistant.components.mqtt.discovery import MQTT_DISCOVERY_NEW import homeassistant.helpers.config_validation as cv @@ -26,6 +27,7 @@ _LOGGER = logging.getLogger(__name__) CONF_PAYLOAD_LOCK = 'payload_lock' CONF_PAYLOAD_UNLOCK = 'payload_unlock' +CONF_UNIQUE_ID = 'unique_id' DEFAULT_NAME = 'MQTT Lock' DEFAULT_OPTIMISTIC = False @@ -40,6 +42,8 @@ PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({ vol.Optional(CONF_PAYLOAD_UNLOCK, default=DEFAULT_PAYLOAD_UNLOCK): cv.string, vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean, + vol.Optional(CONF_UNIQUE_ID): cv.string, + vol.Optional(CONF_DEVICE): mqtt.MQTT_ENTITY_DEVICE_INFO_SCHEMA, }).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema) @@ -82,21 +86,25 @@ async def _async_setup_entity(hass, config, async_add_entities, config.get(CONF_AVAILABILITY_TOPIC), config.get(CONF_PAYLOAD_AVAILABLE), config.get(CONF_PAYLOAD_NOT_AVAILABLE), + config.get(CONF_UNIQUE_ID), + config.get(CONF_DEVICE), discovery_hash, )]) -class MqttLock(MqttAvailability, MqttDiscoveryUpdate, LockDevice): +class MqttLock(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo, + LockDevice): """Representation of a lock that can be toggled using MQTT.""" def __init__(self, name, state_topic, command_topic, qos, retain, payload_lock, payload_unlock, optimistic, value_template, availability_topic, payload_available, payload_not_available, - discovery_hash): + unique_id, device_config, discovery_hash): """Initialize the lock.""" MqttAvailability.__init__(self, availability_topic, qos, payload_available, payload_not_available) MqttDiscoveryUpdate.__init__(self, discovery_hash) + MqttEntityDeviceInfo.__init__(self, device_config) self._state = False self._name = name self._state_topic = state_topic @@ -108,6 +116,7 @@ class MqttLock(MqttAvailability, MqttDiscoveryUpdate, LockDevice): self._optimistic = optimistic self._template = value_template self._discovery_hash = discovery_hash + self._unique_id = unique_id async def async_added_to_hass(self): """Subscribe to MQTT events.""" @@ -143,6 +152,11 @@ class MqttLock(MqttAvailability, MqttDiscoveryUpdate, LockDevice): """Return the name of the lock.""" return self._name + @property + def unique_id(self): + """Return a unique ID.""" + return self._unique_id + @property def is_locked(self): """Return true if lock is locked.""" diff --git a/tests/components/lock/test_mqtt.py b/tests/components/lock/test_mqtt.py index 58f328c5b9d..0fcb97f1b68 100644 --- a/tests/components/lock/test_mqtt.py +++ b/tests/components/lock/test_mqtt.py @@ -1,11 +1,14 @@ """The tests for the MQTT lock platform.""" +import json + from homeassistant.setup import async_setup_component from homeassistant.const import ( STATE_LOCKED, STATE_UNLOCKED, STATE_UNAVAILABLE, ATTR_ASSUMED_STATE) from homeassistant.components import lock, mqtt from homeassistant.components.mqtt.discovery import async_start -from tests.common import async_fire_mqtt_message, MockConfigEntry +from tests.common import ( + async_fire_mqtt_message, async_mock_mqtt_component, MockConfigEntry) async def test_controlling_state_via_topic(hass, mqtt_mock): @@ -134,6 +137,29 @@ async def test_custom_availability_payload(hass, mqtt_mock): assert state.state is STATE_UNAVAILABLE +async def test_unique_id(hass): + """Test unique id option only creates one light per unique_id.""" + await async_mock_mqtt_component(hass) + assert await async_setup_component(hass, lock.DOMAIN, { + lock.DOMAIN: [{ + 'platform': 'mqtt', + 'name': 'Test 1', + 'status_topic': 'test-topic', + 'command_topic': 'test_topic', + 'unique_id': 'TOTALLY_UNIQUE' + }, { + 'platform': 'mqtt', + 'name': 'Test 2', + 'status_topic': 'test-topic', + 'command_topic': 'test_topic', + 'unique_id': 'TOTALLY_UNIQUE' + }] + }) + async_fire_mqtt_message(hass, 'test-topic', 'payload') + await hass.async_block_till_done() + assert len(hass.states.async_entity_ids(lock.DOMAIN)) == 1 + + async def test_discovery_removal_lock(hass, mqtt_mock, caplog): """Test removal of discovered lock.""" entry = MockConfigEntry(domain=mqtt.DOMAIN) @@ -154,3 +180,42 @@ async def test_discovery_removal_lock(hass, mqtt_mock, caplog): await hass.async_block_till_done() state = hass.states.get('lock.beer') assert state is None + + +async def test_entity_device_info_with_identifier(hass, mqtt_mock): + """Test MQTT lock device registry integration.""" + entry = MockConfigEntry(domain=mqtt.DOMAIN) + entry.add_to_hass(hass) + await async_start(hass, 'homeassistant', {}, entry) + registry = await hass.helpers.device_registry.async_get_registry() + + data = json.dumps({ + 'platform': 'mqtt', + 'name': 'Test 1', + 'state_topic': 'test-topic', + 'command_topic': 'test-topic', + 'device': { + 'identifiers': ['helloworld'], + 'connections': [ + ["mac", "02:5b:26:a8:dc:12"], + ], + 'manufacturer': 'Whatever', + 'name': 'Beer', + 'model': 'Glass', + 'sw_version': '0.1-beta', + }, + 'unique_id': 'veryunique' + }) + async_fire_mqtt_message(hass, 'homeassistant/lock/bla/config', + data) + await hass.async_block_till_done() + await hass.async_block_till_done() + + device = registry.async_get_device({('mqtt', 'helloworld')}, set()) + assert device is not None + assert device.identifiers == {('mqtt', 'helloworld')} + assert device.connections == {('mac', "02:5b:26:a8:dc:12")} + assert device.manufacturer == 'Whatever' + assert device.name == 'Beer' + assert device.model == 'Glass' + assert device.sw_version == '0.1-beta'