Add OZW node config parameters websocket commands

.coveragerc

@@ -639,6 +639,9 @@ omit =
     homeassistant/components/ovo_energy/__init__.py
     homeassistant/components/ovo_energy/const.py
     homeassistant/components/ovo_energy/sensor.py
+    homeassistant/components/ozw/__init__.py
+    homeassistant/components/ozw/entity.py
+    homeassistant/components/ozw/services.py
     homeassistant/components/panasonic_bluray/media_player.py
     homeassistant/components/panasonic_viera/media_player.py
     homeassistant/components/pandora/media_player.py
@@ -1030,9 +1033,6 @@ omit =
     homeassistant/components/ziggo_mediabox_xl/media_player.py
     homeassistant/components/supla/*
     homeassistant/components/zwave/util.py
-    homeassistant/components/ozw/__init__.py
-    homeassistant/components/ozw/entity.py
-    homeassistant/components/ozw/services.py
 
 [report]
 # Regexes for lines to exclude from consideration

homeassistant/components/ozw/manifest.json

@@ -4,7 +4,7 @@
   "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/ozw",
   "requirements": [
-    "python-openzwave-mqtt==1.0.5"
+    "python-openzwave-mqtt==1.2.0"
   ],
   "after_dependencies": [
     "mqtt"

homeassistant/components/ozw/services.py

@@ -1,7 +1,8 @@
 """Methods and classes related to executing Z-Wave commands and publishing these to hass."""
 import logging
 
-from openzwavemqtt.const import CommandClass, ValueType
+from openzwavemqtt.const import ATTR_LABEL, ATTR_POSITION, ATTR_VALUE
+from openzwavemqtt.util.node import get_node_from_manager, set_config_parameter
 import voluptuous as vol
 
 from homeassistant.core import callback
@@ -53,7 +54,24 @@ def async_register(self):
                     vol.Required(const.ATTR_NODE_ID): vol.Coerce(int),
                     vol.Required(const.ATTR_CONFIG_PARAMETER): vol.Coerce(int),
                     vol.Required(const.ATTR_CONFIG_VALUE): vol.Any(
-                        vol.Coerce(int), cv.string
+                        vol.All(
+                            cv.ensure_list,
+                            [
+                                vol.All(
+                                    {
+                                        vol.Exclusive(ATTR_LABEL, "bit"): cv.string,
+                                        vol.Exclusive(ATTR_POSITION, "bit"): vol.Coerce(
+                                            int
+                                        ),
+                                        vol.Required(ATTR_VALUE): bool,
+                                    },
+                                    cv.has_at_least_one_key(ATTR_LABEL, ATTR_POSITION),
+                                )
+                            ],
+                        ),
+                        vol.Coerce(int),
+                        bool,
+                        cv.string,
                     ),
                 }
             ),
@@ -66,57 +84,12 @@ def async_set_config_parameter(self, service):
         node_id = service.data[const.ATTR_NODE_ID]
         param = service.data[const.ATTR_CONFIG_PARAMETER]
         selection = service.data[const.ATTR_CONFIG_VALUE]
-        payload = None
 
-        value = (
-            self._manager.get_instance(instance_id)
-            .get_node(node_id)
-            .get_value(CommandClass.CONFIGURATION, param)
-        )
-
-        if value.type == ValueType.BOOL:
-            payload = selection == "True"
-
-        if value.type == ValueType.LIST:
-            # accept either string from the list value OR the int value
-            for selected in value.value["List"]:
-                if selection not in (selected["Label"], selected["Value"]):
-                    continue
-                payload = int(selected["Value"])
-
-            if payload is None:
-                _LOGGER.error(
-                    "Invalid value %s for parameter %s",
-                    selection,
-                    param,
-                )
-                return
-
-        if value.type == ValueType.BUTTON:
-            # Unsupported at this time
-            _LOGGER.info("Button type not supported yet")
-            return
-
-        if value.type == ValueType.STRING:
-            payload = selection
-
-        if (
-            value.type == ValueType.INT
-            or value.type == ValueType.BYTE
-            or value.type == ValueType.SHORT
-        ):
-            if selection > value.max or selection < value.min:
-                _LOGGER.error(
-                    "Value %s out of range for parameter %s (Min: %s Max: %s)",
-                    selection,
-                    param,
-                    value.min,
-                    value.max,
-                )
-                return
-            payload = int(selection)
+        # These function calls may raise an exception but that's ok because
+        # the exception will show in the UI to the user
+        node = get_node_from_manager(self._manager, instance_id, node_id)
+        payload = set_config_parameter(node, param, selection)
 
-        value.send_value(payload)  # send the payload
         _LOGGER.info(
             "Setting configuration parameter %s on Node %s with value %s",
             param,

homeassistant/components/ozw/websocket_api.py

@@ -1,21 +1,31 @@
 """Web socket API for OpenZWave."""
-
-import logging
-
-from openzwavemqtt.const import EVENT_NODE_ADDED, EVENT_NODE_CHANGED
+from openzwavemqtt.const import (
+    ATTR_LABEL,
+    ATTR_POSITION,
+    ATTR_VALUE,
+    EVENT_NODE_ADDED,
+    EVENT_NODE_CHANGED,
+)
+from openzwavemqtt.exceptions import NotFoundError, NotSupportedError
+from openzwavemqtt.util.node import (
+    get_config_parameters,
+    get_node_from_manager,
+    set_config_parameter,
+)
 import voluptuous as vol
 
 from homeassistant.components import websocket_api
 from homeassistant.core import callback
+from homeassistant.helpers import config_validation as cv
 
-from .const import DOMAIN, MANAGER, OPTIONS
-
-_LOGGER = logging.getLogger(__name__)
+from .const import ATTR_CONFIG_PARAMETER, ATTR_CONFIG_VALUE, DOMAIN, MANAGER, OPTIONS
 
 TYPE = "type"
 ID = "id"
 OZW_INSTANCE = "ozw_instance"
 NODE_ID = "node_id"
+PARAMETER = ATTR_CONFIG_PARAMETER
+VALUE = ATTR_CONFIG_VALUE
 
 ATTR_NODE_QUERY_STAGE = "node_query_stage"
 ATTR_IS_ZWAVE_PLUS = "is_zwave_plus"
@@ -45,6 +55,8 @@ def async_register_api(hass):
     websocket_api.async_register_command(hass, websocket_node_status)
     websocket_api.async_register_command(hass, websocket_node_statistics)
     websocket_api.async_register_command(hass, websocket_refresh_node_info)
+    websocket_api.async_register_command(hass, websocket_get_config_parameters)
+    websocket_api.async_register_command(hass, websocket_set_config_parameter)
 
 
 @websocket_api.websocket_command({vol.Required(TYPE): "ozw/get_instances"})
@@ -102,6 +114,96 @@ def websocket_get_nodes(hass, connection, msg):
     )
 
 
+@websocket_api.websocket_command(
+    {
+        vol.Required(TYPE): "ozw/get_config_parameters",
+        vol.Required(NODE_ID): vol.Coerce(int),
+        vol.Optional(OZW_INSTANCE, default=1): vol.Coerce(int),
+    }
+)
+def websocket_get_config_parameters(hass, connection, msg):
+    """Get a list of configuration parameters for an OZW node instance."""
+    try:
+        node = get_node_from_manager(
+            hass.data[DOMAIN][MANAGER], msg[OZW_INSTANCE], msg[NODE_ID]
+        )
+    except NotFoundError as err:
+        connection.send_error(
+            msg[ID],
+            websocket_api.const.ERR_NOT_FOUND,
+            err.args[0],
+        )
+        return
+
+    connection.send_result(
+        msg[ID],
+        get_config_parameters(node),
+    )
+
+
+@websocket_api.websocket_command(
+    {
+        vol.Required(TYPE): "ozw/set_config_parameter",
+        vol.Required(NODE_ID): vol.Coerce(int),
+        vol.Optional(OZW_INSTANCE, default=1): vol.Coerce(int),
+        vol.Required(PARAMETER): vol.Coerce(int),
+        vol.Required(VALUE): vol.Any(
+            vol.All(
+                cv.ensure_list,
+                [
+                    vol.All(
+                        {
+                            vol.Exclusive(ATTR_LABEL, "bit"): cv.string,
+                            vol.Exclusive(ATTR_POSITION, "bit"): vol.Coerce(int),
+                            vol.Required(ATTR_VALUE): bool,
+                        },
+                        cv.has_at_least_one_key(ATTR_LABEL, ATTR_POSITION),
+                    )
+                ],
+            ),
+            vol.Coerce(int),
+            bool,
+            cv.string,
+        ),
+    }
+)
+def websocket_set_config_parameter(hass, connection, msg):
+    """Set a config parameter to a node."""
+    try:
+        node = get_node_from_manager(
+            hass.data[DOMAIN][MANAGER], msg[OZW_INSTANCE], msg[NODE_ID]
+        )
+    except NotFoundError as err:
+        connection.send_error(
+            msg[ID],
+            websocket_api.const.ERR_NOT_FOUND,
+            err.args[0],
+        )
+        return
+
+    try:
+        set_config_parameter(
+            node,
+            msg[PARAMETER],
+            msg[VALUE],
+        )
+        connection.send_result(msg[ID])
+    except NotFoundError as err:
+        connection.send_error(
+            msg[ID],
+            websocket_api.const.ERR_NOT_FOUND,
+            err.args[0],
+        )
+        return
+    except NotSupportedError as err:
+        connection.send_error(
+            msg[ID],
+            websocket_api.const.ERR_NOT_SUPPORTED,
+            err.args[0],
+        )
+        return
+
+
 @websocket_api.websocket_command(
     {
         vol.Required(TYPE): "ozw/network_status",
@@ -148,14 +250,15 @@ def websocket_network_statistics(hass, connection, msg):
 )
 def websocket_node_status(hass, connection, msg):
     """Get the status for a Z-Wave node."""
-    manager = hass.data[DOMAIN][MANAGER]
-    node = manager.get_instance(msg[OZW_INSTANCE]).get_node(msg[NODE_ID])
-
-    if not node:
-        connection.send_message(
-            websocket_api.error_message(
-                msg[ID], websocket_api.const.ERR_NOT_FOUND, "OZW Node not found"
-            )
+    try:
+        node = get_node_from_manager(
+            hass.data[DOMAIN][MANAGER], msg[OZW_INSTANCE], msg[NODE_ID]
+        )
+    except NotFoundError as err:
+        connection.send_error(
+            msg[ID],
+            websocket_api.const.ERR_NOT_FOUND,
+            err.args[0],
         )
         return
 
@@ -192,14 +295,15 @@ def websocket_node_status(hass, connection, msg):
 )
 def websocket_node_metadata(hass, connection, msg):
     """Get the metadata for a Z-Wave node."""
-    manager = hass.data[DOMAIN][MANAGER]
-    node = manager.get_instance(msg[OZW_INSTANCE]).get_node(msg[NODE_ID])
-
-    if not node:
-        connection.send_message(
-            websocket_api.error_message(
-                msg[ID], websocket_api.const.ERR_NOT_FOUND, "OZW Node not found"
-            )
+    try:
+        node = get_node_from_manager(
+            hass.data[DOMAIN][MANAGER], msg[OZW_INSTANCE], msg[NODE_ID]
+        )
+    except NotFoundError as err:
+        connection.send_error(
+            msg[ID],
+            websocket_api.const.ERR_NOT_FOUND,
+            err.args[0],
         )
         return
 

requirements_all.txt

@@ -1746,7 +1746,7 @@ python-nest==4.1.0
 python-nmap==0.6.1
 
 # homeassistant.components.ozw
-python-openzwave-mqtt==1.0.5
+python-openzwave-mqtt==1.2.0
 
 # homeassistant.components.qbittorrent
 python-qbittorrent==0.4.1

requirements_test_all.txt

@@ -827,7 +827,7 @@ python-miio==0.5.3
 python-nest==4.1.0
 
 # homeassistant.components.ozw
-python-openzwave-mqtt==1.0.5
+python-openzwave-mqtt==1.2.0
 
 # homeassistant.components.songpal
 python-songpal==0.12