Awesome configs for Ben.

This commit is contained in:
Derek Taylor
2023-04-05 14:32:50 -05:00
parent 1966d656c1
commit 6252ad30c1
608 changed files with 9300 additions and 3600 deletions

66
.config/awesome/lain/wiki/bat.md Executable file → Normal file
View File

@@ -1,13 +1,13 @@
## Usage
[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage)
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
### Description
Shows the remaining time and percentage capacity of your laptop battery, as well
as the current wattage. Multiple batteries are supported.
Shows the remaining time and percentage capacity of your laptop battery, as well as
the current wattage. Multiple batteries are supported.
Displays a notification when battery is fully charged, low, or critical.
Displays a notification when battery is low or critical.
```lua
local mybattery = lain.widget.bat()
@@ -17,54 +17,35 @@ local mybattery = lain.widget.bat()
Variable | Meaning | Type | Default
--- | --- | --- | ---
`timeout` | Refresh timeout (in seconds) | integer | 30
`pspath` | Power supply directory path | string | "/sys/class/power_supply/"
`battery` | Single battery id | string | autodetected
`batteries` | Multiple batteries id table | table of strings | autodetected
`ac` | AC | string | autodetected
`timeout` | Refresh timeout seconds | number | 30
`battery` | Single battery id | string | "BAT0"
`batteries` | Multiple batteries id table | table of strings | `{"BAT0"}`
`ac` | AC | string | "AC0"
`notify` | Show notification popups | string | "on"
`n_perc` | Percentages assumed for critical and low battery levels | table of integers | `{5, 15}`
`settings` | User settings | function | empty function
The widget will try to autodetect `battery`, `batteries` and `ac`. If something
goes wrong, you will have to define them manually. In that case, you only have
to define one between `battery` and `batteries`. If you have one battery, you
can either use `args.battery = "BAT*"` or `args.batteries = {"BAT*"}`, where `BAT*`
is the identifier of your battery in `pspath` (do not use it as a wildcard).
Of course, if you have multiple batteries, you need to use the latter option.
You only have to define one between `battery` and `batteries`.
To disable notifications, set `notify` to `"off"`.
If you have one battery, you can either use `args.battery = "BAT*"` or `args.batteries = {"BAT*"}`. Of course, if you have multiple batteries, you need to use the latter option.
If you define `pspath`, **be sure** to not forget the final slash (/).
To disable warning notifications, set `notify` to `"off"`.
`settings` can use the `bat_now` table, which contains the following strings:
- `status`, general status ("N/A", "Discharging", "Charging", "Full");
- `status`, battery status ("N/A", "Discharging", "Charging", "Full");
- `n_status[i]`, i-th battery status (like above);
- `ac_status`, AC-plug flag (0 if cable is unplugged, 1 if plugged, "N/A" otherwise);
- `perc`, total charge percentage (integer between 0 and 100 or "N/A");
- `n_perc[i]`, i-th battery charge percentage (like above);
- `time`, time remaining until charge if charging, until discharge if discharging (HH:MM string or "N/A");
- `n_perc`, i-th battery charge percentage (like above);
- `time`, time remaining until charge if charging, until discharge if discharging (HH:SS string or "N/A");
- `watt`, battery watts (float with 2 decimals).
and can modify the following three tables, which will be the preset for the naughty notifications:
* `bat_notification_charged_preset` (used if battery is fully charged and connected to AC)
* `bat_notification_low_preset` (used if battery charge level <= 15)
and can modify the following two tables, which will be the preset for the naughty notifications:
* `bat_notification_low_preset`(used if battery charge level <= 15)
* `bat_notification_critical_preset` (used if battery charge level <= 5)
Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for
the list of variables they can contain. Default definitions:
```lua
bat_notification_charged_preset = {
title = "Battery full",
text = "You can unplug the cable",
timeout = 15,
fg = "#202020",
bg = "#CDCDCD"
}
```
Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the list of variables they can contain. Default definitions:
```lua
bat_notification_low_preset = {
@@ -94,6 +75,15 @@ Variable | Meaning | Type
The `update` function can be used to refresh the widget before `timeout` expires.
## Note
## Notes
* Another common identifier for `ac` is `ACAD`.
* If your widget is always on "N/A" with default settings, and you have a single battery, then `BAT0` is not your battery file. Locate the right one in `/sys/class/power_supply/` and set `battery` properly. For instance, with `BAT1`:
Alternatively, you can try the [`upower` recipe](https://awesomewm.org/recipes/watch).
```lua
batwidget = lain.widget.bat({
battery = "BAT1",
-- [...]
})
```
* Alternatively, you can try the `upower` widget [here](https://awesomewm.org/recipes/watch).