From 2b888325a637bbc49bc941a3e8561ac351b25b4a Mon Sep 17 00:00:00 2001 From: tobi-wan-kenobi Date: Fri, 10 Jul 2020 20:19:43 +0200 Subject: [PATCH] [doc] add messagereceiver (+ attribution) --- .../modules/contrib/messagereceiver.py | 2 +- docs/modules.rst | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/bumblebee_status/modules/contrib/messagereceiver.py b/bumblebee_status/modules/contrib/messagereceiver.py index 1fb8ca2..9f00c8c 100644 --- a/bumblebee_status/modules/contrib/messagereceiver.py +++ b/bumblebee_status/modules/contrib/messagereceiver.py @@ -15,7 +15,7 @@ Example: In order to highlight the text, the state variable can be used: echo -e '{"message":"I  bumblebee-status", "state": "warning"}' | socat unix-connect:/tmp/bumblebee_messagereceiver.sock STDIO - +contributed by `bbernhard `_ - many thanks! """ import core.module diff --git a/docs/modules.rst b/docs/modules.rst index 984abb9..1337cd2 100644 --- a/docs/modules.rst +++ b/docs/modules.rst @@ -760,6 +760,25 @@ Required the following python packages: contributed by `maxpivo `_ - many thanks! +messagereceiver +~~~~~~~~~~~~~~~ + +Displays the message that's received via unix socket. + +Parameteres: + * messagereceiver : Unix socket address (e.g: /tmp/bumblebee_messagereceiver.sock) + +Example: + The following examples assume that /tmp/bumblebee_messagereceiver.sock is used as unix socket address. + + In order to send the string "I  bumblebee-status" to your status bar, use the following command: + echo -e '{"message":"I  bumblebee-status", "state": ""}' | socat unix-connect:/tmp/bumblebee_messagereceiver.sock STDIO + + In order to highlight the text, the state variable can be used: + echo -e '{"message":"I  bumblebee-status", "state": "warning"}' | socat unix-connect:/tmp/bumblebee_messagereceiver.sock STDIO + +contributed by `bbernhard `_ - many thanks! + mocp ~~~~ @@ -1148,6 +1167,8 @@ contributed by `yvesh `_ - many thanks! added controls by `LtPeriwinkle `_ - many thanks! +fixed icons and layout parameter by `gkeep `_ - many thanks! + .. image:: ../screenshots/spotify.png stock