diff --git a/Modules.md b/Modules.md index 18b61e0..d87d2d5 100644 --- a/Modules.md +++ b/Modules.md @@ -54,7 +54,7 @@ |rotation |Shows a widget for each connected screen and allows the user to loop through different orientations.

Requires the following executable:
* xrandr
| |rss |RSS news ticker

Fetches rss news items and shows these as a news ticker.
Left-clicking will open the full story in a browser.
New stories are highlighted.

Parameters:
* rss.feeds : Space-separated list of RSS URLs
* rss.length : Maximum length of the module, default is 60
| |sensors |Displays sensor temperature

Parameters:
* sensors.path: path to temperature file (default /sys/class/thermal/thermal_zone0/temp).
* sensors.json: if set to "true", interpret sensors.path as JSON "path" in the output
of "sensors -j" (i.e. \/\/.../\), for example, path could
be: "coretemp-isa-00000/Core 0/temp1_input" (defaults to "false")
* sensors.match: (fallback) Line to match against output of 'sensors -u' (default: temp1_input)
* sensors.match_pattern: (fallback) Line to match against before temperature is read (no default)
* sensors.match_number: (fallback) which of the matches you want (default -1: last match).
* sensors.show_freq: whether to show CPU frequency. (default: true)
| -|sensors2 |Displays sensor temperature and CPU frequency

Parameters:

* sensors2.chip: "sensors -u" compatible filter for chip to display (default to empty - show all chips)
* sensors2.showcpu: Enable or disable CPU frequency display (default: true)
* sensors2.showtemp: Enable or disable temperature display (default: true)
* sensors2.showfan: Enable or disable fan display (default: true)
* sensors2.showother: Enable or display "other" sensor readings (default: false)
* sensors2.showname: Enable or disable show of sensor name (default: false)
| +|sensors2 |Displays sensor temperature and CPU frequency

Parameters:

* sensors2.chip: "sensors -u" compatible filter for chip to display (default to empty - show all chips)
* sensors2.showcpu: Enable or disable CPU frequency display (default: true)
* sensors2.showtemp: Enable or disable temperature display (default: true)
* sensors2.showfan: Enable or disable fan display (default: true)
* sensors2.showother: Enable or display "other" sensor readings (default: false)
* sensors2.showname: Enable or disable show of sensor name (default: false)
* sensors2.chip_include: Comma-separated list of chip to include (defaults to "" will include all by default, example: "coretemp,bat")
* sensors2.chip_exclude:Comma separated list of chip to exclude (defaults to "" will exlude none by default)
* sensors2.field_include: Comma separated list of chip to include (defaults to "" will include all by default, example: "temp,fan")
* sensors2.field_exclude: Comma separated list of chip to exclude (defaults to "" will exclude none by default)
* sensors2.chip_field_exclude: Comma separated list of chip field to exclude (defaults to "" will exclude none by default, example: "coretemp-isa-0000.temp1,coretemp-isa-0000.fan1")
* sensors2.chip_field_include: Comma-separated list of adaper field to include (defaults to "" will include all by default)
| |shell | Execute command in shell and print result

Few command examples:
'ping 1.1.1.1 -c 1 | grep -Po "(?\<=time=)\d+(\.\d+)? ms"'
'echo "BTC=$(curl -s rate.sx/1BTC | grep -Po "^\d+")USD"'
'curl -s https://wttr.in/London?format=%l+%t+%h+%w'
'pip3 freeze | wc -l'
'any_custom_script.sh | grep arguments'

Parameters:
* shell.command: Command to execute
Use single parentheses if evaluating anything inside (sh-style)
For example shell.command='echo $(date +"%H:%M:%S")'
But NOT shell.command="echo $(date +'%H:%M:%S')"
Second one will be evaluated only once at startup
* shell.interval: Update interval in seconds
(defaults to 1s == every bumblebee-status update)
* shell.async: Run update in async mode. Won't run next thread if
previous one didn't finished yet. Useful for long
running scripts to avoid bumblebee-status freezes
(defaults to False)
| |shortcut |Shows a widget per user-defined shortcut and allows to define the behaviour
when clicking on it.

For more than one shortcut, the commands and labels are strings separated by
a demiliter (; semicolon by default).

For example in order to create two shortcuts labeled A and B with commands
cmdA and cmdB you could do:

./bumblebee-status -m shortcut -p shortcut.cmd="ls;ps" shortcut.label="A;B"

Parameters:
* shortcut.cmds : List of commands to execute
* shortcut.labels: List of widgets' labels (text)
* shortcut.delim : Commands and labels delimiter (; semicolon by default)
| |spaceapi |Displays the state of a Space API endpoint
Space API is an API for hackspaces based on JSON. See spaceapi.io for
an example.

Requires the following libraries:
* requests
* regex

Parameters:
* spaceapi.url: String representation of the api endpoint
* spaceapi.format: Format string for the output

Format Strings:
* Format strings are indicated by double %%
* They represent a leaf in the JSON tree, layers seperated by "."
* Boolean values can be overwritten by appending "%true%false"
in the format string
* Example: to reference "open" in "{"state":{"open": true}}"
you would write "%%state.open%%", if you also want
to say "Open/Closed" depending on the boolean you
would write "%%state.open%Open%Closed%%"
| diff --git a/bumblebee/modules/sensors2.py b/bumblebee/modules/sensors2.py index 0d07d35..0cec5f7 100644 --- a/bumblebee/modules/sensors2.py +++ b/bumblebee/modules/sensors2.py @@ -11,9 +11,9 @@ Parameters: * sensors2.showother: Enable or display "other" sensor readings (default: false) * sensors2.showname: Enable or disable show of sensor name (default: false) * sensors2.chip_include: Comma-separated list of chip to include (defaults to "" will include all by default, example: "coretemp,bat") - * sensors2.chip_exlude:Comma separated list of chip to exclude (defaults to "" will include none by default) + * sensors2.chip_exclude:Comma separated list of chip to exclude (defaults to "" will exlude none by default) * sensors2.field_include: Comma separated list of chip to include (defaults to "" will include all by default, example: "temp,fan") - * sensors2.field_exlude: Comma separated list of chip to exclude (defaults to "" will exclude none by default) + * sensors2.field_exclude: Comma separated list of chip to exclude (defaults to "" will exclude none by default) * sensors2.chip_field_exclude: Comma separated list of chip field to exclude (defaults to "" will exclude none by default, example: "coretemp-isa-0000.temp1,coretemp-isa-0000.fan1") * sensors2.chip_field_include: Comma-separated list of adaper field to include (defaults to "" will include all by default) """