fabaff/platypush
1
0
Fork 0
forked from platypush/platypush
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed docstring for zigbee.mqtt plugin.

Browse source
This commit is contained in:
Fabio Manganiello 2023-04-23 13:03:10 +02:00
parent 0fc05135df
commit 9c1855e4c0
Signed by untrusted user: blacklight
GPG key ID: D90FBA7F76362774
1 changed files with 21 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
platypush/plugins/zigbee/mqtt/__init__.py
View file

@ -84,10 +84,10 @@ class ZigbeeMqttPlugin(
.. code-block:: shell .. code-block:: shell
wget https://github.com/Koenkk/Z-Stack-firmware/raw/master\ wget https://github.com/Koenkk/Z-Stack-firmware/raw/master\
/coordinator/Z-Stack_Home_1.2/bin/default/CC2531_DEFAULT_20201127.zip /coordinator/Z-Stack_Home_1.2/bin/default/CC2531_DEFAULT_20201127.zip
unzip CC2531_DEFAULT_20201127.zip unzip CC2531_DEFAULT_20201127.zip
[sudo] cc-tool -e -w CC2531ZNP-Prod.hex [sudo] cc-tool -e -w CC2531ZNP-Prod.hex
- You can disconnect your debugger and downloader cable once the firmware is flashed. - You can disconnect your debugger and downloader cable once the firmware is flashed.
@ -98,13 +98,13 @@ class ZigbeeMqttPlugin(
.. code-block:: shell .. code-block:: shell
# Clone zigbee2mqtt repository # Clone zigbee2mqtt repository
[sudo] git clone https://github.com/Koenkk/zigbee2mqtt.git /opt/zigbee2mqtt [sudo] git clone https://github.com/Koenkk/zigbee2mqtt.git /opt/zigbee2mqtt
[sudo] chown -R pi:pi /opt/zigbee2mqtt # Or whichever is your user [sudo] chown -R pi:pi /opt/zigbee2mqtt # Or whichever is your user
# Install dependencies (as user "pi") # Install dependencies (as user "pi")
cd /opt/zigbee2mqtt cd /opt/zigbee2mqtt
npm install npm install
- You need to have an MQTT broker running somewhere. If not, you can install - You need to have an MQTT broker running somewhere. If not, you can install
`Mosquitto <https://mosquitto.org/>`_ through your package manager on any device in your network. `Mosquitto <https://mosquitto.org/>`_ through your package manager on any device in your network.
@ -113,23 +113,22 @@ class ZigbeeMqttPlugin(
.. code-block:: yaml .. code-block:: yaml
# MQTT settings # MQTT settings
mqtt: mqtt:
# MQTT base topic for zigbee2mqtt MQTT messages # MQTT base topic for zigbee2mqtt MQTT messages
base_topic: zigbee2mqtt base_topic: zigbee2mqtt
# MQTT server URL # MQTT server URL
server: 'mqtt://localhost' server: 'mqtt://localhost'
# MQTT server authentication, uncomment if required: # MQTT server authentication, uncomment if required:
# user: my_user # user: my_user
# password: my_password # password: my_password
- Also make sure that ``permit_join`` is set to ``True``, in order to allow Zigbee devices to join the network - Also make sure that ``permit_join`` is set to ``True``, in order to allow Zigbee devices to join the network
while you're configuring it. It's equally important to set ``permit_join`` to ``False`` once you have while you're configuring it. It's equally important to set ``permit_join`` to ``False`` once you have
configured your network, to prevent accidental/malignant joins from outer Zigbee devices. configured your network, to prevent accidental/malignant joins from outer Zigbee devices.
- Start the ``zigbee2mqtt`` daemon on your device (the - Start the ``zigbee2mqtt`` daemon on your device (the
`official documentation <https://www.zigbee2mqtt.io/getting_started `official documentation <https://www.zigbee2mqtt.io/getting_started/running_zigbee2mqtt.html#5-optional-running-as-a-daemon-with-systemctl>`_
/running_zigbee2mqtt.html#5-optional-running-as-a-daemon-with-systemctl>`_
also contains instructions on how to configure it as a ``systemd`` service: also contains instructions on how to configure it as a ``systemd`` service:
.. code-block:: shell .. code-block:: shell
@ -188,7 +187,7 @@ class ZigbeeMqttPlugin(
* :class:`platypush.message.event.zigbee.mqtt.ZigbeeMqttErrorEvent` when an internal error occurs * :class:`platypush.message.event.zigbee.mqtt.ZigbeeMqttErrorEvent` when an internal error occurs
on the zigbee2mqtt service. on the zigbee2mqtt service.
""" """ # noqa: E501
def __init__( def __init__(
self, self,