2018-09-15 23:33:42 +02:00
---
layout: page
---
# Battery widget
Simple and easy-to-install widget for Awesome Window Manager.
This widget consists of:
2020-02-02 19:53:06 +01:00
- an icon which shows the battery level:
2019-12-15 21:38:54 +01:00
2020-02-02 19:53:06 +01:00
- a pop-up window, which shows up when you hover over an icon:
Alternatively you can use a tooltip (check the code):
2019-12-15 21:38:54 +01:00
2020-02-02 19:53:06 +01:00
- a pop-up warning message which appears on bottom right corner when battery level is less that 15% (you can get the image [here ](../awesome-wm-widgets/assets/img/screenshots/battery-widgetttps://vk.com/images/stickers/1933/512.png )):
2018-09-15 23:33:42 +02:00
2019-12-15 21:38:54 +01:00
Note that widget uses the Arc icon theme, so it should be [installed ](../awesome-wm-widgets/assets/img/screenshots/battery-widgetttps://github.com/horst3180/arc-icon-theme#installation ) first under ** /usr/share/icons/Arc/** folder.
2018-09-15 23:33:42 +02:00
2020-02-02 19:53:06 +01:00
## Customization
It is possible to customize widget by providing a table with all or some of the following config parameters:
| Name | Default | Description |
|---|---|---|
2020-03-02 03:40:04 +01:00
| `font` | Play 8 | Fond |
| `path_to_icons` | `/usr/share/icons/Arc/status/symbolic/` | Path to the folder with icons* |
2020-02-02 19:53:06 +01:00
| `show_current_level` | false | Show current charge level |
2020-03-02 03:40:04 +01:00
| `margin_right` |0| The right margin of the widget|
| `margin_left` |0| The left margin of the widget|
| `display_notification` | `false` | Display a notification on mouseover |
2020-02-02 19:53:06 +01:00
| `notification_position` | `top_right` | The notification position |
| `warning_msg_title` | _Huston, we have a problem_ | Title of the warning popup |
| `warning_msg_text` | _Battery is dying_ | Text of the warning popup |
| `warning_msg_position` | `bottom_right` | Position of the warning popup |
2020-03-02 03:40:04 +01:00
| `warning_msg_icon` | ~/.config/awesome/awesome-wm-widgets/battery-widget/spaceman.jpg | Icon of the warning popup |
2020-04-13 21:43:50 +02:00
| `enable_battery_warning` | `true` | Display low battery warning |
2020-03-02 03:40:04 +01:00
*Note: the widget expects following icons be present in the folder:
- battery-caution-charging-symbolic.svg
- battery-empty-charging-symbolic.svg
- battery-full-charged-symbolic.svg
- battery-full-symbolic.svg
- battery-good-symbolic.svg
- battery-low-symbolic.svg
- battery-caution-symbolic.svg
- battery-empty-symbolic.svg
- battery-full-charging-symbolic.svg
- battery-good-charging-symbolic.svg
- battery-low-charging-symbolic.svg
- battery-missing-symbolic.svg
2020-02-02 19:53:06 +01:00
2018-09-15 23:33:42 +02:00
## Installation
This widget reads the output of acpi tool.
- install `acpi` and check the output:
```bash
$ sudo apt-get install acpi
$ acpi
Battery 0: Discharging, 66%, 02:34:06 remaining
```
2020-02-02 19:53:06 +01:00
```lua
local battery_widget = require("awesome-wm-widgets.battery-widget.battery")
...
s.mytasklist, -- Middle widget
{ -- Right widgets
layout = wibox.layout.fixed.horizontal,
...
battery_widget(),
...
```
