diff options
| -rw-r--r-- | battery-widget/README.md | 41 | ||||
| -rw-r--r-- | battery-widget/battery.lua | 131 |
2 files changed, 117 insertions, 55 deletions
diff --git a/battery-widget/README.md b/battery-widget/README.md index 57f7c3f..710f8b2 100644 --- a/battery-widget/README.md +++ b/battery-widget/README.md @@ -4,17 +4,34 @@ Simple and easy-to-install widget for Awesome Window Manager. This widget consists of: - - an icon which shows the battery level: + - an icon which shows the battery level:  - - a pop-up window, which shows up when you hover over an icon: -  - Alternatively you can use a tooltip (check the code): + - a pop-up window, which shows up when you hover over an icon: +  + Alternatively you can use a tooltip (check the code):  - - a pop-up warning message which appears on bottom right corner when battery level is less that 15% (you can get the image [here](https://vk.com/images/stickers/1933/512.png)): -  + - a pop-up warning message which appears on bottom right corner when battery level is less that 15% (you can get the image [here](https://vk.com/images/stickers/1933/512.png)): +  Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder. +## Customization + +It is possible to customize widget by providing a table with all or some of the following config parameters: + +| Name | Default | Description | +|---|---|---| +| `font` | Font | Play 8 | +| `show_current_level`| false | Show current charge level | +| `margin_right`|0| the right margin of the widget| +| `margin_left`|0| the left margin of the widget| +| `notification` | `false` | Display a notification on mouseover | +| `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 | +| `warning_msg_icon` | ~/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg | Icon of the warning popup | + ## Installation This widget reads the output of acpi tool. @@ -26,4 +43,14 @@ $ acpi Battery 0: Discharging, 66%, 02:34:06 remaining ``` -Then refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo. +```lua +local battery_widget = require("awesome-wm-widgets.battery-widget.battery") + +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + battery_widget(), + ... +``` diff --git a/battery-widget/battery.lua b/battery-widget/battery.lua index aa3623d..d5e339f 100644 --- a/battery-widget/battery.lua +++ b/battery-widget/battery.lua @@ -12,6 +12,7 @@ local awful = require("awful") local naughty = require("naughty") local watch = require("awful.widget.watch") local wibox = require("wibox") +local dpi = require('beautiful').xresources.apply_dpi -- acpi sample outputs -- Battery 0: Discharging, 75%, 01:51:38 remaining @@ -20,60 +21,88 @@ local wibox = require("wibox") local PATH_TO_ICONS = "/usr/share/icons/Arc/status/symbolic/" local HOME = os.getenv("HOME") -local battery_widget = wibox.widget { - { - id = "icon", - widget = wibox.widget.imagebox, - resize = false - }, - layout = wibox.container.margin(_, 0, 0, 3) -} - --- Popup with battery info --- One way of creating a pop-up notification - naughty.notify -local notification -local function show_battery_status() - awful.spawn.easy_async([[bash -c 'acpi']], +local battery_widget = {} +local function worker(args) + local args = args or {} + + local font = args.font or 'Play 8' + local show_current_level = args.show_current_level or false + local margin_left = args.margin_left or 0 + local margin_right = args.margin_right or 0 + + local display_notification = args.notification or false + local position = args.notification_position or "top_right" + + local warning_msg_title = args.warning_msg_title or 'Huston, we have a problem' + local warning_msg_text = args.warning_msg_text or 'Battery is dying' + local warning_msg_position = args.warning_msg_position or 'bottom_right' + local warning_msg_icon = args.warning_msg_icon or HOME .. '/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg' + + icon_widget = wibox.widget { + { + id = "icon", + widget = wibox.widget.imagebox, + resize = false + }, + layout = wibox.container.margin(_, 0, 0, 3) + } + local level_widget = wibox.widget { + font = font, + widget = wibox.widget.textbox + } + + battery_widget = wibox.widget { + icon_widget, + level_widget, + layout = wibox.layout.fixed.horizontal, + } + -- Popup with battery info + -- One way of creating a pop-up notification - naughty.notify + local notification + local function show_battery_status(batteryType) + awful.spawn.easy_async([[bash -c 'acpi']], function(stdout, _, _, _) naughty.destroy(notification) notification = naughty.notify{ text = stdout, title = "Battery status", + icon = PATH_TO_ICONS .. batteryType .. ".svg", + icon_size = dpi(16), + position = position, timeout = 5, hover_timeout = 0.5, width = 200, } end - ) -end - --- Alternative to naughty.notify - tooltip. You can compare both and choose the preferred one ---battery_popup = awful.tooltip({objects = {battery_widget}}) - --- To use colors from beautiful theme put --- following lines in rc.lua before require("battery"): --- beautiful.tooltip_fg = beautiful.fg_normal --- beautiful.tooltip_bg = beautiful.bg_normal - -local function show_battery_warning() - naughty.notify{ - icon = HOME .. "/.config/awesome/nichosi.png", - icon_size=100, - text = "Huston, we have a problem", - title = "Battery is dying", - timeout = 5, hover_timeout = 0.5, - position = "bottom_right", - bg = "#F06060", - fg = "#EEE9EF", - width = 300, - } -end - -local last_battery_check = os.time() - -watch("acpi -i", 10, + ) + end + + -- Alternative to naughty.notify - tooltip. You can compare both and choose the preferred one + --battery_popup = awful.tooltip({objects = {battery_widget}}) + + -- To use colors from beautiful theme put + -- following lines in rc.lua before require("battery"): + -- beautiful.tooltip_fg = beautiful.fg_normal + -- beautiful.tooltip_bg = beautiful.bg_normal + + local function show_battery_warning() + naughty.notify { + icon = warning_msg_icon, + icon_size = 100, + text = warning_msg_text, + title = warning_msg_title, + timeout = 25, -- show the warning for a longer time + hover_timeout = 0.5, + position = warning_msg_position, + bg = "#F06060", + fg = "#EEE9EF", + width = 300, + } + end + local last_battery_check = os.time() + local batteryType = "battery-good-symbolic" + + watch("acpi -i", 10, function(widget, stdout, stderr, exitreason, exitcode) - local batteryType - local battery_info = {} local capacities = {} for s in stdout:gmatch("[^\r\n]+") do @@ -105,6 +134,8 @@ watch("acpi -i", 10, end charge = charge / capacity + level_widget.text = string.format('%d%%', charge) + if (charge >= 0 and charge < 15) then batteryType = "battery-empty%s-symbolic" if status ~= 'Charging' and os.difftime(os.time(), last_battery_check) > 300 then @@ -130,9 +161,13 @@ watch("acpi -i", 10, -- Update popup text -- battery_popup.text = string.gsub(stdout, "\n$", "") end, - battery_widget) + icon_widget) -battery_widget:connect_signal("mouse::enter", function() show_battery_status() end) -battery_widget:connect_signal("mouse::leave", function() naughty.destroy(notification) end) + if display_notification then + battery_widget:connect_signal("mouse::enter", function() show_battery_status(batteryType) end) + battery_widget:connect_signal("mouse::leave", function() naughty.destroy(notification) end) + end + return wibox.container.margin(battery_widget, margin_left, margin_right) +end -return battery_widget +return setmetatable(battery_widget, { __call = function(_, ...) return worker(...) end }) |