Skip to content

Add separate command and state topics for mqtt lock #29808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
springstan merged 7 commits into from
Dec 31, 2019
Merged

Add separate command and state topics for mqtt lock #29808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8e4a9af
Update lock.py
tuxbox Dec 9, 2019
6fbcbf0
Formatting updated after black run
tuxbox Dec 10, 2019
55b09a8
TC updated to reflect different state & cmd values
tuxbox Dec 10, 2019
e0a322a
Abbreviations for lock states added
tuxbox Dec 10, 2019
5285775
additional non-default state test
tuxbox Dec 10, 2019
aa9858d
whitespaces fixed
tuxbox Dec 10, 2019
30c6f52
black formatting run
tuxbox Dec 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions homeassistant/components/mqtt/abbreviations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@
"stat_off": "state_off",
"stat_on": "state_on",
"stat_open": "state_open",
"stat_locked": "state_locked",
"stat_unlocked": "state_unlocked",
"stat_t": "state_topic",
"stat_tpl": "state_template",
"stat_val_tpl": "state_value_template",
Expand Down
14 changes: 12 additions & 2 deletions homeassistant/components/mqtt/lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,16 @@
CONF_PAYLOAD_LOCK = "payload_lock"
CONF_PAYLOAD_UNLOCK = "payload_unlock"

CONF_STATE_LOCKED = "state_locked"
CONF_STATE_UNLOCKED = "state_unlocked"

DEFAULT_NAME = "MQTT Lock"
DEFAULT_OPTIMISTIC = False
DEFAULT_PAYLOAD_LOCK = "LOCK"
DEFAULT_PAYLOAD_UNLOCK = "UNLOCK"
DEFAULT_STATE_LOCKED = "LOCKED"
DEFAULT_STATE_UNLOCKED = "UNLOCKED"

PLATFORM_SCHEMA = (
mqtt.MQTT_RW_PLATFORM_SCHEMA.extend(
{
Expand All @@ -50,6 +56,10 @@
vol.Optional(
CONF_PAYLOAD_UNLOCK, default=DEFAULT_PAYLOAD_UNLOCK
): cv.string,
vol.Optional(CONF_STATE_LOCKED, default=DEFAULT_STATE_LOCKED): cv.string,
vol.Optional(
CONF_STATE_UNLOCKED, default=DEFAULT_STATE_UNLOCKED
): cv.string,
vol.Optional(CONF_UNIQUE_ID): cv.string,
}
)
Expand Down Expand Up @@ -152,9 +162,9 @@ def message_received(msg):
payload = msg.payload
if value_template is not None:
payload = value_template.async_render_with_possible_json_value(payload)
if payload == self._config[CONF_PAYLOAD_LOCK]:
if payload == self._config[CONF_STATE_LOCKED]:
self._state = True
elif payload == self._config[CONF_PAYLOAD_UNLOCK]:
elif payload == self._config[CONF_STATE_UNLOCKED]:
self._state = False

self.async_write_ha_state()
Expand Down
88 changes: 84 additions & 4 deletions tests/components/mqtt/test_lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ async def test_controlling_state_via_topic(hass, mqtt_mock):
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "LOCKED",
Comment thread
MartinHjelmare marked this conversation as resolved.
"state_unlocked": "UNLOCKED",
}
},
)
Expand All @@ -42,12 +44,46 @@ async def test_controlling_state_via_topic(hass, mqtt_mock):
assert state.state is STATE_UNLOCKED
assert not state.attributes.get(ATTR_ASSUMED_STATE)

async_fire_mqtt_message(hass, "state-topic", "LOCK")
async_fire_mqtt_message(hass, "state-topic", "LOCKED")

state = hass.states.get("lock.test")
assert state.state is STATE_LOCKED

async_fire_mqtt_message(hass, "state-topic", "UNLOCK")
async_fire_mqtt_message(hass, "state-topic", "UNLOCKED")

state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED


async def test_controlling_non_default_state_via_topic(hass, mqtt_mock):
"""Test the controlling state via topic."""
assert await async_setup_component(
hass,
lock.DOMAIN,
{
lock.DOMAIN: {
"platform": "mqtt",
"name": "test",
"state_topic": "state-topic",
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "closed",
"state_unlocked": "open",
}
},
)

state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED
assert not state.attributes.get(ATTR_ASSUMED_STATE)

async_fire_mqtt_message(hass, "state-topic", "closed")

state = hass.states.get("lock.test")
assert state.state is STATE_LOCKED

async_fire_mqtt_message(hass, "state-topic", "open")

state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED
Expand All @@ -66,6 +102,44 @@ async def test_controlling_state_via_topic_and_json_message(hass, mqtt_mock):
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "LOCKED",
"state_unlocked": "UNLOCKED",
"value_template": "{{ value_json.val }}",
}
},
)

state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED

async_fire_mqtt_message(hass, "state-topic", '{"val":"LOCKED"}')

state = hass.states.get("lock.test")
assert state.state is STATE_LOCKED

async_fire_mqtt_message(hass, "state-topic", '{"val":"UNLOCKED"}')

state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED


async def test_controlling_non_default_state_via_topic_and_json_message(
hass, mqtt_mock
):
"""Test the controlling state via topic and JSON message."""
assert await async_setup_component(
hass,
lock.DOMAIN,
{
lock.DOMAIN: {
"platform": "mqtt",
"name": "test",
"state_topic": "state-topic",
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "closed",
"state_unlocked": "open",
"value_template": "{{ value_json.val }}",
}
},
Expand All @@ -74,12 +148,12 @@ async def test_controlling_state_via_topic_and_json_message(hass, mqtt_mock):
state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED

async_fire_mqtt_message(hass, "state-topic", '{"val":"LOCK"}')
async_fire_mqtt_message(hass, "state-topic", '{"val":"closed"}')

state = hass.states.get("lock.test")
assert state.state is STATE_LOCKED

async_fire_mqtt_message(hass, "state-topic", '{"val":"UNLOCK"}')
async_fire_mqtt_message(hass, "state-topic", '{"val":"open"}')

state = hass.states.get("lock.test")
assert state.state is STATE_UNLOCKED
Expand All @@ -97,6 +171,8 @@ async def test_sending_mqtt_commands_and_optimistic(hass, mqtt_mock):
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "LOCKED",
"state_unlocked": "UNLOCKED",
}
},
)
Expand Down Expand Up @@ -135,6 +211,8 @@ async def test_sending_mqtt_commands_and_explicit_optimistic(hass, mqtt_mock):
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "LOCKED",
"state_unlocked": "UNLOCKED",
"optimistic": True,
}
},
Expand Down Expand Up @@ -206,6 +284,8 @@ async def test_custom_availability_payload(hass, mqtt_mock):
"command_topic": "command-topic",
"payload_lock": "LOCK",
"payload_unlock": "UNLOCK",
"state_locked": "LOCKED",
"state_unlocked": "UNLOCKED",
"availability_topic": "availability-topic",
"payload_available": "good",
"payload_not_available": "nogood",
Expand Down