Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add On/Off as target values for zwave_js cover stop action (#52881) 

* Add On/Off as target values for stop cover

Certain ZWave Cover devices use On/Off instead of the more common
Open/Close and Up/Down targets for movement.
Adding On/Off to the targets used to stop the cover during movement.
Fixes issue #51963

* Add test for updated zwave_js stop cover logic
pull/53101/head
p4p3r 2021-07-16 15:48:35 +02:00 committed by GitHub
parent 6672962f2b
commit 9d79c4f617
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 739 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
homeassistant/components/zwave_js/cover.py
View File

@ -130,12 +130,23 @@ class ZWaveCover(ZWaveBaseEntity, CoverEntity):
async def async_stop_cover(self, **kwargs: Any) -> None:
"""Stop cover."""
target_value = self.get_zwave_value("Open") or self.get_zwave_value("Up")
if target_value:
await self.info.node.async_set_value(target_value, False)
target_value = self.get_zwave_value("Close") or self.get_zwave_value("Down")
if target_value:
await self.info.node.async_set_value(target_value, False)
open_value = (
self.get_zwave_value("Open")
or self.get_zwave_value("Up")
or self.get_zwave_value("On")
)
if open_value:
# Stop the cover if it's opening
await self.info.node.async_set_value(open_value, False)
close_value = (
self.get_zwave_value("Close")
or self.get_zwave_value("Down")
or self.get_zwave_value("Off")
)
if close_value:
# Stop the cover if it's closing
await self.info.node.async_set_value(close_value, False)
class ZwaveMotorizedBarrier(ZWaveBaseEntity, CoverEntity):

14
tests/components/zwave_js/conftest.py
View File

@ -350,6 +350,12 @@ def qubino_shutter_state_fixture():
return json.loads(load_fixture("zwave_js/cover_qubino_shutter_state.json"))
@pytest.fixture(name="aeotec_nano_shutter_state", scope="session")
def aeotec_nano_shutter_state_fixture():
"""Load the Aeotec Nano Shutter node state fixture data."""
return json.loads(load_fixture("zwave_js/cover_aeotec_nano_shutter_state.json"))
@pytest.fixture(name="aeon_smart_switch_6_state", scope="session")
def aeon_smart_switch_6_state_fixture():
"""Load the AEON Labs (ZW096) Smart Switch 6 node state fixture data."""
@ -715,6 +721,14 @@ def qubino_shutter_cover_fixture(client, qubino_shutter_state):
return node
@pytest.fixture(name="aeotec_nano_shutter")
def aeotec_nano_shutter_cover_fixture(client, aeotec_nano_shutter_state):
"""Mock a Aeotec Nano Shutter node."""
node = Node(client, copy.deepcopy(aeotec_nano_shutter_state))
client.driver.controller.nodes[node.node_id] = node
return node
@pytest.fixture(name="aeon_smart_switch_6")
def aeon_smart_switch_6_fixture(client, aeon_smart_switch_6_state):
"""Mock an AEON Labs (ZW096) Smart Switch 6 node."""

210
tests/components/zwave_js/test_cover.py
View File

@ -24,6 +24,7 @@ WINDOW_COVER_ENTITY = "cover.zws_12"
GDC_COVER_ENTITY = "cover.aeon_labs_garage_door_controller_gen5"
BLIND_COVER_ENTITY = "cover.window_blind_controller"
SHUTTER_COVER_ENTITY = "cover.flush_shutter_dc"
AEOTEC_SHUTTER_COVER_ENTITY = "cover.nano_shutter_v_3"
async def test_window_cover(hass, client, chain_actuator_zws12, integration):
@ -306,6 +307,215 @@ async def test_window_cover(hass, client, chain_actuator_zws12, integration):
assert state.state == "closed"
async def test_aeotec_nano_shutter_cover(
hass, client, aeotec_nano_shutter, integration
):
"""Test movement of an Aeotec Nano Shutter cover entity. Useful to make sure the stop command logic is handled properly."""
node = aeotec_nano_shutter
state = hass.states.get(AEOTEC_SHUTTER_COVER_ENTITY)
assert state
assert state.attributes[ATTR_DEVICE_CLASS] == DEVICE_CLASS_WINDOW
assert state.state == "closed"
assert state.attributes[ATTR_CURRENT_POSITION] == 0
# Test opening
await hass.services.async_call(
"cover",
"open_cover",
{"entity_id": AEOTEC_SHUTTER_COVER_ENTITY},
blocking=True,
)
assert len(client.async_send_command.call_args_list) == 1
args = client.async_send_command.call_args[0][0]
assert args["command"] == "node.set_value"
assert args["nodeId"] == 3
assert args["valueId"] == {
"ccVersion": 4,
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "targetValue",
"propertyName": "targetValue",
"value": 0,
"metadata": {
"label": "Target value",
"max": 99,
"min": 0,
"type": "number",
"valueChangeOptions": ["transitionDuration"],
"readable": True,
"writeable": True,
"label": "Target value",
},
}
assert args["value"]
client.async_send_command.reset_mock()
# Test stop after opening
await hass.services.async_call(
"cover",
"stop_cover",
{"entity_id": AEOTEC_SHUTTER_COVER_ENTITY},
blocking=True,
)
assert len(client.async_send_command.call_args_list) == 2
open_args = client.async_send_command.call_args_list[0][0][0]
assert open_args["command"] == "node.set_value"
assert open_args["nodeId"] == 3
assert open_args["valueId"] == {
"ccVersion": 4,
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "On",
"propertyName": "On",
"value": False,
"metadata": {
"type": "boolean",
"readable": True,
"writeable": True,
"label": "Perform a level change (On)",
"ccSpecific": {"switchType": 1},
},
}
assert not open_args["value"]
close_args = client.async_send_command.call_args_list[1][0][0]
assert close_args["command"] == "node.set_value"
assert close_args["nodeId"] == 3
assert close_args["valueId"] == {
"ccVersion": 4,
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "Off",
"propertyName": "Off",
"value": False,
"metadata": {
"type": "boolean",
"readable": True,
"writeable": True,
"label": "Perform a level change (Off)",
"ccSpecific": {"switchType": 1},
},
}
assert not close_args["value"]
# Test position update from value updated event
event = Event(
type="value updated",
data={
"source": "node",
"event": "value updated",
"nodeId": 6,
"args": {
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "currentValue",
"newValue": 99,
"prevValue": 0,
"propertyName": "currentValue",
},
},
)
node.receive_event(event)
client.async_send_command.reset_mock()
state = hass.states.get(AEOTEC_SHUTTER_COVER_ENTITY)
assert state.state == "open"
# Test closing
await hass.services.async_call(
"cover",
"close_cover",
{"entity_id": AEOTEC_SHUTTER_COVER_ENTITY},
blocking=True,
)
assert len(client.async_send_command.call_args_list) == 1
args = client.async_send_command.call_args[0][0]
assert args["command"] == "node.set_value"
assert args["nodeId"] == 3
assert args["valueId"] == {
"ccVersion": 4,
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "targetValue",
"propertyName": "targetValue",
"value": 0,
"metadata": {
"label": "Target value",
"max": 99,
"min": 0,
"type": "number",
"readable": True,
"writeable": True,
"valueChangeOptions": ["transitionDuration"],
"label": "Target value",
},
}
assert args["value"] == 0
client.async_send_command.reset_mock()
# Test stop after closing
await hass.services.async_call(
"cover",
"stop_cover",
{"entity_id": AEOTEC_SHUTTER_COVER_ENTITY},
blocking=True,
)
assert len(client.async_send_command.call_args_list) == 2
open_args = client.async_send_command.call_args_list[0][0][0]
assert open_args["command"] == "node.set_value"
assert open_args["nodeId"] == 3
assert open_args["valueId"] == {
"ccVersion": 4,
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "On",
"propertyName": "On",
"value": False,
"metadata": {
"type": "boolean",
"readable": True,
"writeable": True,
"label": "Perform a level change (On)",
"ccSpecific": {"switchType": 1},
},
}
assert not open_args["value"]
close_args = client.async_send_command.call_args_list[1][0][0]
assert close_args["command"] == "node.set_value"
assert close_args["nodeId"] == 3
assert close_args["valueId"] == {
"ccVersion": 4,
"commandClassName": "Multilevel Switch",
"commandClass": 38,
"endpoint": 0,
"property": "Off",
"propertyName": "Off",
"value": False,
"metadata": {
"type": "boolean",
"readable": True,
"writeable": True,
"label": "Perform a level change (Off)",
"ccSpecific": {"switchType": 1},
},
}
assert not close_args["value"]
async def test_blind_cover(hass, client, iblinds_v2, integration):
"""Test a blind cover entity."""
state = hass.states.get(BLIND_COVER_ENTITY)

498
tests/fixtures/zwave_js/cover_aeotec_nano_shutter_state.json vendored Normal file
View File

@ -0,0 +1,498 @@
{
"nodeId": 3,
"index": 0,
"installerIcon": 6656,
"userIcon": 6656,
"status": 4,
"ready": true,
"isListening": true,
"isRouting": true,
"isSecure": true,
"manufacturerId": 881,
"productId": 141,
"productType": 3,
"firmwareVersion": "3.1",
"zwavePlusVersion": 1,
"deviceConfig": {
"filename": "/opt/node_modules/@zwave-js/config/config/devices/0x0371/zw141.json",
"manufacturer": "Aeotec Ltd.",
"manufacturerId": 881,
"label": "ZW141",
"description": "Nano Shutter V.3",
"devices": [
{
"productType": 3,
"productId": 141
}
],
"firmwareVersion": {
"min": "0.0",
"max": "255.255"
},
"paramInformation": {
"_map": {}
},
"metadata": {
"inclusion": "3.5.2 Classic inclusion Learn Mode\n1. Set your Z-Wave Controller into its 'Add Device' mode in order to add the product into your Z-Wave system. Refer to the Controller's manual if you are unsure of how to perform this step.\n2. Make sure the product is powered. If not, plug it into a wall socket and power on; its LED will be breathing blue light all the time.\n3. Click Action Button once, it will quickly flash blue light for 30 seconds until it is added into the network. It will become constantly bright yellow light after being assigned a NodeID.\n4. If your Z-Wave Controller supports S2 encryption, enter the first 5 digits of DSK into your Controller's interface if/when requested. The DSK is printed on its housing.\n5. If Adding fails, it will bright red light for 2s and then become breathing blue light; repeat steps 1 to 4. Contact us for further support if needed.\n6. If Adding succeeds, it will bright blue light for 2s and then turn to Load Indicator Mode. Now, this product is a part of your Z-Wave home control system. You can configure it and its automations via your Z-Wave system; please refer to your software's user guide for precise instructions",
"exclusion": "3.6 How to Remove the device from Z-Wave network\n1. Set your Z-Wave Controller into its 'Remove Device' mode in order to remove the product from your Z-Wave system.Refer to the Controller's manual if you are unsure of how to perform this step.\n2. Click Action Button/S1/S2(external switch need to be identified first) 6 times will enter exclusion mode.\n3. If Removing fails, it will bright red light for 2s then turn back to Regular Light Mode, repeat steps 1-2. Contact us for further support if needed.\n4. If Removing succeeds, it will become breathing blue light. Now, it is removed from Z-Wave network successfully",
"reset": "3.7 How to Factory Reset\nManually, press and hold the Action Button for at least 20s and then release. The LED indicator will become breathing blue light, which indicates the reset operation is successful. Otherwise, please try again. Contact us for further support if needed.\nNote:\n1. This procedure should only be used when the primary controller is missing or inoperable.\n2. Factory Reset will:\na) Remove the product from Z-Wave network;\nb) Delete the Association setting;",
"manual": "https://products.z-wavealliance.org/ProductManual/File?folder=&filename=product_documents/3693/Nano%20Shutter%20-%20Product%20Manual.pdf"
},
"isEmbedded": true
},
"label": "ZW141",
"interviewAttempts": 0,
"endpoints": [
{
"nodeId": 3,
"index": 0,
"installerIcon": 6656,
"userIcon": 6656,
"deviceClass": {
"basic": {
"key": 4,
"label": "Routing Slave"
},
"generic": {
"key": 17,
"label": "Multilevel Switch"
},
"specific": {
"key": 7,
"label": "Motor Control Class C"
},
"mandatorySupportedCCs": [
32,
38,
37,
114,
134
],
"mandatoryControlledCCs": []
}
}
],
"values": [
{
"endpoint": 0,
"commandClass": 38,
"commandClassName": "Multilevel Switch",
"property": "targetValue",
"propertyName": "targetValue",
"ccVersion": 4,
"metadata": {
"type": "number",
"readable": true,
"writeable": true,
"label": "Target value",
"valueChangeOptions": [
"transitionDuration"
],
"min": 0,
"max": 99
},
"value": 0
},
{
"endpoint": 0,
"commandClass": 38,
"commandClassName": "Multilevel Switch",
"property": "duration",
"propertyName": "duration",
"ccVersion": 4,
"metadata": {
"type": "duration",
"readable": true,
"writeable": true,
"label": "Transition duration"
},
"value": {
"value": 0,
"unit": "seconds"
}
},
{
"endpoint": 0,
"commandClass": 38,
"commandClassName": "Multilevel Switch",
"property": "currentValue",
"propertyName": "currentValue",
"ccVersion": 4,
"metadata": {
"type": "number",
"readable": true,
"writeable": false,
"label": "Current value",
"min": 0,
"max": 99
},
"value": 0
},
{
"endpoint": 0,
"commandClass": 38,
"commandClassName": "Multilevel Switch",
"property": "On",
"propertyName": "On",
"ccVersion": 4,
"metadata": {
"type": "boolean",
"readable": true,
"writeable": true,
"label": "Perform a level change (On)",
"ccSpecific": {
"switchType": 1
}
},
"value": false
},
{
"endpoint": 0,
"commandClass": 38,
"commandClassName": "Multilevel Switch",
"property": "Off",
"propertyName": "Off",
"ccVersion": 4,
"metadata": {
"type": "boolean",
"readable": true,
"writeable": true,
"label": "Perform a level change (Off)",
"ccSpecific": {
"switchType": 1
}
},
"value": false
},
{
"endpoint": 0,
"commandClass": 43,
"commandClassName": "Scene Activation",
"property": "sceneId",
"propertyName": "sceneId",
"ccVersion": 0,
"metadata": {
"type": "number",
"readable": true,
"writeable": true,
"label": "Scene ID",
"valueChangeOptions": [
"transitionDuration"
],
"min": 1,
"max": 255
}
},
{
"endpoint": 0,
"commandClass": 43,
"commandClassName": "Scene Activation",
"property": "dimmingDuration",
"propertyName": "dimmingDuration",
"ccVersion": 0,
"metadata": {
"type": "any",
"readable": true,
"writeable": true,
"label": "Dimming duration"
}
},
{
"endpoint": 0,
"commandClass": 91,
"commandClassName": "Central Scene",
"property": "slowRefresh",
"propertyName": "slowRefresh",
"ccVersion": 3,
"metadata": {
"type": "boolean",
"readable": true,
"writeable": true,
"description": "When this is true, KeyHeldDown notifications are sent every 55s. When this is false, the notifications are sent every 200ms.",
"label": "Send held down notifications at a slow rate"
}
},
{
"endpoint": 0,
"commandClass": 91,
"commandClassName": "Central Scene",
"property": "scene",
"propertyKey": "001",
"propertyName": "scene",
"propertyKeyName": "001",
"ccVersion": 3,
"metadata": {
"type": "number",
"readable": true,
"writeable": false,
"label": "Scene 001",
"min": 0,
"max": 255,
"states": {
"0": "KeyPressed",
"1": "KeyReleased",
"2": "KeyHeldDown",
"3": "KeyPressed2x"
}
}
},
{
"endpoint": 0,
"commandClass": 91,
"commandClassName": "Central Scene",
"property": "scene",
"propertyKey": "002",
"propertyName": "scene",
"propertyKeyName": "002",
"ccVersion": 3,
"metadata": {
"type": "number",
"readable": true,
"writeable": false,
"label": "Scene 002",
"min": 0,
"max": 255,
"states": {
"0": "KeyPressed",
"1": "KeyReleased",
"2": "KeyHeldDown",
"3": "KeyPressed2x"
}
}
},
{
"endpoint": 0,
"commandClass": 114,
"commandClassName": "Manufacturer Specific",
"property": "manufacturerId",
"propertyName": "manufacturerId",
"ccVersion": 2,
"metadata": {
"type": "number",
"readable": true,
"writeable": false,
"label": "Manufacturer ID",
"min": 0,
"max": 65535
},
"value": 881
},
{
"endpoint": 0,
"commandClass": 114,
"commandClassName": "Manufacturer Specific",
"property": "productType",
"propertyName": "productType",
"ccVersion": 2,
"metadata": {
"type": "number",
"readable": true,
"writeable": false,
"label": "Product type",
"min": 0,
"max": 65535
},
"value": 3
},
{
"endpoint": 0,
"commandClass": 114,
"commandClassName": "Manufacturer Specific",
"property": "productId",
"propertyName": "productId",
"ccVersion": 2,
"metadata": {
"type": "number",
"readable": true,
"writeable": false,
"label": "Product ID",
"min": 0,
"max": 65535
},
"value": 141
},
{
"endpoint": 0,
"commandClass": 134,
"commandClassName": "Version",
"property": "libraryType",
"propertyName": "libraryType",
"ccVersion": 2,
"metadata": {
"type": "any",
"readable": true,
"writeable": false,
"label": "Library type"
},
"value": 3
},
{
"endpoint": 0,
"commandClass": 134,
"commandClassName": "Version",
"property": "protocolVersion",
"propertyName": "protocolVersion",
"ccVersion": 2,
"metadata": {
"type": "any",
"readable": true,
"writeable": false,
"label": "Z-Wave protocol version"
},
"value": "6.4"
},
{
"endpoint": 0,
"commandClass": 134,
"commandClassName": "Version",
"property": "firmwareVersions",
"propertyName": "firmwareVersions",
"ccVersion": 2,
"metadata": {
"type": "any",
"readable": true,
"writeable": false,
"label": "Z-Wave chip firmware versions"
},
"value": [
"3.1"
]
},
{
"endpoint": 0,
"commandClass": 134,
"commandClassName": "Version",
"property": "hardwareVersion",
"propertyName": "hardwareVersion",
"ccVersion": 2,
"metadata": {
"type": "any",
"readable": true,
"writeable": false,
"label": "Z-Wave chip hardware version"
}
}
],
"isFrequentListening": false,
"maxDataRate": 100000,
"supportedDataRates": [
40000,
100000
],
"protocolVersion": 3,
"supportsBeaming": true,
"supportsSecurity": false,
"nodeType": 1,
"zwavePlusNodeType": 0,
"zwavePlusRoleType": 5,
"deviceClass": {
"basic": {
"key": 4,
"label": "Routing Slave"
},
"generic": {
"key": 17,
"label": "Multilevel Switch"
},
"specific": {
"key": 7,
"label": "Motor Control Class C"
},
"mandatorySupportedCCs": [
32,
38,
37,
114,
134
],
"mandatoryControlledCCs": []
},
"commandClasses": [
{
"id": 38,
"name": "Multilevel Switch",
"version": 4,
"isSecure": true
},
{
"id": 43,
"name": "Scene Activation",
"version": 1,
"isSecure": true
},
{
"id": 44,
"name": "Scene Actuator Configuration",
"version": 1,
"isSecure": true
},
{
"id": 89,
"name": "Association Group Information",
"version": 1,
"isSecure": true
},
{
"id": 90,
"name": "Device Reset Locally",
"version": 1,
"isSecure": true
},
{
"id": 91,
"name": "Central Scene",
"version": 3,
"isSecure": true
},
{
"id": 94,
"name": "Z-Wave Plus Info",
"version": 2,
"isSecure": false
},
{
"id": 108,
"name": "Supervision",
"version": 1,
"isSecure": false
},
{
"id": 112,
"name": "Configuration",
"version": 1,
"isSecure": true
},
{
"id": 114,
"name": "Manufacturer Specific",
"version": 2,
"isSecure": false
},
{
"id": 122,
"name": "Firmware Update Meta Data",
"version": 4,
"isSecure": true
},
{
"id": 133,
"name": "Association",
"version": 2,
"isSecure": true
},
{
"id": 134,
"name": "Version",
"version": 2,
"isSecure": true
},
{
"id": 152,
"name": "Security",
"version": 1,
"isSecure": true
}
],
"interviewStage": "Complete",
"deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0371:0x0003:0x008d:3.1"
}