diff --git a/doc/LIST-OF-MODULES.md b/doc/LIST-OF-MODULES.md index 1dd614c..a789470 100644 --- a/doc/LIST-OF-MODULES.md +++ b/doc/LIST-OF-MODULES.md @@ -48,6 +48,7 @@ |nic |Displays the name, IP address(es) and status of each available network interface.

Requires the following python module:
* netifaces

Parameters:
* nic.exclude: Comma-separated list of interface prefixes to exclude (defaults to 'lo,virbr,docker,vboxnet,veth,br')
* nic.include: Comma-separated list of interfaces to include
* nic.states: Comma-separated list of states to show (prefix with '^' to invert - i.e. ^down -\> show all devices that are not in state down)
* nic.format: Format string (defaults to '{intf} {state} {ip} {ssid}') | |notmuch_count |Displays the result of a notmuch count query
default : unread emails which path do not contained 'Trash' (notmuch count 'tag:unread AND NOT path:/.*Trash.*/')

Parameters:
* notmuch_count.query: notmuch count query to show result

Errors:
if the notmuch query failed, the shown value is -1

Dependencies:
notmuch (https://notmuchmail.org/) | |nvidiagpu |Displays GPU name, temperature and memory usage.

Parameters:
* nvidiagpu.format: Format string (defaults to '{name}: {temp}°C %{usedmem}/{totalmem} MiB')
Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem}

Requires nvidia-smi | +|octoprint |Displays the Octorpint status and the printer's bed/tools temperature in the status bar.

Left click opens a popup which shows the bed & tools temperatures and additionally a livestream of the webcam (if enabled).

Parameters:
* octoprint.address : Octoprint address (e.q: http://192.168.1.3)
* octoprint.apitoken : Octorpint API Token (can be obtained from the Octoprint Webinterface)
* octoprint.webcam : Set to True if a webcam is connected (default: False) | |pacman |Displays update information per repository for pacman.

Parameters:
* pacman.sum: If you prefere displaying updates with a single digit (defaults to 'False')

Requires the following executables:
* fakeroot
* pacman | |pihole |Displays the pi-hole status (up/down) together with the number of ads that were blocked today
Parameters:
* pihole.address : pi-hole address (e.q: http://192.168.1.3)
* pihole.pwhash : pi-hole webinterface password hash (can be obtained from the /etc/pihole/SetupVars.conf file) | |ping |Periodically checks the RTT of a configurable host using ICMP echos

Requires the following executable:
* ping

Parameters:
* ping.address : IP address to check
* ping.timeout : Timeout for waiting for a reply (defaults to 5.0)
* ping.probes : Number of probes to send (defaults to 5)
* ping.warning : Threshold for warning state, in seconds (defaults to 1.0)
* ping.critical: Threshold for critical state, in seconds (defaults to 2.0) |