X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/0fb405d2a53257a83661b1cb1bbc8f23ff9b7c41..a7b1e7e0db5db914d519bbe8135f7e29cadfb8b7:/bat.md?ds=sidebyside diff --git a/bat.md b/bat.md index 9e2d8c5..50c14e8 100644 --- a/bat.md +++ b/bat.md @@ -1,18 +1,27 @@ -Shows the remaining time and percentage capacity of your laptop battery, as well as +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + +Shows in a textbox the remaining time and percentage capacity of your laptop battery, as well as the current wattage. Displays a notification when battery is low or critical. mybattery = lain.widgets.bat() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 30 `battery` | Identifier of the battery | string | "BAT0" -`show_all` | Show all values (true), or only remaining capacity (false) | boolean | false -`refresh_timeout` | Refresh timeout seconds | int | 30 -`header` | Text to show before value | string | " Vol " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file +`settings` | User settings | function | empty function + +`settings` can use the `bat_now` table, which contains the following strings: + +- `status` ("Not present", "Charging", "Discharging"); +- `perc`; +- `time`; +- `watt`. + +### output + +A textbox. \ No newline at end of file