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

Add new input to zwave_js.multicast_set_value service (#53369) 

* Tweak Z-Wave JS service and WS API commands

* Revert WS API change so it can be split out

* Add keywords
pull/53424/head
Raman Gupta 2021-07-23 10:35:44 -04:00 committed by GitHub
parent 9ee7e55f10
commit 952cb964c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 112 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
homeassistant/components/zwave_js/services.py
View File

@ -283,6 +283,7 @@ class ZWaveServices:
), ),
vol.Optional(const.ATTR_ENDPOINT): vol.Coerce(int), vol.Optional(const.ATTR_ENDPOINT): vol.Coerce(int),
vol.Required(const.ATTR_VALUE): VALUE_SCHEMA, vol.Required(const.ATTR_VALUE): VALUE_SCHEMA,
vol.Optional(const.ATTR_OPTIONS): {cv.string: VALUE_SCHEMA},
}, },
vol.Any( vol.Any(
cv.has_at_least_one_key(ATTR_DEVICE_ID, ATTR_ENTITY_ID), cv.has_at_least_one_key(ATTR_DEVICE_ID, ATTR_ENTITY_ID),
@ -409,6 +410,7 @@ class ZWaveServices:
"""Set a value via multicast to multiple nodes.""" """Set a value via multicast to multiple nodes."""
nodes = service.data[const.ATTR_NODES] nodes = service.data[const.ATTR_NODES]
broadcast: bool = service.data[const.ATTR_BROADCAST] broadcast: bool = service.data[const.ATTR_BROADCAST]
options = service.data.get(const.ATTR_OPTIONS)
if not broadcast and len(nodes) == 1: if not broadcast and len(nodes) == 1:
const.LOGGER.warning( const.LOGGER.warning(
@ -438,10 +440,11 @@ class ZWaveServices:
client = self._hass.data[const.DOMAIN][entry_id][const.DATA_CLIENT] client = self._hass.data[const.DOMAIN][entry_id][const.DATA_CLIENT]
success = await async_multicast_set_value( success = await async_multicast_set_value(
client, client=client,
new_value, new_value=new_value,
{k: v for k, v in value.items() if v is not None}, value_data={k: v for k, v in value.items() if v is not None},
None if broadcast else list(nodes), nodes=None if broadcast else list(nodes),
options=options,
) )
if success is False: if success is False:

8
homeassistant/components/zwave_js/services.yaml
View File

@ -156,7 +156,7 @@ set_value:
object: object:
options: options:
name: Options name: Options
description: Set value options. Refer to the Z-Wave JS documentation for more information on what options can be set. description: Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set.
required: false required: false
selector: selector:
object: object:
@ -209,6 +209,12 @@ multicast_set_value:
required: false required: false
selector: selector:
text: text:
options:
name: Options
description: Set value options map. Refer to the Z-Wave JS documentation for more information on what options can be set.
required: false
selector:
object:
value: value:
name: Value name: Value
description: The new value to set. description: The new value to set.

1
tests/components/zwave_js/test_light.py
View File

@ -569,6 +569,7 @@ async def test_rgbw_light(hass, client, zen_31, integration):
"type": "any", "type": "any",
"readable": True, "readable": True,
"writeable": True, "writeable": True,
"valueChangeOptions": ["transitionDuration"],
}, },
"value": {"blue": 70, "green": 159, "red": 255, "warmWhite": 141}, "value": {"blue": 70, "green": 159, "red": 255, "warmWhite": 141},
} }

100
tests/components/zwave_js/test_services.py
View File

@ -13,6 +13,7 @@ from homeassistant.components.zwave_js.const import (
ATTR_CONFIG_VALUE, ATTR_CONFIG_VALUE,
ATTR_OPTIONS, ATTR_OPTIONS,
ATTR_PROPERTY, ATTR_PROPERTY,
ATTR_PROPERTY_KEY,
ATTR_REFRESH_ALL_VALUES, ATTR_REFRESH_ALL_VALUES,
ATTR_VALUE, ATTR_VALUE,
ATTR_WAIT_FOR_RESULT, ATTR_WAIT_FOR_RESULT,
@ -34,6 +35,7 @@ from homeassistant.helpers.entity_registry import async_get as async_get_ent_reg
from .common import ( from .common import (
AEON_SMART_SWITCH_LIGHT_ENTITY, AEON_SMART_SWITCH_LIGHT_ENTITY,
AIR_TEMPERATURE_SENSOR, AIR_TEMPERATURE_SENSOR,
BULB_6_MULTI_COLOR_LIGHT_ENTITY,
CLIMATE_DANFOSS_LC13_ENTITY, CLIMATE_DANFOSS_LC13_ENTITY,
CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY, CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY,
CLIMATE_RADIO_THERMOSTAT_ENTITY, CLIMATE_RADIO_THERMOSTAT_ENTITY,
@ -819,8 +821,9 @@ async def test_multicast_set_value(
CLIMATE_DANFOSS_LC13_ENTITY, CLIMATE_DANFOSS_LC13_ENTITY,
CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY, CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY,
], ],
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
@ -834,8 +837,9 @@ async def test_multicast_set_value(
climate_danfoss_lc_13.node_id, climate_danfoss_lc_13.node_id,
] ]
assert args["valueId"] == { assert args["valueId"] == {
"commandClass": 117, "commandClass": 67,
"property": "local", "property": "setpoint",
"propertyKey": 1,
} }
assert args["value"] == 2 assert args["value"] == 2
@ -850,8 +854,9 @@ async def test_multicast_set_value(
CLIMATE_DANFOSS_LC13_ENTITY, CLIMATE_DANFOSS_LC13_ENTITY,
CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY, CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY,
], ],
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: "0x2", ATTR_VALUE: "0x2",
}, },
blocking=True, blocking=True,
@ -865,8 +870,9 @@ async def test_multicast_set_value(
climate_danfoss_lc_13.node_id, climate_danfoss_lc_13.node_id,
] ]
assert args["valueId"] == { assert args["valueId"] == {
"commandClass": 117, "commandClass": 67,
"property": "local", "property": "setpoint",
"propertyKey": 1,
} }
assert args["value"] == 2 assert args["value"] == 2
@ -878,8 +884,9 @@ async def test_multicast_set_value(
SERVICE_MULTICAST_SET_VALUE, SERVICE_MULTICAST_SET_VALUE,
{ {
ATTR_BROADCAST: True, ATTR_BROADCAST: True,
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
@ -889,8 +896,9 @@ async def test_multicast_set_value(
args = client.async_send_command.call_args[0][0] args = client.async_send_command.call_args[0][0]
assert args["command"] == "broadcast_node.set_value" assert args["command"] == "broadcast_node.set_value"
assert args["valueId"] == { assert args["valueId"] == {
"commandClass": 117, "commandClass": 67,
"property": "local", "property": "setpoint",
"propertyKey": 1,
} }
assert args["value"] == 2 assert args["value"] == 2
@ -902,8 +910,9 @@ async def test_multicast_set_value(
SERVICE_MULTICAST_SET_VALUE, SERVICE_MULTICAST_SET_VALUE,
{ {
ATTR_ENTITY_ID: CLIMATE_DANFOSS_LC13_ENTITY, ATTR_ENTITY_ID: CLIMATE_DANFOSS_LC13_ENTITY,
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
@ -921,8 +930,9 @@ async def test_multicast_set_value(
DOMAIN, DOMAIN,
SERVICE_MULTICAST_SET_VALUE, SERVICE_MULTICAST_SET_VALUE,
{ {
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
@ -940,8 +950,9 @@ async def test_multicast_set_value(
CLIMATE_DANFOSS_LC13_ENTITY, CLIMATE_DANFOSS_LC13_ENTITY,
CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY, CLIMATE_EUROTRONICS_SPIRIT_Z_ENTITY,
], ],
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
@ -965,8 +976,9 @@ async def test_multicast_set_value(
CLIMATE_DANFOSS_LC13_ENTITY, CLIMATE_DANFOSS_LC13_ENTITY,
], ],
ATTR_DEVICE_ID: "fake_device_id", ATTR_DEVICE_ID: "fake_device_id",
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
@ -982,14 +994,58 @@ async def test_multicast_set_value(
SERVICE_MULTICAST_SET_VALUE, SERVICE_MULTICAST_SET_VALUE,
{ {
ATTR_BROADCAST: True, ATTR_BROADCAST: True,
ATTR_COMMAND_CLASS: 117, ATTR_COMMAND_CLASS: 67,
ATTR_PROPERTY: "local", ATTR_PROPERTY: "setpoint",
ATTR_PROPERTY_KEY: 1,
ATTR_VALUE: 2, ATTR_VALUE: 2,
}, },
blocking=True, blocking=True,
) )
async def test_multicast_set_value_options(
hass,
client,
bulb_6_multi_color,
light_color_null_values,
integration,
):
"""Test multicast_set_value service with options."""
await hass.services.async_call(
DOMAIN,
SERVICE_MULTICAST_SET_VALUE,
{
ATTR_ENTITY_ID: [
BULB_6_MULTI_COLOR_LIGHT_ENTITY,
"light.repeater",
],
ATTR_COMMAND_CLASS: 51,
ATTR_PROPERTY: "targetColor",
ATTR_PROPERTY_KEY: 2,
ATTR_VALUE: 2,
ATTR_OPTIONS: {"transitionDuration": 1},
},
blocking=True,
)
assert len(client.async_send_command.call_args_list) == 1
args = client.async_send_command.call_args[0][0]
assert args["command"] == "multicast_group.set_value"
assert args["nodeIDs"] == [
bulb_6_multi_color.node_id,
light_color_null_values.node_id,
]
assert args["valueId"] == {
"commandClass": 51,
"property": "targetColor",
"propertyKey": 2,
}
assert args["value"] == 2
assert args["options"] == {"transitionDuration": 1}
client.async_send_command.reset_mock()
async def test_ping( async def test_ping(
hass, hass,
client, client,

14
tests/fixtures/zwave_js/light_color_null_values_state.json vendored
View File

@ -1,5 +1,5 @@
{ {
"nodeId": 39, "nodeId": 40,
"index": 0, "index": 0,
"installerIcon": 6912, "installerIcon": 6912,
"userIcon": 6912, "userIcon": 6912,
@ -297,7 +297,8 @@
"description": "The target value of the Red color.", "description": "The target value of the Red color.",
"label": "Target value (Red)", "label": "Target value (Red)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {
@ -316,7 +317,8 @@
"description": "The target value of the Green color.", "description": "The target value of the Green color.",
"label": "Target value (Green)", "label": "Target value (Green)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {
@ -335,7 +337,8 @@
"description": "The target value of the Blue color.", "description": "The target value of the Blue color.",
"label": "Target value (Blue)", "label": "Target value (Blue)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {
@ -349,7 +352,8 @@
"type": "any", "type": "any",
"readable": true, "readable": true,
"writeable": true, "writeable": true,
"label": "Target Color" "label": "Target Color",
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {

15
tests/fixtures/zwave_js/zen_31_state.json vendored
View File

@ -1645,7 +1645,8 @@
"type": "any", "type": "any",
"readable": true, "readable": true,
"writeable": true, "writeable": true,
"label": "Target Color" "label": "Target Color",
"valueChangeOptions": ["transitionDuration"]
}, },
"value": { "value": {
"warmWhite": 141, "warmWhite": 141,
@ -1670,7 +1671,8 @@
"description": "The target value of the Warm White color.", "description": "The target value of the Warm White color.",
"label": "Target value (Warm White)", "label": "Target value (Warm White)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {
@ -1689,7 +1691,8 @@
"description": "The target value of the Red color.", "description": "The target value of the Red color.",
"label": "Target value (Red)", "label": "Target value (Red)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {
@ -1708,7 +1711,8 @@
"description": "The target value of the Green color.", "description": "The target value of the Green color.",
"label": "Target value (Green)", "label": "Target value (Green)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {
@ -1727,7 +1731,8 @@
"description": "The target value of the Blue color.", "description": "The target value of the Blue color.",
"label": "Target value (Blue)", "label": "Target value (Blue)",
"min": 0, "min": 0,
"max": 255 "max": 255,
"valueChangeOptions": ["transitionDuration"]
} }
}, },
{ {