diff --git a/docs/source/backends.rst b/docs/source/backends.rst
index 5ab4efb7..0fc9495d 100644
--- a/docs/source/backends.rst
+++ b/docs/source/backends.rst
@@ -7,14 +7,17 @@ Backends
platypush/backend.rst
platypush/backend/adafruit.io.rst
- platypush/backend/assistant.google.pushtotalk.rst
platypush/backend/assistant.google.rst
platypush/backend/assistant.snowboy.rst
platypush/backend/button.flic.rst
+ platypush/backend/camera.rst
platypush/backend/camera.pi.rst
- platypush/backend/http.poll.rst
+ platypush/backend/google.fit.rst
platypush/backend/http.rst
+ platypush/backend/http.poll.rst
+ platypush/backend/http.request.rss.rst
platypush/backend/inotify.rst
+ platypush/backend/joystick.rst
platypush/backend/kafka.rst
platypush/backend/light.hue.rst
platypush/backend/midi.rst
@@ -22,6 +25,7 @@ Backends
platypush/backend/music.mopidy.rst
platypush/backend/music.mpd.rst
platypush/backend/music.snapcast.rst
+ platypush/backend/nfc.rst
platypush/backend/pushbullet.rst
platypush/backend/redis.rst
platypush/backend/scard.rst
@@ -35,3 +39,4 @@ Backends
platypush/backend/weather.forecast.rst
platypush/backend/websocket.rst
platypush/backend/wiimote.rst
+
diff --git a/docs/source/events.rst b/docs/source/events.rst
index c28d6bbf..a1125b10 100644
--- a/docs/source/events.rst
+++ b/docs/source/events.rst
@@ -11,22 +11,26 @@ Events
platypush/events/button.flic.rst
platypush/events/camera.rst
platypush/events/geo.rst
- platypush/events/http.rss.rst
+ platypush/events/google.fit.rst
platypush/events/http.rst
+ platypush/events/http.hook.rst
+ platypush/events/http.rss.rst
platypush/events/joystick.rst
platypush/events/kafka.rst
platypush/events/light.rst
+ platypush/events/media.rst
platypush/events/midi.rst
platypush/events/music.rst
platypush/events/music.snapcast.rst
+ platypush/events/nfc.rst
platypush/events/path.rst
platypush/events/ping.rst
platypush/events/pushbullet.rst
platypush/events/scard.rst
+ platypush/events/sensor.rst
platypush/events/sensor.ir.rst
platypush/events/sensor.leap.rst
platypush/events/sensor.light.rst
- platypush/events/sensor.rst
platypush/events/serial.rst
platypush/events/sound.rst
platypush/events/torrent.rst
@@ -34,3 +38,5 @@ Events
platypush/events/weather.rst
platypush/events/web.rst
platypush/events/web.widget.rst
+ platypush/events/wiimote.rst
+
diff --git a/docs/source/platypush/backend/assistant.google.pushtotalk.rst b/docs/source/platypush/backend/assistant.google.pushtotalk.rst
deleted file mode 100644
index 21634b90..00000000
--- a/docs/source/platypush/backend/assistant.google.pushtotalk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``platypush.backend.assistant.google.pushtotalk``
-=================================================
-
-.. automodule:: platypush.backend.assistant.google.pushtotalk
- :members:
-
diff --git a/docs/source/platypush/backend/camera.rst b/docs/source/platypush/backend/camera.rst
new file mode 100644
index 00000000..9c2ec180
--- /dev/null
+++ b/docs/source/platypush/backend/camera.rst
@@ -0,0 +1,6 @@
+``platypush.backend.camera``
+============================
+
+.. automodule:: platypush.backend.camera
+ :members:
+
diff --git a/docs/source/platypush/backend/google.fit.rst b/docs/source/platypush/backend/google.fit.rst
new file mode 100644
index 00000000..eb531293
--- /dev/null
+++ b/docs/source/platypush/backend/google.fit.rst
@@ -0,0 +1,6 @@
+``platypush.backend.google.fit``
+================================
+
+.. automodule:: platypush.backend.google.fit
+ :members:
+
diff --git a/docs/source/platypush/backend/http.media.__init__.rst b/docs/source/platypush/backend/http.media.__init__.rst
deleted file mode 100644
index e6d40169..00000000
--- a/docs/source/platypush/backend/http.media.__init__.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``platypush.backend.http.media.__init__``
-=========================================
-
-.. automodule:: platypush.backend.http.media.__init__
- :members:
-
diff --git a/docs/source/platypush/backend/http.media.handlers.__init__.rst b/docs/source/platypush/backend/http.media.handlers.__init__.rst
deleted file mode 100644
index 97204b60..00000000
--- a/docs/source/platypush/backend/http.media.handlers.__init__.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``platypush.backend.http.media.handlers.__init__``
-==================================================
-
-.. automodule:: platypush.backend.http.media.handlers.__init__
- :members:
-
diff --git a/docs/source/platypush/backend/http.media.handlers.file.rst b/docs/source/platypush/backend/http.media.handlers.file.rst
deleted file mode 100644
index f7fc325f..00000000
--- a/docs/source/platypush/backend/http.media.handlers.file.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``platypush.backend.http.media.handlers.file``
-==============================================
-
-.. automodule:: platypush.backend.http.media.handlers.file
- :members:
-
diff --git a/docs/source/platypush/backend/http.request.rss.rst b/docs/source/platypush/backend/http.request.rss.rst
new file mode 100644
index 00000000..da97d58a
--- /dev/null
+++ b/docs/source/platypush/backend/http.request.rss.rst
@@ -0,0 +1,6 @@
+``platypush.backend.http.request.rss``
+======================================
+
+.. automodule:: platypush.backend.http.request.rss
+ :members:
+
diff --git a/docs/source/platypush/backend/joystick.rst b/docs/source/platypush/backend/joystick.rst
new file mode 100644
index 00000000..946a5ebe
--- /dev/null
+++ b/docs/source/platypush/backend/joystick.rst
@@ -0,0 +1,6 @@
+``platypush.backend.joystick``
+==============================
+
+.. automodule:: platypush.backend.joystick
+ :members:
+
diff --git a/docs/source/platypush/backend/nfc.rst b/docs/source/platypush/backend/nfc.rst
new file mode 100644
index 00000000..56b26616
--- /dev/null
+++ b/docs/source/platypush/backend/nfc.rst
@@ -0,0 +1,6 @@
+``platypush.backend.nfc``
+=========================
+
+.. automodule:: platypush.backend.nfc
+ :members:
+
diff --git a/docs/source/platypush/events/google.fit.rst b/docs/source/platypush/events/google.fit.rst
new file mode 100644
index 00000000..f32c72dd
--- /dev/null
+++ b/docs/source/platypush/events/google.fit.rst
@@ -0,0 +1,6 @@
+``platypush.message.event.google.fit``
+======================================
+
+.. automodule:: platypush.message.event.google.fit
+ :members:
+
diff --git a/docs/source/platypush/events/http.hook.rst b/docs/source/platypush/events/http.hook.rst
new file mode 100644
index 00000000..ed51d6e8
--- /dev/null
+++ b/docs/source/platypush/events/http.hook.rst
@@ -0,0 +1,6 @@
+``platypush.message.event.http.hook``
+=====================================
+
+.. automodule:: platypush.message.event.http.hook
+ :members:
+
diff --git a/docs/source/platypush/events/media.rst b/docs/source/platypush/events/media.rst
new file mode 100644
index 00000000..00f4acf0
--- /dev/null
+++ b/docs/source/platypush/events/media.rst
@@ -0,0 +1,6 @@
+``platypush.message.event.media``
+=================================
+
+.. automodule:: platypush.message.event.media
+ :members:
+
diff --git a/docs/source/platypush/events/nfc.rst b/docs/source/platypush/events/nfc.rst
new file mode 100644
index 00000000..aefea791
--- /dev/null
+++ b/docs/source/platypush/events/nfc.rst
@@ -0,0 +1,6 @@
+``platypush.message.event.nfc``
+===============================
+
+.. automodule:: platypush.message.event.nfc
+ :members:
+
diff --git a/docs/source/platypush/events/wiimote.rst b/docs/source/platypush/events/wiimote.rst
new file mode 100644
index 00000000..f984017c
--- /dev/null
+++ b/docs/source/platypush/events/wiimote.rst
@@ -0,0 +1,6 @@
+``platypush.message.event.wiimote``
+===================================
+
+.. automodule:: platypush.message.event.wiimote
+ :members:
+
diff --git a/docs/source/platypush/plugins/google.credentials.rst b/docs/source/platypush/plugins/google.credentials.rst
new file mode 100644
index 00000000..6e485869
--- /dev/null
+++ b/docs/source/platypush/plugins/google.credentials.rst
@@ -0,0 +1,6 @@
+``platypush.plugins.google.credentials``
+========================================
+
+.. automodule:: platypush.plugins.google.credentials
+ :members:
+
diff --git a/docs/source/platypush/plugins/google.fit.rst b/docs/source/platypush/plugins/google.fit.rst
new file mode 100644
index 00000000..77ba67a3
--- /dev/null
+++ b/docs/source/platypush/plugins/google.fit.rst
@@ -0,0 +1,6 @@
+``platypush.plugins.google.fit``
+================================
+
+.. automodule:: platypush.plugins.google.fit
+ :members:
+
diff --git a/docs/source/platypush/plugins/homeseer.rst b/docs/source/platypush/plugins/homeseer.rst
new file mode 100644
index 00000000..40752610
--- /dev/null
+++ b/docs/source/platypush/plugins/homeseer.rst
@@ -0,0 +1,7 @@
+``platypush.plugins.homeseer``
+==============================
+
+.. automodule:: platypush.plugins.homeseer
+ :members:
+
+
diff --git a/docs/source/platypush/plugins/http.webpage.rst b/docs/source/platypush/plugins/http.webpage.rst
new file mode 100644
index 00000000..4a5e2e8b
--- /dev/null
+++ b/docs/source/platypush/plugins/http.webpage.rst
@@ -0,0 +1,7 @@
+``platypush.plugins.http.webpage``
+==================================
+
+.. automodule:: platypush.plugins.http.webpage
+ :members:
+
+
diff --git a/docs/source/platypush/plugins/media.plex.rst b/docs/source/platypush/plugins/media.plex.rst
new file mode 100644
index 00000000..6a09a320
--- /dev/null
+++ b/docs/source/platypush/plugins/media.plex.rst
@@ -0,0 +1,6 @@
+``platypush.plugins.media.plex``
+================================
+
+.. automodule:: platypush.plugins.media.plex
+ :members:
+
diff --git a/docs/source/platypush/plugins/media.search.__init__.rst b/docs/source/platypush/plugins/media.search.__init__.rst
deleted file mode 100644
index 32a7218a..00000000
--- a/docs/source/platypush/plugins/media.search.__init__.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``platypush.plugins.media.search.__init__``
-===========================================
-
-.. automodule:: platypush.plugins.media.search.__init__
- :members:
-
diff --git a/docs/source/platypush/plugins/sound.rst b/docs/source/platypush/plugins/sound.rst
index 70e1b107..7cb44155 100644
--- a/docs/source/platypush/plugins/sound.rst
+++ b/docs/source/platypush/plugins/sound.rst
@@ -1,5 +1,5 @@
``platypush.plugins.sound``
-==========================
+===========================
.. automodule:: platypush.plugins.sound
:members:
diff --git a/docs/source/platypush/plugins/user.rst b/docs/source/platypush/plugins/user.rst
new file mode 100644
index 00000000..97047db7
--- /dev/null
+++ b/docs/source/platypush/plugins/user.rst
@@ -0,0 +1,6 @@
+``platypush.plugins.user``
+==========================
+
+.. automodule:: platypush.plugins.user
+ :members:
+
diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst
index 2c682a00..ce46f730 100644
--- a/docs/source/plugins.rst
+++ b/docs/source/plugins.rst
@@ -17,6 +17,8 @@ Plugins
platypush/plugins/db.rst
platypush/plugins/file.rst
platypush/plugins/google.calendar.rst
+ platypush/plugins/google.credentials.rst
+ platypush/plugins/google.fit.rst
platypush/plugins/google.mail.rst
platypush/plugins/google.maps.rst
platypush/plugins/google.rst
@@ -27,8 +29,10 @@ Plugins
platypush/plugins/gpio.sensor.mcp3008.rst
platypush/plugins/gpio.sensor.rst
platypush/plugins/gpio.zeroborg.rst
+ platypush/plugins/homeseer.rst
platypush/plugins/http.request.rss.rst
platypush/plugins/http.request.rst
+ platypush/plugins/http.webpage.rst
platypush/plugins/ifttt.rst
platypush/plugins/kafka.rst
platypush/plugins/light.hue.rst
@@ -37,6 +41,7 @@ Plugins
platypush/plugins/media.mplayer.rst
platypush/plugins/media.mpv.rst
platypush/plugins/media.omxplayer.rst
+ platypush/plugins/media.plex.rst
platypush/plugins/media.search.local.rst
platypush/plugins/media.search.torrent.rst
platypush/plugins/media.search.youtube.rst
@@ -59,8 +64,10 @@ Plugins
platypush/plugins/torrent.rst
platypush/plugins/tts.google.rst
platypush/plugins/tts.rst
+ platypush/plugins/user.rst
platypush/plugins/utils.rst
platypush/plugins/variable.rst
platypush/plugins/weather.forecast.rst
platypush/plugins/websocket.rst
platypush/plugins/wiimote.rst
+
diff --git a/platypush/backend/google/fit.py b/platypush/backend/google/fit.py
index e8af7bcf..486597c1 100644
--- a/platypush/backend/google/fit.py
+++ b/platypush/backend/google/fit.py
@@ -34,7 +34,7 @@ class GoogleFitBackend(Backend):
"""
:param data_sources: Google Fit data source IDs to monitor. You can
get a list of the available data sources through the
- :method:`platypush.plugins.google.fit.get_data_sources` action
+ :meth:`platypush.plugins.google.fit.get_data_sources` action
:type data_sources: list[str]
:param user_id: Google user ID to track (default: 'me')
diff --git a/platypush/backend/http/static/css/source/webpanel/nav.scss b/platypush/backend/http/static/css/source/webpanel/nav.scss
index d2ff0f0d..6910dd0d 100644
--- a/platypush/backend/http/static/css/source/webpanel/nav.scss
+++ b/platypush/backend/http/static/css/source/webpanel/nav.scss
@@ -46,10 +46,26 @@ nav {
.date-time {
position: absolute;
+ display: inline-block;
right: 0;
margin-right: .7rem;
font-size: 14pt;
text-shadow: $nav-date-time-shadow;
+
+ .time {
+ display: inline-block;
+ }
+ }
+
+ .settings {
+ display: inline-block;
+ cursor: pointer;
+ padding: 1rem;
+
+ &:hover {
+ background: $hover-bg;
+ border-radius: 3rem;
+ }
}
.decorator {
@@ -72,10 +88,6 @@ nav {
li.selected {
border-radius: 2rem;
}
-
- .date-time {
- @extend .hidden;
- }
}
}
}
diff --git a/platypush/backend/http/templates/nav.html b/platypush/backend/http/templates/nav.html
index a423bf80..cfd34a6b 100644
--- a/platypush/backend/http/templates/nav.html
+++ b/platypush/backend/http/templates/nav.html
@@ -29,6 +29,10 @@
{% endfor %}
diff --git a/platypush/backend/midi.py b/platypush/backend/midi.py
index 61f182e4..791c401d 100644
--- a/platypush/backend/midi.py
+++ b/platypush/backend/midi.py
@@ -26,7 +26,7 @@ class MidiBackend(Backend):
"""
:param device_name: Name of the MIDI device. *N.B.* either
`device_name` or `port_number` must be set.
- Use :method:`platypush.plugins.midi.query_ports` to get the
+ Use :meth:`platypush.plugins.midi.query_ports` to get the
available ports indices and names
:type device_name: str
diff --git a/platypush/plugins/assistant/google/pushtotalk.py b/platypush/plugins/assistant/google/pushtotalk.py
index 5f0d7ee8..9523966e 100644
--- a/platypush/plugins/assistant/google/pushtotalk.py
+++ b/platypush/plugins/assistant/google/pushtotalk.py
@@ -24,11 +24,11 @@ class AssistantGooglePushtotalkPlugin(AssistantPlugin):
Triggers:
- * :class:`platypush.message.event.assistant.ConversationStartEvent` \
+ * :class:`platypush.message.event.assistant.ConversationStartEvent`
when a new conversation starts
- * :class:`platypush.message.event.assistant.SpeechRecognizedEvent` \
+ * :class:`platypush.message.event.assistant.SpeechRecognizedEvent`
when a new voice command is recognized
- * :class:`platypush.message.event.assistant.ConversationEndEvent` \
+ * :class:`platypush.message.event.assistant.ConversationEndEvent`
when a new conversation ends
Requires:
@@ -54,15 +54,15 @@ class AssistantGooglePushtotalkPlugin(AssistantPlugin):
'device_config.json'),
language='en-US', **kwargs):
"""
- :param credentials_file: Path to the Google OAuth credentials file \
- (default: ~/.config/google-oauthlib-tool/credentials.json). \
- See https://developers.google.com/assistant/sdk/guides/library/python/embed/install-sample#generate_credentials \
+ :param credentials_file: Path to the Google OAuth credentials file
+ (default: ~/.config/google-oauthlib-tool/credentials.json).
+ See https://developers.google.com/assistant/sdk/guides/library/python/embed/install-sample#generate_credentials
for instructions to get your own credentials file.
:type credentials_file: str
- :param device_config: Path to device_config.json. Register your device \
- (see https://developers.google.com/assistant/sdk/guides/library/python/embed/register-device) \
- and create a project, then run the pushtotalk.py script from \
+ :param device_config: Path to device_config.json. Register your device
+ (see https://developers.google.com/assistant/sdk/guides/library/python/embed/register-device)
+ and create a project, then run the pushtotalk.py script from
googlesamples to create your device_config.json
:type device_config: str
@@ -196,22 +196,28 @@ class AssistantGooglePushtotalkPlugin(AssistantPlugin):
"""
Start a conversation
- :param language: Language code override (default: default configured
- language)
+ :param language: Language code override (default: default configured language)
:type language: str
- :returns: A list of the interactions that happen within the conversation::
+ :returns: A list of the interactions that happen within the conversation.
+
+ ..code-block:: json
+
+ [
+ {
+ "request": "request 1",
+ "response": "response 1"
+
+ },
+
+ {
+ "request": "request 2",
+ "response": "response 2"
+
+ }
+
+ ]
- [
- {
- "request": "request 1",
- "response": "response 1"
- },
- {
- "request": "request 2",
- "response": "response 2"
- },
- ]
"""
if not language:
diff --git a/platypush/plugins/autoremote.py b/platypush/plugins/autoremote.py
index ef9f219f..61597108 100644
--- a/platypush/plugins/autoremote.py
+++ b/platypush/plugins/autoremote.py
@@ -24,22 +24,26 @@ class AutoremotePlugin(Plugin):
def __init__(self, devices=None, key=None, password=None, *args, **kwargs):
"""
- :param devices: Set this attribute if you want to control multiple AutoRemote devices. This will be a map in the format:
+ :param devices: Set this attribute if you want to control multiple AutoRemote devices.
+ This will be a map in the format::
- {
- 'device_name': {
- 'key': 'AUTOREMOTE_KEY',
- 'password': 'DEVICE_PASSWORD'
- },
- ...
- }
+ {
+ 'device_name': {
+ 'key': 'AUTOREMOTE_KEY',
+ 'password': 'DEVICE_PASSWORD'
+ },
+ ...
+ }
:type devices: dict
- :param key: The key associated to your device. Open the link in your AutoRemote app and copy the key in the target URL. Set this value if you want to communicate with only one AutoRemote device.
+ :param key: The key associated to your device. Open the link in your AutoRemote app
+ and copy the key in the target URL. Set this value if you want to communicate
+ with only one AutoRemote device.
:type key: str
- :param password: AutoRemote password configured on the device (default: None). Set this value if you want to communicate with only one AutoRemote device.
+ :param password: AutoRemote password configured on the device (default: None).
+ Set this value if you want to communicate with only one AutoRemote device.
:type password: str
"""
@@ -60,13 +64,15 @@ class AutoremotePlugin(Plugin):
:param msg: Message to send
- :param key: Set it if you want to override the default devices (default: None, message sent to all the configured devices)
+ :param key: Set it if you want to override the default devices
+ (default: None, message sent to all the configured devices)
:type key: str
:param password: Set it if you want to override the default password (default: None)
:type password: str
- :param devices: Set it if you want to send the message to a specific list of configured devices (default: None, message sent to all the configured devices)
+ :param devices: Set it if you want to send the message to a specific list of
+ configured devices (default: None, message sent to all the configured devices)
:type devices: list
:param target: Message target (default: None)
diff --git a/platypush/plugins/google/credentials.py b/platypush/plugins/google/credentials.py
index 3ce4091f..66b0a0db 100644
--- a/platypush/plugins/google/credentials.py
+++ b/platypush/plugins/google/credentials.py
@@ -55,7 +55,8 @@ def generate_credentials(client_secret_path, scope):
def main():
"""
Generates a Google API credentials file given client secret JSON and scopes.
- Usage:
+ Usage::
+
python -m platypush.plugins.google.credentials [client_secret.json location] [comma-separated list of scopes]
"""
diff --git a/platypush/plugins/google/youtube.py b/platypush/plugins/google/youtube.py
index 1b447a31..2500dc6b 100644
--- a/platypush/plugins/google/youtube.py
+++ b/platypush/plugins/google/youtube.py
@@ -27,25 +27,25 @@ class GoogleYoutubePlugin(GooglePlugin):
"""
Search for YouTube content.
- :param parts: List of parts to get (default: snippet). See the `YouTube API documentation
- `_.
+ :param parts: List of parts to get (default: snippet).
+ See the `Getting started - Part `_.
:type parts: list[str] or str
:param query: Query string (default: empty string)
:type query: str
- :param types: List of types to retrieve (default: video). See the `YouTube API documentation
- `_.
+ :param types: List of types to retrieve (default: video).
+ See the `Getting started - Resources `_.
:type types: list[str] or str
:param max_results: Maximum number of items that will be returned (default: 25).
:type max_results: int
- :param kwargs: Any extra arguments that will be transparently passed to the YouTube API, see the
- `YouTube API documentation `_.
+ :param kwargs: Any extra arguments that will be transparently passed to the YouTube API.
+ See the `Getting started - parameters `_.
- :return: A list of YouTube resources, see the `YouTube API documentation
- `_.
+ :return: A list of YouTube resources.
+ See the `Getting started - Resource `_.
"""
parts = parts or self._default_parts[:]
diff --git a/platypush/plugins/http/webpage.py b/platypush/plugins/http/webpage.py
index c55c2c44..d3e6c45e 100644
--- a/platypush/plugins/http/webpage.py
+++ b/platypush/plugins/http/webpage.py
@@ -34,21 +34,28 @@ class HttpWebpagePlugin(Plugin):
:param outfile: If set then the output will be written to the specified file
(supported formats: pdf, html, plain (default)). The plugin will guess
the format from the extension
- :return: dict. Example if outfile is not specified::
+ :return: dict. Example if outfile is not specified
+
+ ..code-block:: json
{
"url": ,
"title": ,
"content":
+
}
Example if outfile is specified:
+ ..code-block:: json
+
{
"url": ,
"title": ,
"outfile":