lukmangrd/platypush
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fixed Sphinx build warnings

Browse source
This commit is contained in:
Fabio Manganiello 2021-03-14 01:09:01 +01:00
parent b171cb1012
commit 1d3d741212
3 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
platypush/backend/file/monitor/__init__.py
View file

@ -74,17 +74,18 @@ class FileMonitorBackend(Backend):
backend.file.monitor: backend.file.monitor:
paths: paths:
# Recursively monitor changes on the ~/my-images folder that include all # Recursively monitor changes on the ~/my-images folder that include all
# the files matching the "\.jpe?g$" pattern in case-insensitive mode, # the files matching a JPEG extension in case-insensitive mode,
# excluding those whose name starts with tmp_ and # excluding those whose name starts with tmp_ and
# all the files contained in the __MACOSX folders # all the files contained in the __MACOSX folders
- path: ~/my-images - path: ~/my-images
recursive: True recursive: True
case_sensitive: False
regexes: regexes:
- ".*\.jpe?g$" - '.*\.jpe?g$'
ignore_patterns: ignore_patterns:
- "^tmp_.*" - '^tmp_.*'
ignore_directories: ignore_directories:
- "__MACOSX" - '__MACOSX'
""" """

6
platypush/backend/mqtt.py
View file

@ -46,6 +46,9 @@ class MqttClient(mqtt.Client, threading.Thread):
self._stop_scheduled = False self._stop_scheduled = False
def subscribe(self, *topics, **kwargs): def subscribe(self, *topics, **kwargs):
"""
Client subscription handler.
"""
if not topics: if not topics:
topics = self.topics topics = self.topics
@ -54,6 +57,9 @@ class MqttClient(mqtt.Client, threading.Thread):
super().subscribe(topic, **kwargs) super().subscribe(topic, **kwargs)
def unsubscribe(self, *topics, **kwargs): def unsubscribe(self, *topics, **kwargs):
"""
Client unsubscription handler.
"""
if not topics: if not topics:
topics = self.topics topics = self.topics

6
platypush/plugins/zigbee/mqtt.py
View file

@ -23,9 +23,11 @@ class ZigbeeMqttPlugin(MqttPlugin, SwitchPlugin):
Instructions: Instructions:
- Install `cc-tool <https://github.com/dashesy/cc-tool>`_ either from sources or from a package manager. - Install `cc-tool <https://github.com/dashesy/cc-tool>`_ either from sources or from a package manager.
- Connect the Zigbee to your PC/RaspberryPi in this way: - Connect the Zigbee to your PC/RaspberryPi in this way: ::
USB -> CC debugger -> downloader cable -> CC2531 -> USB USB -> CC debugger -> downloader cable -> CC2531 -> USB
The debugger and the adapter should be connected *at the same time*. If the later ``cc-tool`` command throws
- The debugger and the adapter should be connected *at the same time*. If the later ``cc-tool`` command throws
up an error, put the device in sync while connected by pressing the _Reset_ button on the debugger. up an error, put the device in sync while connected by pressing the _Reset_ button on the debugger.
- Check where the device is mapped. On Linux it will usually be ``/dev/ttyACM0``. - Check where the device is mapped. On Linux it will usually be ``/dev/ttyACM0``.
- Download the latest `Z-Stack firmware <https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator>`_ - Download the latest `Z-Stack firmware <https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator>`_