l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

improved documentation of messagereceiver module

Browse source
This commit is contained in:
Bernhard B 2020-07-10 17:35:40 +02:00
parent adbba9bf9a
commit 01cde70e14
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
bumblebee_status/modules/contrib/messagereceiver.py
View file

@ -5,6 +5,17 @@ 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
"""
import core.module