externalize config of batteryarc widget

batteryarc-widget/README.md

@@ -11,18 +11,27 @@ Depending of the battery status it could look following ways:
  - ![80_d](./80_d.png) - more than 40 percent
  - ![80_c](./80_c.png) - more than 40 percent, charging
 
-Widget uses following beautiful variables with values:
+If a battery level is low then warning popup will show up:
 
-```lua
-theme.widget_main_color = "#74aeab"
-theme.widget_red = "#e53935"
-theme.widget_yellow = "#c0ca33"
-theme.widget_green = "#43a047"
-theme.widget_black = "#000000"
-theme.widget_transparent = "#00000000"
-```
+![warning](./warning.png)
+
+## 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 6 |
+| `arc_thickness` | Thickness of the arc | 2 |
+| `text_color` | Color of text with the current charge | `beautiful.fg_color` |
+| `low_level_color` | Arc color when battery charge is less that 15%| #e53935 |
+| `medium_level_color` | Arc color when battery charge is between 15% and 40% | #c0ca33 |
+| `full_level_color` | Arc color when battery charge is above 40% | `beautiful.fg_color` |
+| `warning_msg_title` | Title of the warning popup | _Huston, we have a problem_ |
+| `warning_msg_text` | Text of the warning popup | _Battery is dying_ |
+| `warning_msg_position` | Position of the warning popup | `bottom_right` |
+| `warning_msg_icon` | Icon of the warning popup| ~/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg |
 
-which means that you need to copy the code above and paste it in your **theme.lua**. Otherwise you can change colors directly in the widget.
 
 ## Installation
 
@@ -35,11 +44,10 @@ s.mytasklist, -- Middle widget
 	{ -- Right widgets
     	layout = wibox.layout.fixed.horizontal,
 		...
-		batteryarc_widget,
+		batteryarc_widget(),
 		...
 ```
-You can get the icon for warning popup [here](https://vk.com/images/stickers/1933/512.png)
 
 ## Troubleshooting
 
-In case of any doubts or questions don't hesitate to raise an [issue](https://github.com/streetturtle/awesome-wm-widgets/issues/new).
+In case of any doubts or questions please raise an [issue](https://github.com/streetturtle/awesome-wm-widgets/issues/new).

batteryarc-widget/batteryarc.lua

@@ -16,21 +16,40 @@ local watch = require("awful.widget.watch")
 
 local HOME = os.getenv("HOME")
 
-local text = wibox.widget {
+local widget = {}
+
+local function worker(args)
+
+    local args = args or {}
+
+    local font = args.font or 'Play 6'
+    local arc_thickness = args.thickness or 2
+
+    local text_color = args.text_color or beautiful.fg_color
+    local low_level_color = args.low_level_color or '#e53935'
+    local medium_level_color = args.medium_level_color or '#c0ca33'
+    local full_level_color = args.full_level_color or beautiful.fg_color
+
+    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'
+
+    local text = wibox.widget {
         id = "txt",
-    font = "Play 6",
+        font = font,
         align = 'center', -- align the text
         valign = 'center',
         widget = wibox.widget.textbox
-}
+    }
 
-local text_with_background = wibox.container.background(text)
+    local text_with_background = wibox.container.background(text)
 
-local batteryarc = wibox.widget {
+    widget = wibox.widget {
         text_with_background,
         max_value = 1,
         rounded_edge = true,
-    thickness = 2,
+        thickness = arc_thickness,
         start_angle = 4.71238898, -- 2pi*3/4
         forced_height = 18,
         forced_width = 18,
@@ -40,11 +59,11 @@ local batteryarc = wibox.widget {
         set_value = function(self, value)
             self.value = value
         end,
-}
+    }
 
-local last_battery_check = os.time()
+    local last_battery_check = os.time()
 
-watch("acpi -i", 10,
+    watch("acpi -i", 10,
             function(widget, stdout)
                 local batteryType
 
@@ -55,7 +74,7 @@ watch("acpi -i", 10,
                     if string.match(s, 'rate information') then
                         -- ignore such line
                     elseif status ~= nil then
-                    table.insert(battery_info, {status = status, charge = tonumber(charge_str)})
+                        table.insert(battery_info, { status = status, charge = tonumber(charge_str) })
                     else
                         local cap_str = string.match(s, '.+:.+last full capacity (%d+)')
                         table.insert(capacities, tonumber(cap_str))
@@ -90,11 +109,11 @@ watch("acpi -i", 10,
                 widget.value = charge / 100
 
                 if status == 'Charging' then
-                text_with_background.bg = beautiful.widget_green
-                text_with_background.fg = beautiful.widget_black
+                    text_with_background.bg = full_level_color
+                    text_with_background.fg = '#000000'
                 else
-                text_with_background.bg = beautiful.widget_transparent
-                text_with_background.fg = beautiful.widget_main_color
+                    text_with_background.bg = '#00000000'
+                    text_with_background.fg = text_color
                 end
 
                 --- if battery is fully charged (100) there is not enough place for three digits, so we don't show any text
@@ -103,7 +122,7 @@ watch("acpi -i", 10,
                         or string.format('%d', charge)
 
                 if charge < 15 then
-                batteryarc.colors = { beautiful.widget_red }
+                    widget.colors = { low_level_color }
                     if status ~= 'Charging' and os.difftime(os.time(), last_battery_check) > 300 then
                         -- if 5 minutes have elapsed since the last warning
                         last_battery_check = os.time()
@@ -111,17 +130,17 @@ watch("acpi -i", 10,
                         show_battery_warning()
                     end
                 elseif charge > 15 and charge < 40 then
-                batteryarc.colors = { beautiful.widget_yellow }
+                    widget.colors = { medium_level_color }
                 else
-                batteryarc.colors = { beautiful.widget_main_color }
+                    widget.colors = { full_level_color }
                 end
             end,
-        batteryarc)
+            widget)
 
--- Popup with battery info
--- One way of creating a pop-up notification - naughty.notify
-local notification
-function show_battery_status()
+    -- Popup with battery info
+    -- One way of creating a pop-up notification - naughty.notify
+    local notification
+    function show_battery_status()
         awful.spawn.easy_async([[bash -c 'acpi']],
                 function(stdout, _, _, _)
                     naughty.destroy(notification)
@@ -133,34 +152,44 @@ function show_battery_status()
                         width = 200,
                     }
                 end)
-end
+    end
 
-batteryarc:connect_signal("mouse::enter", function() show_battery_status() end)
-batteryarc:connect_signal("mouse::leave", function() naughty.destroy(notification) end)
+    widget:connect_signal("mouse::enter", function()
+        show_battery_status()
+    end)
+    widget:connect_signal("mouse::leave", function()
+        naughty.destroy(notification)
+    end)
 
--- Alternative to naughty.notify - tooltip. You can compare both and choose the preferred one
+    -- Alternative to naughty.notify - tooltip. You can compare both and choose the preferred one
 
---battery_popup = awful.tooltip({objects = {battery_widget}})
+    --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
+    -- 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
 
---[[ Show warning notification ]]
-function show_battery_warning()
+    --[[ Show warning notification ]]
+    function show_battery_warning()
         naughty.notify {
-        icon = HOME .. "/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg",
+            icon = warning_msg_icon,
             icon_size = 100,
-        text = "Battery is dying", -- switch text and title
-        title = "Huston, we have a problem",
+            text = warning_msg_text,
+            title = warning_msg_title,
             timeout = 25, -- show the warning for a longer time
             hover_timeout = 0.5,
-        position = "bottom_right",
+            position = warning_msg_position,
             bg = "#F06060",
             fg = "#EEE9EF",
             width = 300,
         }
+    end
+
+    return widget
+
 end
 
-return batteryarc
+return setmetatable(widget, { __call = function(_, ...)
+    return worker(...)
+end })