]> git.madduck.net Git - etc/awesome.git/blob - bat.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge wiki
[etc/awesome.git] / bat.md
1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
2
3 Shows in a textbox the remaining time and percentage capacity of your laptop battery, as well as
4 the current wattage.
5
6 Displays a notification when battery is low or critical.
7
8         mybattery = lain.widgets.bat()
9
10 ### input table
11
12 Variable | Meaning | Type | Default
13 --- | --- | --- | ---
14 `timeout` | Refresh timeout seconds | int | 30
15 `battery` | Identifier of the battery | string | "BAT0"
16 `notify` | Enable notifications | string | "on"
17 `settings` | User settings | function | empty function
18
19 `settings` can use the `bat_now` table, which contains the following strings:
20
21 - `status` ("Not present", "Charging", "Discharging");
22 - `perc`;
23 - `time`;
24 - `watt`.
25
26 To disable warning notifications, set `notify` to `"off"`.
27
28 ### output
29
30 A textbox.