mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 13:17:32 +00:00
Add device registry to MQTT lock (#19333)
This commit is contained in:
parent
196fe4b927
commit
fed5d0f5be
@ -11,11 +11,12 @@ import voluptuous as vol
|
|||||||
from homeassistant.core import callback
|
from homeassistant.core import callback
|
||||||
from homeassistant.components.lock import LockDevice
|
from homeassistant.components.lock import LockDevice
|
||||||
from homeassistant.components.mqtt import (
|
from homeassistant.components.mqtt import (
|
||||||
ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_STATE_TOPIC,
|
ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_COMMAND_TOPIC,
|
||||||
CONF_COMMAND_TOPIC, CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE,
|
CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, CONF_RETAIN,
|
||||||
CONF_QOS, CONF_RETAIN, MqttAvailability, MqttDiscoveryUpdate)
|
CONF_STATE_TOPIC, MqttAvailability, MqttDiscoveryUpdate,
|
||||||
|
MqttEntityDeviceInfo)
|
||||||
from homeassistant.const import (
|
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 import mqtt, lock
|
||||||
from homeassistant.components.mqtt.discovery import MQTT_DISCOVERY_NEW
|
from homeassistant.components.mqtt.discovery import MQTT_DISCOVERY_NEW
|
||||||
import homeassistant.helpers.config_validation as cv
|
import homeassistant.helpers.config_validation as cv
|
||||||
@ -26,6 +27,7 @@ _LOGGER = logging.getLogger(__name__)
|
|||||||
|
|
||||||
CONF_PAYLOAD_LOCK = 'payload_lock'
|
CONF_PAYLOAD_LOCK = 'payload_lock'
|
||||||
CONF_PAYLOAD_UNLOCK = 'payload_unlock'
|
CONF_PAYLOAD_UNLOCK = 'payload_unlock'
|
||||||
|
CONF_UNIQUE_ID = 'unique_id'
|
||||||
|
|
||||||
DEFAULT_NAME = 'MQTT Lock'
|
DEFAULT_NAME = 'MQTT Lock'
|
||||||
DEFAULT_OPTIMISTIC = False
|
DEFAULT_OPTIMISTIC = False
|
||||||
@ -40,6 +42,8 @@ PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
|
|||||||
vol.Optional(CONF_PAYLOAD_UNLOCK, default=DEFAULT_PAYLOAD_UNLOCK):
|
vol.Optional(CONF_PAYLOAD_UNLOCK, default=DEFAULT_PAYLOAD_UNLOCK):
|
||||||
cv.string,
|
cv.string,
|
||||||
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
|
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)
|
}).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_AVAILABILITY_TOPIC),
|
||||||
config.get(CONF_PAYLOAD_AVAILABLE),
|
config.get(CONF_PAYLOAD_AVAILABLE),
|
||||||
config.get(CONF_PAYLOAD_NOT_AVAILABLE),
|
config.get(CONF_PAYLOAD_NOT_AVAILABLE),
|
||||||
|
config.get(CONF_UNIQUE_ID),
|
||||||
|
config.get(CONF_DEVICE),
|
||||||
discovery_hash,
|
discovery_hash,
|
||||||
)])
|
)])
|
||||||
|
|
||||||
|
|
||||||
class MqttLock(MqttAvailability, MqttDiscoveryUpdate, LockDevice):
|
class MqttLock(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
|
||||||
|
LockDevice):
|
||||||
"""Representation of a lock that can be toggled using MQTT."""
|
"""Representation of a lock that can be toggled using MQTT."""
|
||||||
|
|
||||||
def __init__(self, name, state_topic, command_topic, qos, retain,
|
def __init__(self, name, state_topic, command_topic, qos, retain,
|
||||||
payload_lock, payload_unlock, optimistic, value_template,
|
payload_lock, payload_unlock, optimistic, value_template,
|
||||||
availability_topic, payload_available, payload_not_available,
|
availability_topic, payload_available, payload_not_available,
|
||||||
discovery_hash):
|
unique_id, device_config, discovery_hash):
|
||||||
"""Initialize the lock."""
|
"""Initialize the lock."""
|
||||||
MqttAvailability.__init__(self, availability_topic, qos,
|
MqttAvailability.__init__(self, availability_topic, qos,
|
||||||
payload_available, payload_not_available)
|
payload_available, payload_not_available)
|
||||||
MqttDiscoveryUpdate.__init__(self, discovery_hash)
|
MqttDiscoveryUpdate.__init__(self, discovery_hash)
|
||||||
|
MqttEntityDeviceInfo.__init__(self, device_config)
|
||||||
self._state = False
|
self._state = False
|
||||||
self._name = name
|
self._name = name
|
||||||
self._state_topic = state_topic
|
self._state_topic = state_topic
|
||||||
@ -108,6 +116,7 @@ class MqttLock(MqttAvailability, MqttDiscoveryUpdate, LockDevice):
|
|||||||
self._optimistic = optimistic
|
self._optimistic = optimistic
|
||||||
self._template = value_template
|
self._template = value_template
|
||||||
self._discovery_hash = discovery_hash
|
self._discovery_hash = discovery_hash
|
||||||
|
self._unique_id = unique_id
|
||||||
|
|
||||||
async def async_added_to_hass(self):
|
async def async_added_to_hass(self):
|
||||||
"""Subscribe to MQTT events."""
|
"""Subscribe to MQTT events."""
|
||||||
@ -143,6 +152,11 @@ class MqttLock(MqttAvailability, MqttDiscoveryUpdate, LockDevice):
|
|||||||
"""Return the name of the lock."""
|
"""Return the name of the lock."""
|
||||||
return self._name
|
return self._name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def unique_id(self):
|
||||||
|
"""Return a unique ID."""
|
||||||
|
return self._unique_id
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def is_locked(self):
|
def is_locked(self):
|
||||||
"""Return true if lock is locked."""
|
"""Return true if lock is locked."""
|
||||||
|
@ -1,11 +1,14 @@
|
|||||||
"""The tests for the MQTT lock platform."""
|
"""The tests for the MQTT lock platform."""
|
||||||
|
import json
|
||||||
|
|
||||||
from homeassistant.setup import async_setup_component
|
from homeassistant.setup import async_setup_component
|
||||||
from homeassistant.const import (
|
from homeassistant.const import (
|
||||||
STATE_LOCKED, STATE_UNLOCKED, STATE_UNAVAILABLE, ATTR_ASSUMED_STATE)
|
STATE_LOCKED, STATE_UNLOCKED, STATE_UNAVAILABLE, ATTR_ASSUMED_STATE)
|
||||||
from homeassistant.components import lock, mqtt
|
from homeassistant.components import lock, mqtt
|
||||||
from homeassistant.components.mqtt.discovery import async_start
|
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):
|
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
|
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):
|
async def test_discovery_removal_lock(hass, mqtt_mock, caplog):
|
||||||
"""Test removal of discovered lock."""
|
"""Test removal of discovered lock."""
|
||||||
entry = MockConfigEntry(domain=mqtt.DOMAIN)
|
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()
|
await hass.async_block_till_done()
|
||||||
state = hass.states.get('lock.beer')
|
state = hass.states.get('lock.beer')
|
||||||
assert state is None
|
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'
|
||||||
|
Loading…
x
Reference in New Issue
Block a user