Removed deprecated `setup.py web_build` command from platydock [see #195]

- Support for custom PopcornTime API mirror/base URL.

- Full support for TV series search.

- Fixed torrent search (now using a different PopcornTime API mirror).

- Migrated SASS engine from `node-sass` (currently deprecated and broken on Node 16) to `sass`.

- Fixed alignment of Z-Wave UI header on Chrome/Webkit.

.gitignore

@@ -3,7 +3,7 @@
 *.pyc
 __pycache__
 build/
-dist/
+/dist/
 *.egg-info/
 package.sh
 .pypirc
@@ -15,3 +15,7 @@ platypush/backend/http/static/css/*/.sass-cache/
 .vscode
 platypush/backend/http/static/js/lib/vue.js
 platypush/notebooks
+platypush/requests
+/http-client.env.json
+/platypush/backend/http/static/css/dist
+/tests/etc/dashboards

.gitmodules

@@ -1,12 +1,3 @@
-[submodule "platypush/backend/http/static/font-awesome"]
-	path = platypush/backend/http/static/font-awesome
-	url = https://github.com/FortAwesome/Font-Awesome
-[submodule "docs/wiki"]
-	path = docs/wiki
-	url = https://github.com/BlackLight/platypush.wiki.git
-[submodule "platypush/backend/http/static/flag-icons"]
-	path = platypush/backend/http/static/flag-icons
-	url = https://github.com/BlackLight/flag-icon-css.git
 [submodule "platypush/plugins/gpio/sensor/ir/mlx90640/lib"]
 	path = platypush/plugins/camera/ir/mlx90640/lib
 	url = https://github.com/pimoroni/mlx90640-library

.readthedocs.yml

@@ -1,7 +0,0 @@
-build:
-  image: latest
-
-python:
-  version: 3.6
-  setup_py_install: true
-

.travis.requirements

@@ -1,10 +0,0 @@
-pyyaml
-requires
-requests
-flask
-redis
-python-dateutil
-websockets
-bcrypt
-sqlalchemy
-croniter

.travis.yml

@@ -1,22 +0,0 @@
-language: python
-dist: xenial
-python:
-  - "3.7"
-
-install: "pip install -r .travis.requirements"
-
-script: ./run_tests.sh
-
-notifications:
-    email:
-        recipients:
-            - blacklight86@gmail.com
-        on_success: change
-        on_failure: change
-
-services:
-    - redis-server
-
-git:
-    submodules: false
-

CHANGELOG.md

@@ -0,0 +1,177 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+Given the high speed of development in the first phase, changes are being reported only starting from v0.20.2.
+
+## [Unreleased]
+
+- Added `music.spotify.connect` backend to emulate a Spotify Connect receiver through Platypush.
+
+## [0.21.1] - 2021-06-22
+
+### Added
+
+- Added `switchbot` plugin to interact with Switchbot devices over the cloud API instead of
+  directly accessing the device's Bluetooth interface.
+  
+- Added `marshmallow` dependency - it will be used from now own to dump and document schemas
+  and responses instead of the currently mixed approach with `Response` objects and plain
+  dictionaries and lists.
+  
+- Support for custom MQTT timeout on all the `zwavejs2mqtt` calls.
+
+- Added generic joystick backend `backend.joystick.jstest` which uses `jstest` from the
+  standard `joystick` system package to read the state of joysticks not compatible with
+  `python-inputs`.
+  
+- Added PWM PCA9685 plugin.
+
+- Added Linux native joystick plugin, ``backend.joystick.linux``, for the cases where
+  ``python-inputs`` doesn't work and ``jstest`` is too slow.
+
+### Changed
+
+- `switch.switchbot` plugin renamed to `switchbot.bluetooth` plugin, while the new plugin
+  that uses the Switchbot API is simply named `switchbot`.
+
+### Fixed
+
+- More robust reconnection logic on the Pushbullet backend in case of websocket errors.
+
+## [0.21.0] - 2021-05-06
+
+### Added
+
+- Support for custom PopcornTime API mirror/base URL.
+
+- Full support for TV series search.
+
+### Fixed
+
+- Fixed torrent search (now using a different PopcornTime API mirror).
+
+- Migrated SASS engine from `node-sass` (currently deprecated and broken on Node 16) to `sass`.
+
+- Fixed alignment of Z-Wave UI header on Chrome/Webkit.
+
+## [0.20.10] - 2021-04-28
+
+### Fixed
+
+- Fixed zwave/zwavejs2mqtt interoperability.
+
+## [0.20.9] - 2021-04-12
+
+### Added
+
+- Added zwavejs2mqtt integration (see [#186](https://git.platypush.tech/platypush/platypush/-/issues/186).
+
+### Fixed
+
+- Major LINT fixes.
+
+### Removed
+
+- Removed unmaintained integrations: TorrentCast and Booking.com
+
+## [0.20.8] - 2021-04-04
+
+### Added
+
+- Added `<Camera>` dashboard widget.
+
+- Added support for custom dashboard widgets with customized (see https://git.platypush.tech/platypush/platypush/-/wikis/Backends#creating-custom-widgets).
+
+- Added support for controls on `music.mpd` dashboard widget.
+
+### Fixed
+
+- Fixed zigbee2mqtt backend error in case of messages with empty payload (see [#184](https://git.platypush.tech/platypush/platypush/-/issues/184)).
+
+- Fixed compatibility with all versions of websocket-client - versions >= 0.58.0 pass a `WebSocketApp` object as a first
+  argument to the callbacks, as well as versions < 0.54.0 do, but the versions in between don't pass this argument.
+
+## [0.20.7] - 2021-03-26
+
+### Fixed
+
+- Fixed race condition on `media.vlc.stop` when clearing the VLC instance.
+
+- Fixed dashboard widgets custom classes being propagated both to the container and to the widget content [see #179]
+
+- Fixed compatibility with SQLAlchemy >= 1.4.
+
+## [0.20.6] - 2021-03-16
+
+### Added
+
+- Added `log.http` backend to monitor changes to HTTP log files
+  (see [#167](https://git.platypush.tech/platypush/platypush/-/issues/167)).
+
+- Added `file.monitor` backend, which replaces the `inotify` backend
+  (see [#172](https://git.platypush.tech/platypush/platypush/-/issues/172)).
+
+### Removed
+
+- Removed legacy `pusher` script and `local` backend.
+
+### Fixed
+
+- Fixed support for Z-Wave switches.
+
+- Fixed possible race condition on VLC stop.
+
+## [0.20.5] - 2021-03-12
+
+### Added
+
+- Added support for a static list of devices to actively scan to the `bluetooth.scanner` backend
+  (see [#174](https://git.platypush.tech/platypush/platypush/-/issues/174)).
+  
+- Added `weather.openweathermap` plugin and backend, which replaces `weather.darksky`, since the
+  Darksky API will be completely shut down by the end of 2021.
+
+### Fixed
+
+- Cron expressions should adhere to the UNIX cronjob standard and use the machine local time,
+  not UTC, as a reference (closes [#173](https://git.platypush.tech/platypush/platypush/-/issues/173)).
+  
+- Better management of Z-Wave values types from the UI.
+
+- Disable logging for `ZwaveValueEvent` events - they tend to be very verbose and
+  can impact the performance on slower devices. They will still be published to the
+  websocket clients though, so you can still debug Z-Wave values issues from the browser
+  developer console (enable debug traces).
+  
+- Added suffix to the `zigbee.mqtt` backend default `client_id` to prevent clashes with
+  the default `mqtt` backend `client_id`.
+
+## [0.20.4] - 2021-03-08
+
+### Added
+
+- Added SmartThings integration.
+- Support for custom Redis message queue name over the `--redis-queue` argument.
+
+### Fixed
+
+- Refactored tests to use `pytest` instead of `unittest`.
+- Some major bug fixes on procedures and hooks context evaluation.
+
+## [0.20.3] - 2021-02-28
+
+### Fixed
+
+- Several bug fixes on the VLC plugin, including proper management of stop/end-of-stream, volume set and missing integration requirements in `requirements.txt` and `setup.py`.
+
+## [0.20.2] - 2021-02-27
+
+### Fixed
+
+- More stable ZeroConf backends registration logic in case of partial or missing results.
+- Improved and refactored integration tests.
+
+### Added
+
+- Support for passing context variables (${}) from YAML procedures/hooks/crons to Python procedure/hooks/crons.
+- New integration test for testing procedures.

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+Thanks for considering contributing your work to make Platypush a better product!
+
+Contributions are more than welcome, and the follow the standard Gitlab procedure:
+
+- [Fork the repo](https://git.platypush.tech/platypush/platypush).
+- Prepare your changes.
+- [Submit a merge request](https://git.platypush.tech/platypush/platypush/-/merge_requests).
+
+Guidelines:
+
+- The code should ideally have no LINT warnings/issues.
+
+- Project conventions:
+  - 4 spaces to indent.
+  - RST format for classes and methods documentation 
+  - Run `python generate_missing_docs.py` if you are adding new plugins/backends to automatically
+    generate the doc templates. Make sure that you don't accidentally remove lines elements from
+    the docs because of missing dependencies on the machine you use to generate the docs.
+  - Naming conventions: plugin classes are named `<Module>Plugin` and backend classes are
+    named `<Module>Backend`, with `<Module>` being the (camel-case) representation of the
+    Python module of the plugin without the prefix - for example, the plugin under
+    `platypush.plugins.light.hue` must be named `LightHuePlugin`.
+
+- If possible, [add a test](https://git.platypush.tech/platypush/platypush/-/tree/master/tests)
+  for the new functionality. If you have built a new functionality that works with some specific
+  device or service then it's not required to write a test that mocks the whole service, but if
+  you are changing some of the core entities (e.g. requests, events, procedures, hooks, crons
+  or the bus) then make sure to add tests and not to break the existing tests.
+
+- If the feature requires an optional dependency then make sure to document it:
+
+  - In the class docstring (see other plugins and backends for examples)
+  - In [`setup.py`](https://git.platypush.tech/platypush/platypush/-/blob/master/setup.py#L72) as
+    an `extras_require` entry
+  - In [`requirements.txt`](https://git.platypush.tech/platypush/platypush/-/blob/master/requirements.txt) -
+    if the feature is optional then leave it commented and add a one-line comment to explain which
+    plugin or backend requires it.

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017, 2018 Fabio Manganiello
+Copyright (c) 2017, 2020 Fabio Manganiello
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -1,3 +1,2 @@
-recursive-include platypush/backend/http/static *
-recursive-include platypush/backend/http/templates *
+recursive-include platypush/backend/http/webapp/dist *
 include platypush/plugins/http/webpage/mercury-parser.js

README.md

@@ -1,67 +1,509 @@
 Platypush
 =========
 
-[![Build Status](https://travis-ci.org/BlackLight/platypush.svg?branch=master)](https://travis-ci.org/BlackLight/platypush)
-[![Documentation Status](https://readthedocs.org/projects/platypush/badge/?version=latest)](https://platypush.readthedocs.io/en/latest/?badge=latest)
+[![Build Status](https://ci.platypush.tech/status.svg)](https://ci.platypush.tech/latest.log)
+[![Documentation Status](https://ci.platypush.tech/docs/status.svg)](https://ci.platypush.tech/docs/latest.log)
 [![pip version](https://img.shields.io/pypi/v/platypush.svg?style=flat)](https://pypi.python.org/pypi/platypush/)
+[![License](https://img.shields.io/github/license/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/blob/master/LICENSE.txt)
+[![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/commits/master/)
+[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://git.platypush.tech/platypush/platypush/-/blob/master/CONTRIBUTING.md)
+[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/BlackLight/platypush.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/BlackLight/platypush/context:python)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/BlackLight/platypush.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/BlackLight/platypush/context:javascript)
 
-Advised read: [**Getting started with Platypush**](https://medium.com/@automationguru/automate-your-house-your-life-and-everything-else-around-with-platypush-dba1cd13e3f6) (Medium article).
+- Recommended read: [**Getting started with Platypush**](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush).
 
-Imagine Platypush as some kind of [IFTTT](https://ifttt.com) on steroids - or [Tasker](https://tasker.joaoapps.com/), or [Microsoft Flow](https://flow.microsoft.com), or [PushBullet](https://pushbullet.com) on steroids.
-Platypush aims to turn any device in a smart hub that can control things, interact with cloud services and send messages to other devices. It's a general-purpose lightweight platform to process any request and run any logic triggered by custom events.
+- The [blog](https://blog.platypush.tech) is in general a good place to get more insights on what you can build with it and inspiration about possible usages.
 
-Imagine the ability of running any task you like, or automate any routine you like, on any of your devices. And the flexibility of executing actions through a cloud service, with the power of running them from your laptop, Raspberry Pi, smart home device or smartphone.
+- The [wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) also contains many resources on getting started.
+
+- Extensive documentation for all the available integrations and messages [is available](https://docs.platypush.tech/).
+
+- If you have issues/feature requests/enhancement ideas please [create an issue](https://git.platypush.tech/platypush/platypush/-/issues).
+
+- A [Reddit channel](https://www.reddit.com/r/platypush) is also available for more general questions.
+
+---
+
+Platypush is a general-purpose extensible platform for automation and integration across multiple services and devices.
+
+It enables users to create their own self-hosted pieces of automation based on events (*if this happens then do that*)
+and it provides a comprehensive and customizable user interface that collects everything you need to visualize and
+control under one roof.
+
+It takes some concepts from [IFTTT](https://ifttt.com), [Tasker](https://tasker.joaoapps.com/),
+[Microsoft Flow](https://flow.microsoft.com), [PushBullet](https://pushbullet.com) and
+[Home Assistant](https://www.home-assistant.io/) to provide an environment where the user can easily connect things
+together.
+
+Its ideal home is a single-board computer like a RaspberryPi that you can configure to orchestrate any home automation
+and cloud automation in your own living room or garage, but it can easily run on any device that can run a Python
+interpreter, and the bar for the hardware requirements is very low as well - I use it to run pieces of automation on
+devices as powerful as a RaspberryPi Zero or an old Nokia N900 with Linux.
 
 You can use Platypush to do things like:
 
-- Control your smart home lights
-- Control your favourite music player
-- Interact with your voice assistant
-- Get events from your Google or Facebook calendars
-- Read data from your sensors and trigger custom events whenever they go above or below some custom thresholds
-- Control the motors of your robot
-- Send automated emails
-- Synchronize the clipboards on your devices
-- Control your smart switches
-- Implement custom text-to-speech commands
-- Build any kind of interaction with your Android device using Tasker
-- Play local videos, YouTube videos and torrent links
-- Get weather forecast for your location
+- [Control your smart home lights](https://blog.platypush.tech/article/Ultimate-self-hosted-automation-with-Platypush)
+- [Control your music and synchronize it to multiple devices](https://blog.platypush.tech/article/Build-your-open-source-multi-room-and-multi-provider-sound-server-with-Platypush-Mopidy-and-Snapcast)
+- [Create custom and privacy-secure voice assistants that run custom hooks on your phrases](https://blog.platypush.tech/article/Build-custom-voice-assistants)
+- Build integrations between [sensors](https://docs.platypush.tech/en/latest/platypush/backend/sensor.html),
+  [cameras](https://docs.platypush.tech/en/latest/platypush/plugins/camera.pi.html),
+  [microphones](https://docs.platypush.tech/en/latest/platypush/plugins/sound.html) and
+  [machine learning models](https://docs.platypush.tech/en/latest/platypush/plugins/tensorflow.html) to create smart
+  pieces of automation for e.g.
+  [people detection](https://blog.platypush.tech/article/Detect-people-with-a-RaspberryPi-a-thermal-camera-Platypush-and-a-pinch-of-machine-learning)
+  or [sound detection](https://blog.platypush.tech/article/Create-your-smart-baby-monitor-with-Platypush-and-Tensorflow)
+- [Get events from your Google or Facebook calendars](https://docs.platypush.tech/en/latest/platypush/plugins/calendar.html)
+- [Read data from your sensors and trigger custom events whenever they go above or below some custom thresholds](https://blog.platypush.tech/article/How-to-build-your-personal-infrastructure-for-data-collection-and-visualization)
+- [Control and automate a self-built robot](https://docs.platypush.tech/en/latest/platypush/plugins/gpio.zeroborg.html)
+- [Deliver automated newsletters from custom RSS digests](https://blog.platypush.tech/article/Deliver-customized-newsletters-from-RSS-feeds-with-Platypush)
+- [Synchronize the clipboards on your devices](https://docs.platypush.tech/en/latest/platypush/plugins/clipboard.html)
+- [Control your smart switches](https://docs.platypush.tech/en/latest/platypush/plugins/switch.html)
+- [Implement automated custom text-to-speech routines](https://docs.platypush.tech/en/latest/platypush/plugins/tts.html)
+- [Build any kind of interactions and automation routines with your Android device using Tasker](https://blog.platypush.tech/article/How-to-build-your-personal-infrastructure-for-data-collection-and-visualization)
+- Play [local videos](https://docs.platypush.tech/en/latest/platypush/plugins/media.mpv.html), YouTube videos and torrent media from any device and service, to any device
+- [Get weather forecast events for your location and build automation routines on them](https://docs.platypush.tech/en/latest/platypush/plugins/weather.darksky.html)
+- [Create a custom single hub for Zigbee and Z-Wave smart devices](https://blog.platypush.tech/article/Transform-a-RaspberryPi-into-a-universal-Zigbee-and-Z-Wave-bridge)
 - Build your own web dashboard with calendar, weather, news and music controls (basically, anything that has a Platypush web widget)
-- ...and much more (basically, anything that comes with a [Platypush plugin](https://platypush.readthedocs.io/en/latest/plugins.html))
+- ...and much more (basically, anything that comes with a [Platypush plugin](https://docs.platypush.tech/en/latest/plugins.html))
 
-Imagine the ability of executing all the actions above through messages delivered through:
+## Architecture
 
-- A web interface
-- A JSON-RPC API
-- Raw TCP messages
-- Web sockets
-- [PushBullet](https://pushbullet.com)
-- [Kafka](https://kafka.apache.org)
-- [Redis](https://redis.io)
-- [MQTT](https://mqtt.org)
-- ...amd much more (basically, anything that comes with a [Platypush backend](https://platypush.readthedocs.io/en/latest/backends.html))
+The architecture of Platypush consists of a few simple pieces, orchestrated by a configuration file stored by default
+under [`~/.config/platypush/config.yaml`](https://git.platypush.tech/platypush/platypush/-/blob/master/examples/conf/config.yaml):
 
-Imagine the ability of building custom event hooks to automatically trigger any actions:
+### [Plugins](https://docs.platypush.tech/en/latest/plugins.html)
 
-- When your voice assistant recognizes some text
-- When you start playing a new song
-- When a new event is added to your calendar
-- When a new article is published on your favourite feed
-- When the weather conditions change
-- When your press a [Flic button](https://flic.io) with a certain pattern
-- When you receive a new push on your Pushbullet account
-- When your GPS signal enters a certain area
-- Whenever a new MIDI event is received (yes, you heard well :) )
-- Whenever a sensor sends new data
-- At a specific date or time
-- ...and so on (basically, anything can send events that can be used to build hooks)
+They are integrations that do things - like
+[modify files](https://docs.platypush.tech/en/latest/platypush/plugins/file.html),
+[train and evaluate machine learning models](https://docs.platypush.tech/en/latest/platypush/plugins/tensorflow.html),
+[control cameras](https://docs.platypush.tech/en/latest/platypush/plugins/camera.pi.html),
+[read sensors](https://docs.platypush.tech/en/latest/platypush/plugins/gpio.sensor.dht.html),
+[parse a web page](https://docs.platypush.tech/en/latest/platypush/plugins/http.webpage.html),
+[control lights](https://docs.platypush.tech/en/latest/platypush/plugins/light.hue.html),
+[send emails](https://docs.platypush.tech/en/latest/platypush/plugins/mail.smtp.html),
+[control Chromecasts](https://docs.platypush.tech/en/latest/platypush/plugins/media.chromecast.html),
+[run voice queries](https://docs.platypush.tech/en/latest/platypush/plugins/assistant.google.html),
+[handle torrent transfers](https://docs.platypush.tech/en/latest/platypush/plugins/torrent.html) or
+control [Zigbee](https://docs.platypush.tech/en/latest/platypush/plugins/zigbee.mqtt.html) or
+[Z-Wave](https://docs.platypush.tech/en/latest/platypush/plugins/zwave.html) devices.
 
-Imagine the ability of running the application, with lots of those bundled features, on any device that can comes with Python (_only compatible with version 3.5 and higher_). Platypush has been designed with performance in mind, it's been heavily tested on slower devices like Raspberry Pis, and it can run the web server features, multiple backends and plugins quite well even on a Raspberry Pi Zero - it's even been tested with some quite impressive performance on an older [Nokia N900](https://en.wikipedia.org/wiki/Nokia_N900), and of course you can run it on any laptop, desktop, server environment. It's been developed mainly with IoT in mind (and some of its features overlap with IoT frameworks like [Mozilla IoT](https://iot.mozilla.com) and [Android Things](https://developer.android.com/things/)), but nothing prevents you from automating any task on any device and environment.
+The configuration of a plugin matches one-on-one that of its documented class constructor, so it's very straightforward
+to write a configuration for a plugin by reading its documentation:
 
-To get started:
+```yaml
+light.hue:
+  # Groups that will be controlled by default
+  groups:
+    - Living Room
+    - Hall
+```
 
-- [Wiki](https://github.com/BlackLight/platypush/wiki) for installation notes, quick start, examples and architecture reference
-- [Read the docs](https://platypush.readthedocs.io/en/latest/) for a complete reference on the available plugins and backends
-- [Medium articles](https://medium.com/tag/platypush/archive) that describe hands-on applications of platypush
+### Actions
 
+Plugins expose *actions*, that match one-on-one the plugin class methods denoted by `@action`, so it's very
+straightforward to invoke plugin actions by just reading the plugin documentation. They can be invoked directly from
+your own scripts or they can be sent to the platform through any supported channel as simple JSON messages:
+
+```json
+{
+  "type": "request",
+  "action": "light.hue.on",
+  "args": {
+    "lights": ["Entrance Bulb"]
+  }
+}
+```
+
+### [Backends](https://docs.platypush.tech/en/latest/backends.html)
+
+They are background services that either listen for messages on channels (like an
+[HTTP backend](https://docs.platypush.tech/en/latest/platypush/backend/http.html), an
+[MQTT instance](https://docs.platypush.tech/en/latest/platypush/backend/mqtt.html), a
+[Kafka instance](https://docs.platypush.tech/en/latest/platypush/backend/kafka.html), a
+[Websocket service](https://docs.platypush.tech/en/latest/platypush/backend/websocket.html),
+[Pushbullet](https://docs.platypush.tech/en/latest/platypush/backend/pushbullet.html) etc.) or monitor a device or a
+service for events (like a [sensor](https://docs.platypush.tech/en/latest/platypush/backend/sensor.html), a custom
+[voice assistant](https://docs.platypush.tech/en/latest/platypush/backend/assistant.google.html), a bridge running on a
+[Zigbee](https://docs.platypush.tech/en/latest/platypush/backend/zigbee.mqtt.html) or
+[Z-Wave](https://docs.platypush.tech/en/latest/platypush/backend/zwave.html), an
+[NFC card reader](https://docs.platypush.tech/en/latest/platypush/backend/nfc.html), a
+[MIDI device](https://docs.platypush.tech/en/latest/platypush/backend/midi.html), a
+[Telegram channel](https://docs.platypush.tech/en/latest/platypush/backend/chat.telegram.html), a
+[Bluetooth scanner](https://docs.platypush.tech/en/latest/platypush/backend/bluetooth.scanner.ble.html) etc.).
+
+If a backend supports the execution of requests (e.g. HTTP, MQTT, Kafka, Websocket and TCP) then you can send requests
+to these services in JSON format. For example, in the case of the HTTP backend:
+
+```shell
+# Get a token
+curl -XPOST -H 'Content-Type: application/json' -d '
+  {
+    "username": "$YOUR_USER",
+    "password": "$YOUR_PASSWORD"
+  }' http://host:8008/auth
+
+# Execute a request
+
+curl -XPOST -H 'Content-Type: application/json' -H "Authorization: Bearer $YOUR_TOKEN" -d '
+  {
+    "type": "request",
+    "action": "tts.say",
+    "args": {
+      "text": "This is a test"
+    }
+  }' http://host:8008/execute
+```
+
+### [Events](https://docs.platypush.tech/en/latest/events.html)
+
+When a certain event occurs (e.g. a JSON request is received, or a
+[Bluetooth device is connected](https://docs.platypush.tech/en/latest/platypush/events/bluetooth.html#platypush.message.event.bluetooth.BluetoothDeviceConnectedEvent),
+or a
+[Flic button is pressed](https://docs.platypush.tech/en/latest/platypush/events/button.flic.html#platypush.message.event.button.flic.FlicButtonEvent),
+or some
+[speech is detected on the voice assistant service](https://docs.platypush.tech/en/latest/platypush/events/assistant.html#platypush.message.event.assistant.SpeechRecognizedEvent),
+or an
+[RSS feed has new items](https://docs.platypush.tech/en/latest/platypush/events/http.rss.html#platypush.message.event.http.rss.NewFeedEvent),
+or a
+[new email is received](https://docs.platypush.tech/en/latest/platypush/events/mail.html#platypush.message.event.mail.MailReceivedEvent),
+or a
+[new track is played](https://docs.platypush.tech/en/latest/platypush/events/music.html#platypush.message.event.music.NewPlayingTrackEvent),
+or an
+[NFC tag is detected](https://docs.platypush.tech/en/latest/platypush/events/nfc.html#platypush.message.event.nfc.NFCTagDetectedEvent),
+or
+[new sensor data is available](https://docs.platypush.tech/en/latest/platypush/events/sensor.html#platypush.message.event.sensor.SensorDataChangeEvent),
+or
+[a value of a Zigbee device changes](https://docs.platypush.tech/en/latest/platypush/events/zigbee.mqtt.html#platypush.message.event.zigbee.mqtt.ZigbeeMqttDevicePropertySetEvent),
+etc.), the associated backend will trigger an [event](https://docs.platypush.tech/en/latest/events.html).
+
+### Hooks
+
+Event hooks are custom pieces of logic that will be run when a certain event is triggered. Hooks are the glue that
+connects events to actions, exposing a paradigm similar to IFTTT (_if a certain event happens then run these actions_).
+They can declared as:
+
+- Sections of the [`config.yaml`](https://git.platypush.tech/platypush/platypush/-/blob/master/examples/conf/config.yaml).
+  Example:
+
+```yaml
+event.hook.SearchSongVoiceCommand:
+  if:
+    type: platypush.message.event.assistant.SpeechRecognizedEvent
+    phrase: "play ${title} by ${artist}"
+  then:
+    - action: music.mpd.clear
+    - action: music.mpd.search
+      args:
+        filter:
+          artist: ${artist}
+          title: ${title}
+
+    - if ${len(output)}:
+      - action: music.mpd.play
+        args:
+          resource: ${output[0]['file']}
+```
+
+- Stand-alone Python scripts stored under `~/.config/platypush/scripts` and will be dynamically imported at start time.
+  [Example](https://git.platypush.tech/platypush/platypush/-/blob/master/examples/conf/hook.py):
+  
+```python
+from platypush.event.hook import hook
+from platypush.utils import run
+from platypush.message.event.assistant import SpeechRecognizedEvent
+
+@hook(SpeechRecognizedEvent, phrase='play ${title} by ${artist}')
+def on_music_play_command(event, title=None, artist=None, **context):
+  results = run('music.mpd.search', filter={
+    'artist': artist,
+    'title': title,
+  })
+
+  if results:
+    run('music.mpd.play', results[0]['file'])
+```
+
+### Procedures
+
+Procedures are pieces of custom logic that can be executed as atomic actions using `procedure.<name>` as an action name.
+They can be defined either in the `config.yaml` or as Python scripts stored under `~/.config/platypush/scripts` -
+provided that the procedure is also imported in `~/.config/platypush/scripts/__init__.py` so it can be discovered by
+the service.
+
+YAML example for a procedure that can be executed when we arrive home and turns on the lights if the luminosity is lower
+that a certain thresholds, says a welcome home message using the TTS engine and starts playing the music:
+
+```yaml
+procedure.at_home:
+    # Get luminosity data from a sensor - e.g. LTR559
+    - action: gpio.sensor.ltr559.get_data
+
+    # If it's lower than a certain threshold, turn on the lights
+    - if ${int(light or 0) < 110}:
+        - action: light.hue.on
+
+    # Say a welcome home message
+    - action: tts.google.say
+      args:
+        text: Welcome home
+
+    # Play the music
+    - action: music.mpd.play
+```
+
+Python example:
+
+```python
+# Content of ~/.config/platypush/scripts/home.py
+from platypush.procedure import procedure
+from platypush.utils import run
+
+@procedure
+def at_home(**context):
+  sensor_data = run('gpio.sensor.ltr559.get_data')
+  if sensor_data['light'] < 110:
+    run('light.hue.on')
+
+  run('tts.google.say', text='Welcome home')
+  run('music.mpd.play')
+```
+
+In either case, you can easily trigger the at-home procedure by sending an action request message to a backend - for
+example, over the HTTP backend:
+
+```shell
+curl -XPOST -H 'Content-Type: application/json' -H "Authorization: Bearer $YOUR_TOKEN" -d '
+  {
+    "type": "request",
+    "action": "procedure.at_home"
+  }' http://host:8008/execute
+```
+
+### Cronjobs
+
+Cronjobs are pieces of logic that will be run at regular intervals, expressed in crontab-compatible syntax.
+They can be defined either in the `config.yaml` or as Python scripts stored under `~/.config/platypush/scripts` as
+functions labelled by the `@cron` decorator.
+
+Note that seconds are also supported (unlike the standard crontab definition), but, for back-compatibility with the
+standard crontab format, they are at the end of the cron expression, so the expression is actually in the format
+`<minute> <hour> <day_of_month> <month> <day_of_week> <second>`.
+
+YAML example for a cronjob that is executed every 30 seconds and checks if a Bluetooth device is nearby:
+
+```yaml
+cron.check_bt_device:
+  cron_expression: '* * * * * */30'
+  actions:
+    - action: bluetooth.lookup_name
+      args:
+        addr: XX:XX:XX:XX:XX:XX
+
+    - if ${name}:
+        - action: procedure.on_device_on
+    - else:
+        - action: procedure.on_device_off
+```
+
+Python example:
+
+```python
+# Content of ~/.config/platypush/scripts/bt_cron.py
+from platypush.cron import cron
+from platypush.utils import run
+
+@cron('* * * * * */30')
+def check_bt_device(**context):
+  name = run('bluetooth.lookup_name').get('name')
+  if name:
+    # on_device_on logic here
+  else:
+    # on_device_off logic here
+```
+
+### The web interface
+
+If [`backend.http`](https://docs.platypush.tech/en/latest/platypush/backend/http.html) is enabled then a web interface
+will be provided by default on `http://host:8008/`. Besides using the `/execute` endpoint for running requests, the
+built-in web server also provides a full-featured interface that groups together the controls for most of the plugins -
+e.g. sensors, switches, music controls and search, media library and torrent management, lights, Zigbee/Z-Wave devices
+and so on. The UI is responsive and mobile-friendly.
+
+The web service also provides means for the user to create
+[custom dashboards](https://git.platypush.tech/platypush/platypush/-/blob/master/examples/conf/dashboard.xml) that can
+be used to show information from multiple sources on a large screen.
+
+## Installation
+
+### System installation
+
+Platypush uses Redis to deliver and store requests and temporary messages:
+
+```yaml
+# Example for Debian-based distributions
+[sudo] apt-get install redis-server
+
+# Enable and start the service
+[sudo] systemctl enable redis
+[sudo] systemctl start redis
+```
+
+To install the core platform:
+
+* The `pip` way:
+
+```shell
+[sudo] pip3 install platypush
+```
+
+* The sources way:
+
+```shell
+git clone https://git.platypush.tech/platypush/platypush.git
+cd platypush
+[sudo] python3 setup.py install
+```
+
+Then install the extensions that you wish to use. There are a few ways to check the dependencies required by an
+extension:
+
+#### Check their `extras` name in [`extras_require` under `setup.py`](https://git.platypush.tech/platypush/platypush/-/blob/master/setup.py#L72).
+
+If you follow this route then you can install the extra dependencies in one of the following ways:
+
+1. `pip` installation:
+
+```shell
+[sudo] pip3 install 'platypush[extra1,extra2,extra3]'
+```
+
+2. Sources installation:
+
+```shell
+cd $DIR_TO_PLATYPUSH
+[sudo] pip3 install '.[extra1,extra2,extra3]'
+```
+  
+#### Check the dependencies/installation instructions reported under the plugin/backend documentation.
+
+If you follow this route then simply run the commands listed in the plugin/backend documentation to get the dependencies
+installed.
+
+#### Check/uncomment the associated lines in [`requirements.txt`](https://git.platypush.tech/platypush/platypush/-/blob/master/requirements.txt).
+
+If you follow this route then uncomment the lines in
+[`requirements.txt`](https://git.platypush.tech/platypush/platypush/-/blob/master/requirements.txt) associated to the
+plugins/backends that you want to use and run:
+
+```shell
+[sudo] pip3 install -r requirements.txt
+```
+
+After installing the dependencies, create a configuration file under `~/.config/platypush/config.yaml` (the application
+can load the configuration from another location through the `-c` option) containing the configuration of the backend
+and plugins that you want to use, and add any hooks and procedures for your use case.
+
+You can then start the service by simply running:
+
+```shell
+platypush
+```
+
+It's advised to run it as a systemd service though - simply copy the provided
+[`.service` file](https://git.platypush.tech/platypush/platypush/-/blob/master/examples/systemd/platypush.service) to
+`~/.config/systemd/user`, check if the path of `platypush` matches the path where it's installed on your system, and
+start the service via `systemctl`:
+
+```shell
+systemctl --user start platypush
+```
+
+### [Virtual environment installation](https://git.platypush.tech/platypush/platypush/-/wikis/Run-platypush-in-a-virtual-environment)
+
+Platypush provides a script named `platyvenv` that can parse a `config.yaml` and automatically create a virtual
+environment (under `~/.local/share/platypush/venv/<device_id>`) with all the dependencies required by the configured
+integrations.
+
+1. Create the environment from a configuration file:
+
+```shell
+platyvenv build -c /path/to/config.yaml
+```
+
+2. Start the service from the virtual environment:
+
+```shell
+# device_id matches either the hostname or the device_id in config.yaml
+platyvenv start device_id
+```
+
+3. Stop the instance:
+
+```shell
+platyvenv stop device_id
+```
+
+4. Remove the instance:
+
+```shell
+platyvenv rm device_id
+```
+
+### [Docker installation](https://git.platypush.tech/platypush/platypush/-/wikis/Run-platypush-in-a-container)
+
+You can also install Platypush in a container - the application provides a script named `platydock` that automatically
+creates a container instance from a `config.yaml`:
+
+1. Create the container from a configuration file:
+
+```shell
+platydock build -c /path/to/config.yaml
+```
+
+2. Start the container:
+
+```shell
+# device_id matches either the hostname or the device_id in config.yaml
+platydock start device_id
+```
+
+3. Stop the instance:
+
+```shell
+platydock stop device_id
+```
+
+4. Remove the instance:
+
+```shell
+platydock rm device_id
+```
+
+## Mobile app
+
+An [official Android app](https://f-droid.org/en/packages/tech.platypush.platypush/) is provided on the F-Droid store.
+It allows to easily discover and manage multiple Platypush services on a network through the web interface, and it
+easily brings the power of Platypush to your fingertips.
+
+## Tests
+
+To run the tests simply run `pytest` either from the project root folder or the `tests/` folder.
+Or run the following command from the project root folder:
+
+```shell
+python -m tests
+```
+
+---
+
+## Funding
+
+If you use and love Platypush, please consider [buying me a coffee/beer](https://paypal.me/fabiomanganiello).
+
+I've been working on Platypush all by myself in my spare time for the past few years, and I've made sure that it remains
+open and free.
+
+If you like this product, please consider supporting - I'm definitely not planning to get rich with this project, but
+I'd love to have at least the costs for the server covered by users.
+
+Issues and requests opened by donors will also be given priority over others.

bin/platyvenv

@@ -119,7 +119,7 @@ EOF
         pip install ${dep}
     done
 
-    pip install --upgrade git+https://github.com/BlackLight/platypush.git
+    pip install --upgrade git+https://git.platypush.tech/platypush/platypush.git
     echo "Platypush virtual environment prepared under $envdir"
 }
 

docs/README.md

@@ -0,0 +1,21 @@
+# Platypush self-generated reference
+====================================
+
+This directory contains the Sphinx self-generated documentation for Platypush.
+
+Dependencies required to generate the documentation:
+
+```shell
+$ [sudo] pip install sphinx 'git+https://github.com/bashtage/sphinx-material.git'
+```
+
+To generate the HTML documentation:
+
+```shell
+$ make html
+```
+
+The output will be generated under `build/html`.
+
+Type `make` with no additional arguments to get a full list of the supported output formats.
+

docs/source/_ext/sphinx_marshmallow.py

@@ -0,0 +1,59 @@
+import importlib
+import json
+import os
+import re
+import sys
+from typing import Union, List
+
+from docutils import nodes
+from docutils.parsers.rst import Directive
+
+
+class SchemaDirective(Directive):
+    """
+    Support for response/message schemas in the docs. Format: ``.. schema:: rel_path.SchemaClass(arg1=value1, ...)``,
+    where ``rel_path`` is the path of the schema relative to ``platypush/schemas``.
+    """
+    has_content = True
+    _schema_regex = re.compile(r'^\s*(.+?)\s*(\((.+?)\))?\s*$')
+    _schemas_path = os.path.abspath(
+        os.path.join(
+            os.path.dirname(os.path.relpath(__file__)), '..', '..', '..', 'platypush', 'schemas'))
+
+    sys.path.insert(0, _schemas_path)
+
+    @staticmethod
+    def _get_field_value(field) -> str:
+        metadata = getattr(field, 'metadata', {})
+        return metadata.get('example', metadata.get('description', str(field.__class__.__name__).lower()))
+
+    def _parse_schema(self) -> Union[dict, List[dict]]:
+        m = self._schema_regex.match('\n'.join(self.content))
+        schema_module_name = '.'.join(['platypush.schemas', *(m.group(1).split('.')[:-1])])
+        schema_module = importlib.import_module(schema_module_name)
+        schema_class = getattr(schema_module, m.group(1).split('.')[-1])
+        schema_args = eval(f'dict({m.group(3)})')
+        schema = schema_class(**schema_args)
+        output = {
+            name: self._get_field_value(field)
+            for name, field in schema.fields.items()
+            if not field.load_only
+        }
+
+        return [output] if schema.many else output
+
+    def run(self):
+        content = json.dumps(self._parse_schema(), sort_keys=True, indent=2)
+        block = nodes.literal_block(content, content)
+        block['language'] = 'json'
+        return [block]
+
+
+def setup(app):
+    app.add_directive('schema', SchemaDirective)
+
+    return {
+        'version': '0.1',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

docs/source/backends.rst

@@ -7,14 +7,24 @@ Backends
     :caption: Backends:
 
     platypush/backend/adafruit.io.rst
+    platypush/backend/alarm.rst
+    platypush/backend/assistant.rst
     platypush/backend/assistant.google.rst
     platypush/backend/assistant.snowboy.rst
     platypush/backend/bluetooth.rst
     platypush/backend/bluetooth.fileserver.rst
     platypush/backend/bluetooth.pushserver.rst
+    platypush/backend/bluetooth.scanner.rst
+    platypush/backend/bluetooth.scanner.ble.rst
     platypush/backend/button.flic.rst
     platypush/backend/camera.pi.rst
     platypush/backend/chat.telegram.rst
+    platypush/backend/clipboard.rst
+    platypush/backend/covid19.rst
+    platypush/backend/dbus.rst
+    platypush/backend/file.monitor.rst
+    platypush/backend/foursquare.rst
+    platypush/backend/github.rst
     platypush/backend/google.fit.rst
     platypush/backend/google.pubsub.rst
     platypush/backend/gps.rst
@@ -22,14 +32,20 @@ Backends
     platypush/backend/http.poll.rst
     platypush/backend/inotify.rst
     platypush/backend/joystick.rst
+    platypush/backend/joystick.jstest.rst
+    platypush/backend/joystick.linux.rst
     platypush/backend/kafka.rst
     platypush/backend/light.hue.rst
-    platypush/backend/local.rst
+    platypush/backend/linode.rst
+    platypush/backend/log.http.rst
+    platypush/backend/mail.rst
     platypush/backend/midi.rst
     platypush/backend/mqtt.rst
     platypush/backend/music.mopidy.rst
     platypush/backend/music.mpd.rst
     platypush/backend/music.snapcast.rst
+    platypush/backend/music.spotify.connect.rst
+    platypush/backend/nextcloud.rst
     platypush/backend/nfc.rst
     platypush/backend/nodered.rst
     platypush/backend/ping.rst
@@ -38,18 +54,33 @@ Backends
     platypush/backend/scard.rst
     platypush/backend/sensor.rst
     platypush/backend/sensor.accelerometer.rst
+    platypush/backend/sensor.arduino.rst
+    platypush/backend/sensor.battery.rst
     platypush/backend/sensor.bme280.rst
+    platypush/backend/sensor.dht.rst
     platypush/backend/sensor.distance.rst
     platypush/backend/sensor.distance.vl53l1x.rst
     platypush/backend/sensor.envirophat.rst
     platypush/backend/sensor.ir.zeroborg.rst
+    platypush/backend/sensor.leap.rst
     platypush/backend/sensor.ltr559.rst
     platypush/backend/sensor.mcp3008.rst
     platypush/backend/sensor.motion.pwm3901.rst
     platypush/backend/sensor.serial.rst
+    platypush/backend/stt.rst
+    platypush/backend/stt.deepspeech.rst
+    platypush/backend/stt.picovoice.hotword.rst
+    platypush/backend/stt.picovoice.speech.rst
     platypush/backend/tcp.rst
     platypush/backend/todoist.rst
+    platypush/backend/travisci.rst
+    platypush/backend/trello.rst
+    platypush/backend/weather.rst
     platypush/backend/weather.buienradar.rst
     platypush/backend/weather.darksky.rst
+    platypush/backend/weather.openweathermap.rst
     platypush/backend/websocket.rst
     platypush/backend/wiimote.rst
+    platypush/backend/zigbee.mqtt.rst
+    platypush/backend/zwave.rst
+    platypush/backend/zwave.mqtt.rst

docs/source/conf.py

@@ -18,13 +18,14 @@ import sys
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("./_ext"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'platypush'
-copyright = '2018, BlackLight'
-author = 'BlackLight'
+project = 'Platypush'
+copyright = '2017-2021, Fabio Manganiello'
+author = 'Fabio Manganiello'
 
 # The short X.Y version
 version = ''
@@ -49,6 +50,8 @@ extensions = [
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
+    'sphinx_rtd_theme',
+    'sphinx_marshmallow',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -84,8 +87,9 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'alabaster'
-html_theme = 'nature'
+# html_theme = 'haiku'
+# html_theme = 'sphinx_rtd_theme'
+html_theme = 'sphinx_material'
 
 html_domain_indices = True
 
@@ -93,12 +97,57 @@ html_domain_indices = True
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'nav_title': 'Platypush documentation',
+    'repo_url': 'https://git.platypush.tech/platypush/platypush',
+    'repo_name': 'Source code',
+    'repo_type': 'gitlab',
+    'color_primary': 'green',
+    'color_accent': 'light-green',
+    'logo_icon': '&#128366',
+    'nav_links': [
+        {
+            'href': 'https://platypush.tech/',
+            'title': 'Homepage',
+            'internal': False,
+        },
+        {
+            'href': 'https://blog.platypush.tech/',
+            'title': 'Blog',
+            'internal': False,
+        },
+        {
+            'href': 'https://git.platypush.tech/platypush/platypush',
+            'title': 'Repository',
+            'internal': False,
+        },
+        {
+            'href': 'https://git.platypush.tech/platypush/platypush/-/wikis/home',
+            'title': 'Wiki',
+            'internal': False,
+        },
+        {
+            'href': 'https://chrome.google.com/webstore/detail/platypush/aphldjclndofhflbbdnmpejbjgomkbie',
+            'title': 'Chrome Extension',
+            'internal': False,
+        },
+        {
+            'href': 'https://addons.mozilla.org/en-US/firefox/addon/platypush/',
+            'title': 'Firefox Extension',
+            'internal': False,
+        },
+        {
+            'href': 'https://f-droid.org/en/packages/tech.platypush.platypush/',
+            'title': 'Android App',
+            'internal': False,
+        },
+    ],
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -108,8 +157,9 @@ html_static_path = ['_static']
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
 #
-# html_sidebars = {}
-
+html_sidebars = {
+    '**': ['logo-text.html', 'globaltoc.html', 'localtoc.html', 'searchbox.html']
+}
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -233,6 +283,38 @@ autodoc_mock_imports = ['googlesamples.assistant.grpc.audio_helpers',
                         'trello',
                         'telegram',
                         'telegram.ext',
+                        'pyfirmata2',
+                        'cups',
+                        'graphyte',
+                        'cpuinfo',
+                        'psutil',
+                        'openzwave',
+                        'deepspeech',
+                        'wave',
+                        'pvporcupine ',
+                        'pvcheetah',
+                        'pyotp',
+                        'linode_api4',
+                        'pyzbar',
+                        'tensorflow',
+                        'keras',
+                        'pandas',
+                        'samsungtvws',
+                        'paramiko',
+                        'luma',
+                        'zeroconf',
+                        'dbus',
+                        'gi',
+                        'gi.repository',
+                        'twilio',
+                        'pytz',
+                        'Adafruit_Python_DHT',
+                        'RPi.GPIO',
+                        'RPLCD',
+                        'imapclient',
+                        'pysmartthings',
+                        'aiohttp',
+                        'watchdog',
                         ]
 
 sys.path.insert(0, os.path.abspath('../..'))
@@ -245,3 +327,5 @@ def skip(app, what, name, obj, skip, options):
 def setup(app):
     app.connect("autodoc-skip-member", skip)
 
+
+# vim:sw=4:ts=4:et:

docs/source/events.rst

@@ -6,36 +6,46 @@ Events
     :maxdepth: 2
     :caption: Events:
 
-    platypush/events/.rst
     platypush/events/adafruit.rst
+    platypush/events/alarm.rst
     platypush/events/application.rst
     platypush/events/assistant.rst
     platypush/events/bluetooth.rst
     platypush/events/button.flic.rst
     platypush/events/camera.rst
     platypush/events/chat.telegram.rst
+    platypush/events/clipboard.rst
+    platypush/events/covid19.rst
+    platypush/events/custom.rst
     platypush/events/distance.rst
+    platypush/events/file.rst
+    platypush/events/foursquare.rst
     platypush/events/geo.rst
+    platypush/events/github.rst
     platypush/events/google.rst
     platypush/events/google.fit.rst
     platypush/events/google.pubsub.rst
     platypush/events/gps.rst
     platypush/events/http.rst
     platypush/events/http.hook.rst
-    platypush/events/http.ota.booking.rst
     platypush/events/http.rss.rst
+    platypush/events/inotify.rst
     platypush/events/joystick.rst
     platypush/events/kafka.rst
     platypush/events/light.rst
+    platypush/events/linode.rst
+    platypush/events/log.http.rst
+    platypush/events/mail.rst
     platypush/events/media.rst
     platypush/events/midi.rst
     platypush/events/mqtt.rst
     platypush/events/music.rst
     platypush/events/music.snapcast.rst
+    platypush/events/nextcloud.rst
     platypush/events/nfc.rst
-    platypush/events/path.rst
     platypush/events/ping.rst
     platypush/events/pushbullet.rst
+    platypush/events/qrcode.rst
     platypush/events/scard.rst
     platypush/events/sensor.rst
     platypush/events/sensor.ir.rst
@@ -43,11 +53,18 @@ Events
     platypush/events/sensor.light.rst
     platypush/events/serial.rst
     platypush/events/sound.rst
+    platypush/events/stt.rst
+    platypush/events/tensorflow.rst
     platypush/events/todoist.rst
     platypush/events/torrent.rst
+    platypush/events/travisci.rst
+    platypush/events/trello.rst
     platypush/events/video.rst
     platypush/events/weather.rst
     platypush/events/web.rst
     platypush/events/web.widget.rst
     platypush/events/wiimote.rst
     platypush/events/zeroborg.rst
+    platypush/events/zeroconf.rst
+    platypush/events/zigbee.mqtt.rst
+    platypush/events/zwave.rst

docs/source/index.rst

@@ -5,11 +5,13 @@ Welcome to the Platypush reference of available plugins, backends and event type
 
 For more information on Platypush please check out:
 
-* The `GitHub page`_ of the project
+* The `Gitlab page`_ of the project
 * The `online wiki`_ for quickstart and examples
+* The `Blog articles`_ for inspiration on use-cases possible projects
 
-.. _GitHub page: https://github.com/BlackLight/platypush
-.. _online wiki: https://github.com/BlackLight/platypush/wiki
+.. _Gitlab page: https://git.platypush.tech/platypush/platypush
+.. _online wiki: https://git.platypush.tech/platypush/platypush/-/wikis/home
+.. _Blog articles: https://blog.platypush.tech
 
 .. toctree::
     :maxdepth: 3
@@ -18,6 +20,7 @@ For more information on Platypush please check out:
     backends
     plugins
     events
+    responses
 
 Indices and tables
 ==================

docs/source/platypush/backend.rst

@@ -1,6 +0,0 @@
-``platypush.backend``
-=====================
-
-.. automodule:: platypush.backend
-    :members:
-

docs/source/platypush/backend/alarm.rst

@@ -0,0 +1,5 @@
+``platypush.backend.alarm``
+===========================
+
+.. automodule:: platypush.backend.alarm
+    :members:

docs/source/platypush/backend/assistant.rst

@@ -0,0 +1,5 @@
+``platypush.backend.assistant``
+===============================
+
+.. automodule:: platypush.backend.assistant
+    :members:

docs/source/platypush/backend/bluetooth.scanner.ble.rst

@@ -0,0 +1,5 @@
+``platypush.backend.bluetooth.scanner.ble``
+===========================================
+
+.. automodule:: platypush.backend.bluetooth.scanner.ble
+    :members:

docs/source/platypush/backend/bluetooth.scanner.rst

@@ -0,0 +1,5 @@
+``platypush.backend.bluetooth.scanner``
+=======================================
+
+.. automodule:: platypush.backend.bluetooth.scanner
+    :members:

docs/source/platypush/backend/camera.rst

@@ -1,6 +0,0 @@
-``platypush.backend.camera``
-============================
-
-.. automodule:: platypush.backend.camera
-    :members:
-

docs/source/platypush/backend/clipboard.rst

@@ -0,0 +1,5 @@
+``platypush.backend.clipboard``
+===============================
+
+.. automodule:: platypush.backend.clipboard
+    :members:

docs/source/platypush/backend/covid19.rst

@@ -0,0 +1,5 @@
+``platypush.backend.covid19``
+=============================
+
+.. automodule:: platypush.backend.covid19
+    :members:

docs/source/platypush/backend/dbus.rst

@@ -0,0 +1,5 @@
+``platypush.backend.dbus``
+==========================
+
+.. automodule:: platypush.backend.dbus
+    :members:

docs/source/platypush/backend/file.monitor.rst

@@ -0,0 +1,5 @@
+``platypush.backend.file.monitor``
+==================================
+
+.. automodule:: platypush.backend.file.monitor
+    :members:

docs/source/platypush/backend/foursquare.rst

@@ -0,0 +1,5 @@
+``platypush.backend.foursquare``
+================================
+
+.. automodule:: platypush.backend.foursquare
+    :members:

docs/source/platypush/backend/github.rst

@@ -0,0 +1,5 @@
+``platypush.backend.github``
+============================
+
+.. automodule:: platypush.backend.github
+    :members:

docs/source/platypush/backend/http.request.rss.rst

@@ -1,6 +0,0 @@
-``platypush.backend.http.request.rss``
-======================================
-
-.. automodule:: platypush.backend.http.request.rss
-    :members:
-

docs/source/platypush/backend/joystick.jstest.rst

@@ -0,0 +1,5 @@
+``platypush.backend.joystick.jstest``
+=====================================
+
+.. automodule:: platypush.backend.joystick.jstest
+    :members:

docs/source/platypush/backend/joystick.linux.rst

@@ -0,0 +1,5 @@
+``platypush.backend.joystick.linux``
+====================================
+
+.. automodule:: platypush.backend.joystick.linux
+    :members:

docs/source/platypush/backend/linode.rst

@@ -0,0 +1,5 @@
+``platypush.backend.linode``
+============================
+
+.. automodule:: platypush.backend.linode
+    :members:

docs/source/platypush/backend/local.rst

@@ -1,5 +0,0 @@
-``platypush.backend.local``
-===========================
-
-.. automodule:: platypush.backend.local
-    :members:

docs/source/platypush/backend/log.http.rst

@@ -0,0 +1,5 @@
+``platypush.backend.log.http``
+==============================
+
+.. automodule:: platypush.backend.log.http
+    :members:

docs/source/platypush/backend/mail.rst

@@ -0,0 +1,5 @@
+``platypush.backend.mail``
+==========================
+
+.. automodule:: platypush.backend.mail
+    :members:

docs/source/platypush/backend/music.spotify.connect.rst

@@ -0,0 +1,5 @@
+``platypush.backend.music.spotify.connect``
+===========================================
+
+.. automodule:: platypush.backend.music.spotify.connect
+    :members:

docs/source/platypush/backend/nextcloud.rst

@@ -0,0 +1,5 @@
+``platypush.backend.nextcloud``
+===============================
+
+.. automodule:: platypush.backend.nextcloud
+    :members:

docs/source/platypush/backend/sensor.arduino.rst

@@ -0,0 +1,5 @@
+``platypush.backend.sensor.arduino``
+====================================
+
+.. automodule:: platypush.backend.sensor.arduino
+    :members:

docs/source/platypush/backend/sensor.battery.rst

@@ -0,0 +1,5 @@
+``platypush.backend.sensor.battery``
+====================================
+
+.. automodule:: platypush.backend.sensor.battery
+    :members:

docs/source/platypush/backend/sensor.dht.rst

@@ -0,0 +1,5 @@
+``platypush.backend.sensor.dht``
+================================
+
+.. automodule:: platypush.backend.sensor.dht
+    :members:

docs/source/platypush/backend/stt.deepspeech.rst

@@ -0,0 +1,5 @@
+``platypush.backend.stt.deepspeech``
+====================================
+
+.. automodule:: platypush.backend.stt.deepspeech
+    :members:

docs/source/platypush/backend/stt.picovoice.hotword.rst

@@ -0,0 +1,5 @@
+``platypush.backend.stt.picovoice.hotword``
+===========================================
+
+.. automodule:: platypush.backend.stt.picovoice.hotword
+    :members:

docs/source/platypush/backend/stt.picovoice.speech.rst

@@ -0,0 +1,5 @@
+``platypush.backend.stt.picovoice.speech``
+==========================================
+
+.. automodule:: platypush.backend.stt.picovoice.speech
+    :members:

docs/source/platypush/backend/stt.rst

@@ -0,0 +1,5 @@
+``platypush.backend.stt``
+=========================
+
+.. automodule:: platypush.backend.stt
+    :members:

docs/source/platypush/backend/travisci.rst

@@ -0,0 +1,5 @@
+``platypush.backend.travisci``
+==============================
+
+.. automodule:: platypush.backend.travisci
+    :members:

docs/source/platypush/backend/trello.rst

@@ -0,0 +1,5 @@
+``platypush.backend.trello``
+============================
+
+.. automodule:: platypush.backend.trello
+    :members:

docs/source/platypush/backend/weather.forecast.rst

@@ -1,6 +0,0 @@
-``platypush.backend.weather.forecast``
-======================================
-
-.. automodule:: platypush.backend.weather.forecast
-    :members:
-

docs/source/platypush/backend/weather.openweathermap.rst

@@ -0,0 +1,5 @@
+``platypush.backend.weather.openweathermap``
+============================================
+
+.. automodule:: platypush.backend.weather.openweathermap
+    :members:

docs/source/platypush/backend/weather.rst

@@ -0,0 +1,5 @@
+``platypush.backend.weather``
+=============================
+
+.. automodule:: platypush.backend.weather
+    :members:

docs/source/platypush/backend/zigbee.mqtt.rst

@@ -0,0 +1,5 @@
+``platypush.backend.zigbee.mqtt``
+=================================
+
+.. automodule:: platypush.backend.zigbee.mqtt
+    :members:

docs/source/platypush/backend/zwave.mqtt.rst

@@ -0,0 +1,5 @@
+``platypush.backend.zwave.mqtt``
+================================
+
+.. automodule:: platypush.backend.zwave.mqtt
+    :members:

docs/source/platypush/backend/zwave.rst

@@ -0,0 +1,5 @@
+``platypush.backend.zwave``
+===========================
+
+.. automodule:: platypush.backend.zwave
+    :members:

docs/source/platypush/events/.rst

@@ -1,5 +0,0 @@
-``platypush.message.event``
-===========================
-
-.. automodule:: platypush.message.event
-    :members:

docs/source/platypush/events/alarm.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.alarm``
+=================================
+
+.. automodule:: platypush.message.event.alarm
+    :members:

docs/source/platypush/events/clipboard.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.clipboard``
+=====================================
+
+.. automodule:: platypush.message.event.clipboard
+    :members:

docs/source/platypush/events/covid19.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.covid19``
+===================================
+
+.. automodule:: platypush.message.event.covid19
+    :members:

docs/source/platypush/events/custom.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.custom``
+==================================
+
+.. automodule:: platypush.message.event.custom
+    :members:

docs/source/platypush/events/file.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.file``
+================================
+
+.. automodule:: platypush.message.event.file
+    :members:

docs/source/platypush/events/foursquare.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.foursquare``
+======================================
+
+.. automodule:: platypush.message.event.foursquare
+    :members:

docs/source/platypush/events/github.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.github``
+==================================
+
+.. automodule:: platypush.message.event.github
+    :members:

docs/source/platypush/events/http.ota.booking.rst

@@ -1,5 +0,0 @@
-``platypush.message.event.http.ota.booking``
-============================================
-
-.. automodule:: platypush.message.event.http.ota.booking
-    :members:

docs/source/platypush/events/inotify.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.inotify``
+===================================
+
+.. automodule:: platypush.message.event.inotify
+    :members:

docs/source/platypush/events/linode.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.linode``
+==================================
+
+.. automodule:: platypush.message.event.linode
+    :members:

docs/source/platypush/events/log.http.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.log.http``
+====================================
+
+.. automodule:: platypush.message.event.log.http
+    :members:

docs/source/platypush/events/mail.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.mail``
+================================
+
+.. automodule:: platypush.message.event.mail
+    :members:

docs/source/platypush/events/nextcloud.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.nextcloud``
+=====================================
+
+.. automodule:: platypush.message.event.nextcloud
+    :members:

docs/source/platypush/events/path.rst

@@ -1,6 +0,0 @@
-``platypush.message.event.path``
-================================
-
-.. automodule:: platypush.message.event.path
-    :members:
-

docs/source/platypush/events/qrcode.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.qrcode``
+==================================
+
+.. automodule:: platypush.message.event.qrcode
+    :members:

docs/source/platypush/events/stt.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.stt``
+===============================
+
+.. automodule:: platypush.message.event.stt
+    :members:

docs/source/platypush/events/tensorflow.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.tensorflow``
+======================================
+
+.. automodule:: platypush.message.event.tensorflow
+    :members:

docs/source/platypush/events/travisci.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.travisci``
+====================================
+
+.. automodule:: platypush.message.event.travisci
+    :members:

docs/source/platypush/events/trello.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.trello``
+==================================
+
+.. automodule:: platypush.message.event.trello
+    :members:

docs/source/platypush/events/zeroconf.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.zeroconf``
+====================================
+
+.. automodule:: platypush.message.event.zeroconf
+    :members:

docs/source/platypush/events/zigbee.mqtt.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.zigbee.mqtt``
+=======================================
+
+.. automodule:: platypush.message.event.zigbee.mqtt
+    :members:

docs/source/platypush/events/zwave.rst

@@ -0,0 +1,5 @@
+``platypush.message.event.zwave``
+=================================
+
+.. automodule:: platypush.message.event.zwave
+    :members:

docs/source/platypush/plugins/alarm.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.alarm``
+===========================
+
+.. automodule:: platypush.plugins.alarm
+    :members:

docs/source/platypush/plugins/arduino.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.arduino``
+=============================
+
+.. automodule:: platypush.plugins.arduino
+    :members:

docs/source/platypush/plugins/camera.cv.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.camera.cv``
+===============================
+
+.. automodule:: platypush.plugins.camera.cv
+    :members:

docs/source/platypush/plugins/camera.ffmpeg.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.camera.ffmpeg``
+===================================
+
+.. automodule:: platypush.plugins.camera.ffmpeg
+    :members:

docs/source/platypush/plugins/camera.gstreamer.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.camera.gstreamer``
+======================================
+
+.. automodule:: platypush.plugins.camera.gstreamer
+    :members:

docs/source/platypush/plugins/config.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.config``
+============================
+
+.. automodule:: platypush.plugins.config
+    :members:

docs/source/platypush/plugins/covid19.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.covid19``
+=============================
+
+.. automodule:: platypush.plugins.covid19
+    :members:

docs/source/platypush/plugins/csv.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.csv``
+=========================
+
+.. automodule:: platypush.plugins.csv
+    :members:

docs/source/platypush/plugins/dbus.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.dbus``
+==========================
+
+.. automodule:: platypush.plugins.dbus
+    :members:

docs/source/platypush/plugins/esp.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.esp``
+=========================
+
+.. automodule:: platypush.plugins.esp
+    :members:

docs/source/platypush/plugins/ffmpeg.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.ffmpeg``
+============================
+
+.. automodule:: platypush.plugins.ffmpeg
+    :members:

docs/source/platypush/plugins/foursquare.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.foursquare``
+================================
+
+.. automodule:: platypush.plugins.foursquare
+    :members:

docs/source/platypush/plugins/google.credentials.rst

@@ -1,6 +0,0 @@
-``platypush.plugins.google.credentials``
-========================================
-
-.. automodule:: platypush.plugins.google.credentials
-    :members:
-

docs/source/platypush/plugins/google.drive.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.google.drive``
+==================================
+
+.. automodule:: platypush.plugins.google.drive
+    :members:

docs/source/platypush/plugins/google.translate.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.google.translate``
+======================================
+
+.. automodule:: platypush.plugins.google.translate
+    :members:

docs/source/platypush/plugins/gpio.sensor.dht.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.gpio.sensor.dht``
+=====================================
+
+.. automodule:: platypush.plugins.gpio.sensor.dht
+    :members:

docs/source/platypush/plugins/graphite.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.graphite``
+==============================
+
+.. automodule:: platypush.plugins.graphite
+    :members:

docs/source/platypush/plugins/http.request.ota.booking.rst

@@ -1,5 +0,0 @@
-``platypush.plugins.http.request.ota.booking``
-==============================================
-
-.. automodule:: platypush.plugins.http.request.ota.booking
-    :members:

docs/source/platypush/plugins/lcd.gpio.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.lcd.gpio``
+==============================
+
+.. automodule:: platypush.plugins.lcd.gpio
+    :members:

docs/source/platypush/plugins/lcd.i2c.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.lcd.i2c``
+=============================
+
+.. automodule:: platypush.plugins.lcd.i2c
+    :members:

docs/source/platypush/plugins/lcd.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.lcd``
+=========================
+
+.. automodule:: platypush.plugins.lcd
+    :members:

docs/source/platypush/plugins/linode.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.linode``
+============================
+
+.. automodule:: platypush.plugins.linode
+    :members:

docs/source/platypush/plugins/luma.oled.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.luma.oled``
+===============================
+
+.. automodule:: platypush.plugins.luma.oled
+    :members:

docs/source/platypush/plugins/mail.imap.rst

@@ -0,0 +1,5 @@
+``platypush.plugins.mail.imap``
+===============================
+
+.. automodule:: platypush.plugins.mail.imap
+    :members: