[doc] add messagereceiver (+ attribution)

This commit is contained in:
tobi-wan-kenobi 2020-07-10 20:19:43 +02:00
parent 2d6cedd8ac
commit 2b888325a6
2 changed files with 22 additions and 1 deletions

View file

@ -15,7 +15,7 @@ Example:
In order to highlight the text, the state variable can be used: 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 echo -e '{"message":"I  bumblebee-status", "state": "warning"}' | socat unix-connect:/tmp/bumblebee_messagereceiver.sock STDIO
contributed by `bbernhard <https://github.com/bbernhard>`_ - many thanks!
""" """
import core.module import core.module

View file

@ -760,6 +760,25 @@ Required the following python packages:
contributed by `maxpivo <https://github.com/maxpivo>`_ - many thanks! contributed by `maxpivo <https://github.com/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 <https://github.com/bbernhard>`_ - many thanks!
mocp mocp
~~~~ ~~~~
@ -1148,6 +1167,8 @@ contributed by `yvesh <https://github.com/yvesh>`_ - many thanks!
added controls by `LtPeriwinkle <https://github.com/LtPeriwinkle>`_ - many thanks! added controls by `LtPeriwinkle <https://github.com/LtPeriwinkle>`_ - many thanks!
fixed icons and layout parameter by `gkeep <https://github.com/gkeep>`_ - many thanks!
.. image:: ../screenshots/spotify.png .. image:: ../screenshots/spotify.png
stock stock