Add support of Z-Wave.Me Z-Way and RaZberry server

.coveragerc

@@ -1390,6 +1390,9 @@ omit =
     homeassistant/components/zwave/util.py
     homeassistant/components/zwave_js/discovery.py
     homeassistant/components/zwave_js/sensor.py
+    homeassistant/components/zwave_me/__init__.py
+    homeassistant/components/zwave_me/helpers.py
+    homeassistant/components/zwave_me/number.py
 
 [report]
 # Regexes for lines to exclude from consideration

CODEOWNERS

@@ -1106,6 +1106,8 @@ homeassistant/components/zwave/* @home-assistant/z-wave
 tests/components/zwave/* @home-assistant/z-wave
 homeassistant/components/zwave_js/* @home-assistant/z-wave
 tests/components/zwave_js/* @home-assistant/z-wave
+homeassistant/components/zwave_me/* @lawfulchaos @Z-Wave-Me
+tests/components/zwave_me/* @lawfulchaos @Z-Wave-Me
 
 # Individual files
 homeassistant/components/demo/weather @fabaff

homeassistant/components/zwave_me/__init__.py

@@ -0,0 +1,122 @@
+"""The Z-Wave-Me WS integration."""
+import asyncio
+import logging
+
+from zwave_me_ws import ZWaveMe, ZWaveMeData
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_TOKEN, CONF_URL
+from homeassistant.core import HomeAssistant, callback
+from homeassistant.exceptions import ConfigEntryNotReady
+from homeassistant.helpers.dispatcher import async_dispatcher_connect, dispatcher_send
+from homeassistant.helpers.entity import Entity
+
+from .const import DOMAIN, PLATFORMS, ZWAVE_PLATFORMS
+
+_LOGGER = logging.getLogger(__name__)
+
+
+async def async_setup_entry(hass, entry):
+    """Set up Z-Wave-Me from a config entry."""
+    hass.data.setdefault(DOMAIN, {})
+    controller = hass.data[DOMAIN][entry.entry_id] = ZWaveMeController(hass, entry)
+    if await controller.async_establish_connection():
+        hass.async_create_task(async_setup_platforms(hass, entry, controller))
+        return True
+    raise ConfigEntryNotReady()
+
+
+async def async_unload_entry(hass, entry):
+    """Unload a config entry."""
+
+    unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+    if unload_ok:
+        controller = hass.data[DOMAIN].pop(entry.entry_id)
+        await controller.zwave_api.close_ws()
+    return unload_ok
+
+
+class ZWaveMeController:
+    """Main ZWave-Me API class."""
+
+    def __init__(self, hass: HomeAssistant, config: ConfigEntry) -> None:
+        """Create the API instance."""
+        self.device_ids: set = set()
+        self._hass = hass
+        self.config = config
+        self.zwave_api = ZWaveMe(
+            on_device_create=self.on_device_create,
+            on_device_update=self.on_device_update,
+            on_new_device=self.add_device,
+            token=self.config.data[CONF_TOKEN],
+            url=self.config.data[CONF_URL],
+            platforms=ZWAVE_PLATFORMS,
+        )
+        self.platforms_inited = False
+
+    async def async_establish_connection(self):
+        """Get connection status."""
+        is_connected = await self.zwave_api.get_connection()
+        return is_connected
+
+    def add_device(self, device: ZWaveMeData) -> None:
+        """Send signal to create device."""
+        if device.deviceType in ZWAVE_PLATFORMS and self.platforms_inited:
+            if device.id in self.device_ids:
+                dispatcher_send(self._hass, f"ZWAVE_ME_INFO_{device.id}", device)
+            else:
+                dispatcher_send(
+                    self._hass, f"ZWAVE_ME_NEW_{device.deviceType.upper()}", device
+                )
+                self.device_ids.add(device.id)
+
+    def on_device_create(self, devices: list) -> None:
+        """Create multiple devices."""
+        for device in devices:
+            self.add_device(device)
+
+    def on_device_update(self, new_info: ZWaveMeData) -> None:
+        """Send signal to update device."""
+        dispatcher_send(self._hass, f"ZWAVE_ME_INFO_{new_info.id}", new_info)
+
+
+async def async_setup_platforms(
+    hass: HomeAssistant, entry: ConfigEntry, controller: ZWaveMeController
+) -> None:
+    """Set up platforms."""
+    await asyncio.gather(
+        *[
+            hass.config_entries.async_forward_entry_setup(entry, platform)
+            for platform in PLATFORMS
+        ]
+    )
+    controller.platforms_inited = True
+
+    await hass.async_add_executor_job(controller.zwave_api.get_devices)
+
+
+class ZWaveMeEntity(Entity):
+    """Representation of a ZWaveMe device."""
+
+    def __init__(self, controller, device):
+        """Initialize the device."""
+        self.controller = controller
+        self.device = device
+        self._attr_name = device.title
+        self._attr_unique_id = f"{self.controller.config.unique_id}-{self.device.id}"
+        self._attr_should_poll = False
+
+    async def async_added_to_hass(self) -> None:
+        """Connect to an updater."""
+        self.async_on_remove(
+            async_dispatcher_connect(
+                self.hass, f"ZWAVE_ME_INFO_{self.device.id}", self.get_new_data
+            )
+        )
+
+    @callback
+    def get_new_data(self, new_data):
+        """Update info in the HAss."""
+        self.device = new_data
+        self._attr_available = not new_data.isFailed
+        self.async_write_ha_state()

homeassistant/components/zwave_me/config_flow.py

@@ -0,0 +1,84 @@
+"""Config flow to configure ZWaveMe integration."""
+
+import logging
+
+from url_normalize import url_normalize
+import voluptuous as vol
+
+from homeassistant import config_entries
+from homeassistant.const import CONF_TOKEN, CONF_URL
+
+from . import helpers
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class ZWaveMeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
+    """ZWaveMe integration config flow."""
+
+    def __init__(self):
+        """Initialize flow."""
+        self.url = None
+        self.token = None
+        self.uuid = None
+
+    async def async_step_user(self, user_input=None):
+        """Handle a flow initialized by the user or started with zeroconf."""
+        errors = {}
+        if self.url is None:
+            schema = vol.Schema(
+                {
+                    vol.Required(CONF_URL): str,
+                    vol.Required(CONF_TOKEN): str,
+                }
+            )
+        else:
+            schema = vol.Schema(
+                {
+                    vol.Required(CONF_TOKEN): str,
+                }
+            )
+
+        if user_input is not None:
+            if self.url is None:
+                self.url = user_input[CONF_URL]
+
+            self.token = user_input[CONF_TOKEN]
+            if not self.url.startswith(("ws://", "wss://")):
+                self.url = f"ws://{self.url}"
+            self.url = url_normalize(self.url, default_scheme="ws")
+            if self.uuid is None:
+                self.uuid = await helpers.get_uuid(self.url, self.token)
+                if self.uuid is not None:
+                    await self.async_set_unique_id(self.uuid, raise_on_progress=False)
+                    self._abort_if_unique_id_configured()
+                else:
+                    errors["base"] = "no_valid_uuid_set"
+
+            if not errors:
+                return self.async_create_entry(
+                    title=self.url,
+                    data={CONF_URL: self.url, CONF_TOKEN: self.token},
+                )
+
+        return self.async_show_form(
+            step_id="user",
+            data_schema=schema,
+            errors=errors,
+        )
+
+    async def async_step_zeroconf(self, discovery_info):
+        """
+        Handle a discovered Z-Wave accessory - get url to pass into user step.
+
+        This flow is triggered by the discovery component.
+        """
+        self.url = discovery_info.host
+        self.uuid = await helpers.get_uuid(self.url)
+        if self.uuid is None:
+            return self.async_abort(reason="no_valid_uuid_set")
+
+        await self.async_set_unique_id(self.uuid)
+        self._abort_if_unique_id_configured()
+        return await self.async_step_user()

homeassistant/components/zwave_me/const.py

@@ -0,0 +1,14 @@
+"""Constants for ZWaveMe."""
+
+from homeassistant.const import Platform
+
+# Base component constants
+DOMAIN = "zwave_me"
+
+ZWAVE_PLATFORMS = [
+    "switchMultilevel",
+]
+
+PLATFORMS = [
+    Platform.NUMBER,
+]

homeassistant/components/zwave_me/helpers.py

@@ -0,0 +1,14 @@
+"""Helpers for zwave_me config flow."""
+from __future__ import annotations
+
+from zwave_me_ws import ZWaveMe
+
+
+async def get_uuid(url: str, token: str | None = None) -> str | None:
+    """Get an uuid from Z-Wave-Me."""
+    conn = ZWaveMe(url=url, token=token)
+    uuid = None
+    if await conn.get_connection():
+        uuid = await conn.get_uuid()
+    await conn.close_ws()
+    return uuid

homeassistant/components/zwave_me/manifest.json

@@ -0,0 +1,17 @@
+{
+  "domain": "zwave_me",
+  "name": "Z-Wave.Me",
+  "documentation": "https://www.home-assistant.io/integrations/zwave_me",
+  "iot_class": "local_push",
+  "requirements": [
+    "zwave_me_ws==0.1.22",
+    "url-normalize==1.4.1"
+  ],
+  "after_dependencies": ["zeroconf"],
+  "zeroconf": [{"type":"_hap._tcp.local.", "name": "*z.wave-me*"}],
+  "config_flow": true,
+  "codeowners": [
+    "@lawfulchaos",
+    "@Z-Wave-Me"
+  ]
+}

homeassistant/components/zwave_me/number.py

@@ -0,0 +1,45 @@
+"""Representation of a switchMultilevel."""
+from homeassistant.components.number import NumberEntity
+from homeassistant.core import callback
+from homeassistant.helpers.dispatcher import async_dispatcher_connect
+
+from . import ZWaveMeEntity
+from .const import DOMAIN
+
+DEVICE_NAME = "switchMultilevel"
+
+
+async def async_setup_entry(hass, config_entry, async_add_entities):
+    """Set up the number platform."""
+
+    @callback
+    def add_new_device(new_device):
+        controller = hass.data[DOMAIN][config_entry.entry_id]
+        switch = ZWaveMeNumber(controller, new_device)
+
+        async_add_entities(
+            [
+                switch,
+            ]
+        )
+
+    config_entry.async_on_unload(
+        async_dispatcher_connect(
+            hass, f"ZWAVE_ME_NEW_{DEVICE_NAME.upper()}", add_new_device
+        )
+    )
+
+
+class ZWaveMeNumber(ZWaveMeEntity, NumberEntity):
+    """Representation of a ZWaveMe Multilevel Switch."""
+
+    @property
+    def value(self):
+        """Return the unit of measurement."""
+        return self.device.level
+
+    def set_value(self, value: float) -> None:
+        """Update the current value."""
+        self.controller.zwave_api.send_command(
+            self.device.id, f"exact?level={str(round(value))}"
+        )

homeassistant/components/zwave_me/strings.json

@@ -0,0 +1,20 @@
+{
+  "config": {
+    "step": {
+      "user": {
+        "description": "Input IP address of Z-Way server and Z-Way access token. IP address can be prefixed with wss:// if HTTPS should be used instead of HTTP. To get the token go to the Z-Way user interface > Menu > Settings > User > API token. It is suggested to create a new user for Home Assistant and grant access to devices you need to control from Home Assistant. It is also possible to use remote access via find.z-wave.me to connect a remote Z-Way. Input wss://find.z-wave.me in IP field and copy the token with Global scope (log-in to Z-Way via find.z-wave.me for this).",
+        "data": {
+          "url": "[%key:common::config_flow::data::url%]",
+          "token": "Token"
+        }
+      }
+    },
+    "error": {
+      "no_valid_uuid_set": "No valid UUID set"
+    },
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
+      "no_valid_uuid_set": "No valid UUID set"
+    }
+  }
+}

homeassistant/components/zwave_me/translations/en.json

@@ -0,0 +1,20 @@
+{
+    "config": {
+        "abort": {
+            "already_configured": "Device is already configured",
+            "no_valid_uuid_set": "No valid UUID set"
+        },
+        "error": {
+            "no_valid_uuid_set": "No valid UUID set"
+        },
+        "step": {
+            "user": {
+                "data": {
+                    "token": "Token",
+                    "url": "URL"
+                },
+                "description": "Input IP address of Z-Way server and Z-Way access token. IP address can be prefixed with wss:// if HTTPS should be used instead of HTTP. To get the token go to the Z-Way user interface > Menu > Settings > User > API token. It is suggested to create a new user for Home Assistant and grant access to devices you need to control from Home Assistant. It is also possible to use remote access via find.z-wave.me to connect a remote Z-Way. Input wss://find.z-wave.me in IP field and copy the token with Global scope (log-in to Z-Way via find.z-wave.me for this)."
+            }
+        }
+    }
+}

homeassistant/generated/config_flows.py

@@ -375,5 +375,6 @@
     "zerproc",
     "zha",
     "zwave",
-    "zwave_js"
+    "zwave_js",
+    "zwave_me"
 ]

homeassistant/generated/zeroconf.py

@@ -134,6 +134,10 @@
     "_hap._tcp.local.": [
         {
             "domain": "homekit_controller"
+        },
+        {
+            "domain": "zwave_me",
+            "name": "*z.wave-me*"
         }
     ],
     "_homekit._tcp.local.": [

requirements_all.txt

@@ -2408,6 +2408,7 @@ upcloud-api==2.0.0
 
 # homeassistant.components.huawei_lte
 # homeassistant.components.syncthru
+# homeassistant.components.zwave_me
 url-normalize==1.4.1
 
 # homeassistant.components.uscis
@@ -2562,3 +2563,6 @@ zm-py==0.5.2
 
 # homeassistant.components.zwave_js
 zwave-js-server-python==0.34.0
+
+# homeassistant.components.zwave_me
+zwave_me_ws==0.1.22