Add separate command and state topics for mqtt lock (#29808)
* Update lock.py Allow different command and state topic + different command and state values. * Formatting updated after black run * TC updated to reflect different state & cmd values * Abbreviations for lock states added * additional non-default state test * whitespaces fixed * black formatting run
This commit is contained in:
1 parent
fd0375ac20
commit
1c2618d99a
3 files changed
+98
-6
No files matched your search
@@ -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",
|
||||
"state_unlocked": "UNLOCKED",
|
||||
}
|
||||
},
|
||||
)
|
||||
@@ -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
|
||||
@@ -66,6 +102,8 @@ 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 }}",
|
||||
}
|
||||
},
|
||||
@@ -74,12 +112,48 @@ 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":"LOCKED"}')
|
||||
|
||||
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":"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 }}",
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
state = hass.states.get("lock.test")
|
||||
assert state.state is STATE_UNLOCKED
|
||||
|
||||
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":"open"}')
|
||||
|
||||
state = hass.states.get("lock.test")
|
||||
assert state.state is STATE_UNLOCKED
|
||||
@@ -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",
|
||||
}
|
||||
},
|
||||
)
|
||||
@@ -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,
|
||||
}
|
||||
},
|
||||
@@ -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",
|
||||
|
||||
Reference in new issue
Block a user