platypush/platypush
platypush
/
platypush
2
2
Fork 4
Code Issues 47 Pull Requests Packages Projects 4 Releases Wiki Activity

The `zwavejs2mqtt` project has been renamed `zwave-js-ui` 

Change the documentation accordingly
This commit is contained in:
Fabio Manganiello 2022-11-30 02:04:48 +01:00
parent b6370b51da
commit 09d70e2ff1
Signed by: blacklight
GPG Key ID: D90FBA7F76362774
2 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
platypush/backend/zwave/mqtt/__init__.py
View File

@ -21,9 +21,11 @@ from platypush.message.event.zwave import (
class ZwaveMqttBackend(MqttBackend): class ZwaveMqttBackend(MqttBackend):
""" """
Listen for events on a `zwavejs2mqtt <https://github.com/zwave-js/zwavejs2mqtt>`_ service. Listen for events on a `zwave-js-ui <https://github.com/zwave-js/zwave-js-ui>`_
For historical reasons, this should be enabled together with the ``zwave.mqtt`` plugin, service. For historical reasons, this should be enabled together with the
even though the actual configuration is only specified on the plugin. ``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: Triggers:
@ -40,7 +42,7 @@ class ZwaveMqttBackend(MqttBackend):
Requires: Requires:
* **paho-mqtt** (``pip install paho-mqtt``) * **paho-mqtt** (``pip install paho-mqtt``)
* A `zwavejs2mqtt instance <https://github.com/zwave-js/zwavejs2mqtt>`_. * A `zwave-js-ui instance <https://github.com/zwave-js/zwave-js-ui>`_.
* The :class:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin` plugin configured. * The :class:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin` plugin configured.
""" """

8
platypush/plugins/zwave/mqtt/__init__.py
View File

@ -46,18 +46,18 @@ _NOT_IMPLEMENTED_ERR = NotImplementedError('Not implemented by zwave.mqtt')
class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin): class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
""" """
This plugin allows you to manage a Z-Wave network over MQTT through This plugin allows you to manage a Z-Wave network over MQTT through
`zwavejs2mqtt <https://github.com/zwave-js/zwavejs2mqtt>`_. `zwave-js-ui <https://github.com/zwave-js/zwave-js-ui>`_.
For historical reasons, it is advised to enabled this plugin together For historical reasons, it is advised to enabled this plugin together
with the ``zwave.mqtt`` backend, or you may lose the ability to listen with the ``zwave.mqtt`` backend, or you may lose the ability to listen
to asynchronous events. to asynchronous events.
Configuration required on the zwavejs2mqtt gateway: Configuration required on the zwave-js-ui gateway:
* Install the gateway following the instructions reported * Install the gateway following the instructions reported
`here <https://zwave-js.github.io/zwavejs2mqtt/#/getting-started/quick-start>`_. `here <https://zwave-js.github.io/zwave-js-ui/#/getting-started/quick-start>`_.
* 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. * Zwave -> Serial Port: The path to your Z-Wave adapter.
* Disabled MQTT Gateway: Set to false. * Disabled MQTT Gateway: Set to false.