From 09d70e2ff15d8bd3725ce3f3321650570e3ce58f Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Wed, 30 Nov 2022 02:04:48 +0100 Subject: [PATCH] The `zwavejs2mqtt` project has been renamed `zwave-js-ui` Change the documentation accordingly --- platypush/backend/zwave/mqtt/__init__.py | 10 ++++++---- platypush/plugins/zwave/mqtt/__init__.py | 8 ++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/platypush/backend/zwave/mqtt/__init__.py b/platypush/backend/zwave/mqtt/__init__.py index 65ca7bbe..4cc9d74a 100644 --- a/platypush/backend/zwave/mqtt/__init__.py +++ b/platypush/backend/zwave/mqtt/__init__.py @@ -21,9 +21,11 @@ from platypush.message.event.zwave import ( class ZwaveMqttBackend(MqttBackend): """ - Listen for events on a `zwavejs2mqtt `_ service. - For historical reasons, this should be enabled together with the ``zwave.mqtt`` plugin, - even though the actual configuration is only specified on the plugin. + Listen for events on a `zwave-js-ui `_ + service. For historical reasons, this should be enabled together with the + ``zwave.mqtt`` plugin, even though the actual configuration is only + specified on the plugin. For this reason, this backend will be deprecated in + the near future and merged with its associated plugin. Triggers: @@ -40,7 +42,7 @@ class ZwaveMqttBackend(MqttBackend): Requires: * **paho-mqtt** (``pip install paho-mqtt``) - * A `zwavejs2mqtt instance `_. + * A `zwave-js-ui instance `_. * The :class:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin` plugin configured. """ diff --git a/platypush/plugins/zwave/mqtt/__init__.py b/platypush/plugins/zwave/mqtt/__init__.py index c8f5656d..e401e444 100644 --- a/platypush/plugins/zwave/mqtt/__init__.py +++ b/platypush/plugins/zwave/mqtt/__init__.py @@ -46,18 +46,18 @@ _NOT_IMPLEMENTED_ERR = NotImplementedError('Not implemented by zwave.mqtt') class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin): """ This plugin allows you to manage a Z-Wave network over MQTT through - `zwavejs2mqtt `_. + `zwave-js-ui `_. For historical reasons, it is advised to enabled this plugin together with the ``zwave.mqtt`` backend, or you may lose the ability to listen to asynchronous events. - Configuration required on the zwavejs2mqtt gateway: + Configuration required on the zwave-js-ui gateway: * Install the gateway following the instructions reported - `here `_. + `here `_. - * Configure the following settings from the zwavejs2mqtt web panel: + * Configure the following settings from the zwave-js-ui web panel: * Zwave -> Serial Port: The path to your Z-Wave adapter. * Disabled MQTT Gateway: Set to false.