summaryrefslogtreecommitdiff
path: root/batteryarc-widget
diff options
context:
space:
mode:
authorPavel Makhov <pmakhov@theoctavegroup.com>2019-09-17 15:29:36 -0400
committerPavel Makhov <pmakhov@theoctavegroup.com>2019-09-17 15:29:36 -0400
commit6fd76c254b296da86619b43db619ccebcd521853 (patch)
treea005c8045bbee2998642c55fd5edadb258ea87de /batteryarc-widget
parent372ae3c9e7cab4b64b8dcaf31d9d2d921a723585 (diff)
parent2e211937a116102c3647b85070718102192ddc54 (diff)
Merge branch '74-externalize-config'
Note: breaking change, now widgets should be created with parentheses, i.e. battery(), instead of battery. Read more in README of the widget.
Diffstat (limited to 'batteryarc-widget')
-rw-r--r--batteryarc-widget/README.md43
-rw-r--r--batteryarc-widget/batteryarc.lua314
-rw-r--r--batteryarc-widget/warning.pngbin0 -> 13496 bytes
3 files changed, 203 insertions, 154 deletions
diff --git a/batteryarc-widget/README.md b/batteryarc-widget/README.md
index cb73e09..026180e 100644
--- a/batteryarc-widget/README.md
+++ b/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
-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.
+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` | 2 | Thickness of the arc |
+| `show_current_level`| false | Show current charge level |
+| `main_color` | `beautiful.fg_color` | Color of the text with the current charge level and the arc |
+| `low_level_color` | #e53935 | Arc color when battery charge is less that 15% |
+| `medium_level_color` | #c0ca33 | Arc color when battery charge is between 15% and 40% |
+| `charging` | `beautiful.fg_color` | Color of the circle inside the arc when charging |
+| `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
@@ -35,11 +44,17 @@ s.mytasklist, -- Middle widget
{ -- Right widgets
layout = wibox.layout.fixed.horizontal,
...
- batteryarc_widget,
- ...
+ --[[default]]
+ batteryarc_widget(),
+ --[[or customized]]
+ batteryarc_widget({
+ show_current_level = true,
+ thickness = '1',
+ }),
+ }
+ ...
```
-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).
diff --git a/batteryarc-widget/batteryarc.lua b/batteryarc-widget/batteryarc.lua
index a15151f..7a7109f 100644
--- a/batteryarc-widget/batteryarc.lua
+++ b/batteryarc-widget/batteryarc.lua
@@ -16,151 +16,185 @@ local watch = require("awful.widget.watch")
local HOME = os.getenv("HOME")
-local text = wibox.widget {
- id = "txt",
- font = "Play 6",
- align = 'center', -- align the text
- valign = 'center',
- widget = wibox.widget.textbox
-}
-
-local text_with_background = wibox.container.background(text)
-
-local batteryarc = wibox.widget {
- text_with_background,
- max_value = 1,
- rounded_edge = true,
- thickness = 2,
- start_angle = 4.71238898, -- 2pi*3/4
- forced_height = 18,
- forced_width = 18,
- bg = "#ffffff11",
- paddings = 2,
- widget = wibox.container.arcchart,
- set_value = function(self, value)
- self.value = value
- end,
-}
-
-local last_battery_check = os.time()
-
-watch("acpi -i", 10,
- function(widget, stdout)
- local batteryType
-
- local battery_info = {}
- local capacities = {}
- for s in stdout:gmatch("[^\r\n]+") do
- local status, charge_str, time = string.match(s, '.+: (%a+), (%d?%d?%d)%%,?.*')
- if string.match(s, 'rate information') then
- -- ignore such line
- elseif status ~= nil then
- table.insert(battery_info, {status = status, charge = tonumber(charge_str)})
+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 show_current_level = args.show_current_level or false
+
+ local main_color = args.main_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 charging_color = args.charging_color or '#43a047'
+
+ 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 = font,
+ align = 'center', -- align the text
+ valign = 'center',
+ widget = wibox.widget.textbox
+ }
+
+ local text_with_background = wibox.container.background(text)
+
+ widget = wibox.widget {
+ text_with_background,
+ max_value = 1,
+ rounded_edge = true,
+ thickness = arc_thickness,
+ start_angle = 4.71238898, -- 2pi*3/4
+ forced_height = 18,
+ forced_width = 18,
+ bg = "#ffffff11",
+ paddings = 2,
+ widget = wibox.container.arcchart,
+ set_value = function(self, value)
+ self.value = value
+ end,
+ }
+
+ local last_battery_check = os.time()
+
+ watch("acpi -i", 10,
+ function(widget, stdout)
+ local batteryType
+
+ local battery_info = {}
+ local capacities = {}
+ for s in stdout:gmatch("[^\r\n]+") do
+ local status, charge_str, time = string.match(s, '.+: (%a+), (%d?%d?%d)%%,?.*')
+ if string.match(s, 'rate information') then
+ -- ignore such line
+ elseif status ~= nil then
+ 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))
+ end
+ end
+
+ local capacity = 0
+ for i, cap in ipairs(capacities) do
+ capacity = capacity + cap
+ end
+
+ local charge = 0
+ local status
+ for i, batt in ipairs(battery_info) do
+ if batt.charge >= charge then
+ -- use most charged battery status. This is arbitrary, and maybe another metric should be used
+ status = batt.status
+ end
+
+ charge = charge + batt.charge * capacities[i]
+ end
+
+ local charge_percentage
+ if capacity > 5 then
+ charge = charge / capacity
+ charge_percentage = charge / 100
+ else
+ -- when widget.value is < 0.04, the widget shows a full circle (as widget.value=1)
+ charge_percentage = 0.05
+ end
+
+ widget.value = charge / 100
+
+ if status == 'Charging' then
+ text_with_background.bg = charging_color
+ text_with_background.fg = '#000000'
else
- local cap_str = string.match(s, '.+:.+last full capacity (%d+)')
- table.insert(capacities, tonumber(cap_str))
+ text_with_background.bg = '#00000000'
+ text_with_background.fg = main_color
end
- end
-
- local capacity = 0
- for i, cap in ipairs(capacities) do
- capacity = capacity + cap
- end
-
- local charge = 0
- local status
- for i, batt in ipairs(battery_info) do
- if batt.charge >= charge then
- -- use most charged battery status. This is arbitrary, and maybe another metric should be used
- status = batt.status
+
+ if show_current_level == true then
+ --- if battery is fully charged (100) there is not enough place for three digits, so we don't show any text
+ text.text = charge == 100
+ and ''
+ or string.format('%d', charge)
+ else
+ text.text = ''
end
- charge = charge + batt.charge * capacities[i]
- end
-
- local charge_percentage
- if capacity > 5 then
- charge = charge / capacity
- charge_percentage = charge / 100
- else
- -- when widget.value is < 0.04, the widget shows a full circle (as widget.value=1)
- charge_percentage = 0.05
- end
-
- widget.value = charge / 100
-
- if status == 'Charging' then
- text_with_background.bg = beautiful.widget_green
- text_with_background.fg = beautiful.widget_black
- else
- text_with_background.bg = beautiful.widget_transparent
- text_with_background.fg = beautiful.widget_main_color
- end
-
- --- if battery is fully charged (100) there is not enough place for three digits, so we don't show any text
- text.text = charge == 100
- and ''
- or string.format('%d', charge)
-
- if charge < 15 then
- batteryarc.colors = { beautiful.widget_red }
- 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()
-
- show_battery_warning()
+ if charge < 15 then
+ 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()
+
+ show_battery_warning()
+ end
+ elseif charge > 15 and charge < 40 then
+ widget.colors = { medium_level_color }
+ else
+ widget.colors = { main_color }
end
- elseif charge > 15 and charge < 40 then
- batteryarc.colors = { beautiful.widget_yellow }
- else
- batteryarc.colors = { beautiful.widget_main_color }
- end
- end,
- batteryarc)
-
--- 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)
- notification = naughty.notify {
- text = stdout,
- title = "Battery status",
- timeout = 5,
- hover_timeout = 0.5,
- width = 200,
- }
- end)
-end
+ end,
+ widget)
+
+ -- 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)
+ notification = naughty.notify {
+ text = stdout,
+ title = "Battery status",
+ timeout = 5,
+ hover_timeout = 0.5,
+ width = 200,
+ }
+ end)
+ 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
+
+ --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
+
+ --[[ Show warning notification ]]
+ 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
+
+ return widget
-batteryarc:connect_signal("mouse::enter", function() show_battery_status() end)
-batteryarc:connect_signal("mouse::leave", function() naughty.destroy(notification) 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
-
---[[ Show warning notification ]]
-function show_battery_warning()
- naughty.notify {
- icon = HOME .. "/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg",
- icon_size = 100,
- text = "Battery is dying", -- switch text and title
- title = "Huston, we have a problem",
- timeout = 25, -- show the warning for a longer time
- hover_timeout = 0.5,
- position = "bottom_right",
- bg = "#F06060",
- fg = "#EEE9EF",
- width = 300,
- }
end
-return batteryarc
+return setmetatable(widget, { __call = function(_, ...)
+ return worker(...)
+end })
diff --git a/batteryarc-widget/warning.png b/batteryarc-widget/warning.png
new file mode 100644
index 0000000..55ca790
--- /dev/null
+++ b/batteryarc-widget/warning.png
Binary files differ