Rework battery_widget adding external configuration

battery-widget/README.md

@@ -15,6 +15,15 @@ This widget consists of:
 
 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 |
+|---|---|---|
+| `notification` | `false` | Display a notification on mouseover |
+| `notification_position` | `top_right` | The notification position |
+
 ## Installation
 
 This widget reads the output of acpi tool.
@@ -26,4 +35,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(),
+		...
+```

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,7 +21,12 @@ local wibox = require("wibox")
 local PATH_TO_ICONS = "/usr/share/icons/Arc/status/symbolic/"
 local HOME = os.getenv("HOME")
 
-local battery_widget = wibox.widget {
+local battery_widget = {}
+local function worker(args)
+    local args = args or {}
+    local display_notification = args.notification or false
+    local position = args.notification_position or "top_right"
+    battery_widget = wibox.widget {
         {
             id = "icon",
             widget = wibox.widget.imagebox,
@@ -32,13 +38,16 @@ local battery_widget = wibox.widget {
     -- Popup with battery info
     -- One way of creating a pop-up notification - naughty.notify
     local notification
-local function show_battery_status()
+    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,
             }
@@ -69,11 +78,10 @@ local function show_battery_warning()
     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
@@ -132,7 +140,11 @@ watch("acpi -i", 10,
     end,
     battery_widget)
 
-battery_widget:connect_signal("mouse::enter", function() show_battery_status() 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 battery_widget
+end
+
+return setmetatable(battery_widget, { __call = function(_, ...) return worker(...) end })