mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
[WTF-55] Closes #55. Add documentation for the Power module.
This commit is contained in:
@@ -17,20 +17,4 @@ The <a href="/posts/modules/clocks">Clocks</a> module takes a list of
|
||||
timezones and packages that information as a list of city/time pairs for
|
||||
display in the "Clocks" widget.
|
||||
|
||||
Available modules:
|
||||
|
||||
<ul class="list-bare">
|
||||
<li><a href="/posts/modules/bamboohr">BambooHR</a>
|
||||
<li><a href="/posts/modules/clocks">Clocks</a>
|
||||
<li><a href="/posts/modules/cmdrunner">CmdRunner</a>
|
||||
<li><a href="/posts/modules/git">Git</a>
|
||||
<li><a href="/posts/modules/github">Github</a>
|
||||
<li><a href="/posts/modules/gcal">Google Calendar</a>
|
||||
<li><a href="/posts/modules/jira">Jira</a>
|
||||
<li><a href="/posts/modules/newrelic">New Relic</a>
|
||||
<li><a href="/posts/modules/opsgenie">OpsGenie</a>
|
||||
<li><a href="/posts/modules/security">Security</a>
|
||||
<li><a href="/posts/modules/textfile">Text File</a>
|
||||
<li><a href="/posts/modules/todo">Todo</a>
|
||||
<li><a href="/posts/modules/weather">Weather</a>
|
||||
</ul>
|
||||
See available modules at left.
|
||||
|
||||
@@ -9,7 +9,7 @@ Connects to the BambooHR API and displays who will be Away today.
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/bamboohr
|
||||
wtf/bamboohr/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
49
_site/content/posts/modules/power.md
Normal file
49
_site/content/posts/modules/power.md
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: "Modules: Power"
|
||||
date: 2018-05-26T19:26:23-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Displays information about the current power source.
|
||||
|
||||
For battery, also displays the current charge, estimated time remaining,
|
||||
and whether it is charging or discharging.
|
||||
|
||||
## Source Code
|
||||
```bash
|
||||
wtf/power/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
power:
|
||||
enabled: true
|
||||
position:
|
||||
top: 5
|
||||
left: 0
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 15
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@@ -39,7 +39,7 @@ show hidden users.</li>
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/security
|
||||
wtf/security/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
@@ -31,6 +31,7 @@
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/power/">Power</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
|
||||
|
||||
Reference in New Issue
Block a user