summaryrefslogtreecommitdiff
path: root/volumearc-widget
diff options
context:
space:
mode:
Diffstat (limited to 'volumearc-widget')
-rw-r--r--volumearc-widget/README.md47
-rw-r--r--volumearc-widget/custom.pngbin0 -> 9424 bytes
-rw-r--r--volumearc-widget/volumearc.lua94
3 files changed, 99 insertions, 42 deletions
diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md
index 702b486..0ae17b4 100644
--- a/volumearc-widget/README.md
+++ b/volumearc-widget/README.md
@@ -1,17 +1,54 @@
# Volumearc widget
-Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using arcchart:
+Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using [arcchart](https://awesomewm.org/doc/api/classes/wibox.container.arcchart.html):
![screenshot](out.gif)
-Supports:
- - scroll up - increase volume,
- - scroll down - decrease volume,
+Supports
+ - scroll up - increase volume,
+ - scroll down - decrease volume,
- left click - mute/unmute.
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `main_color` | `beautiful.fg_normal` | Color of the arc |
+| `mute_color` | `beautiful.fg_urgent` | Color of the arc when mute |
+| `path_to_icon` | /usr/share/icons/Arc/status/symbolic/audio-volume-muted-symbolic.svg | Path to the icon |
+| `thickness` | 2 | The arc thickness |
+| `height` | `beautiful.fg_normal` | Widget height |
+| `get_volume_cmd` | `amixer -D pulse sget Master` | Get current volume level |
+| `inc_volume_cmd` | `amixer -D pulse sset Master 5%+` | Increase volume level |
+| `dec_volume_cmd` | `amixer -D pulse sset Master 5%-` | Descrease volume level |
+| `tog_volume_cmd` | `amixer -D pulse sset Master toggle` | Mute / unmute |
+
+### Example:
+
+```lua
+volumearc_widget({
+ main_color = '#af13f7',
+ mute_color = '#ff0000',
+ thickness = 5,
+ height = 25
+})
+```
+
+The config above results in the following widget:
+
+![custom](./custom.png)
+
## Installation
-Clone repo, include widget and use it in **rc.lua**:
+1. Clone this repo under **~/.config/awesome/**
+
+ ```bash
+ git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+ ```
+
+1. Require volumearc widget at the beginning of **rc.lua**:
```lua
require("volumearc")
diff --git a/volumearc-widget/custom.png b/volumearc-widget/custom.png
new file mode 100644
index 0000000..f187345
--- /dev/null
+++ b/volumearc-widget/custom.png
Binary files differ
diff --git a/volumearc-widget/volumearc.lua b/volumearc-widget/volumearc.lua
index 63500bc..62b18ab 100644
--- a/volumearc-widget/volumearc.lua
+++ b/volumearc-widget/volumearc.lua
@@ -21,47 +21,67 @@ local TOG_VOLUME_CMD = 'amixer -D pulse sset Master toggle'
local PATH_TO_ICON = "/usr/share/icons/Arc/status/symbolic/audio-volume-muted-symbolic.svg"
-local icon = {
- id = "icon",
- image = PATH_TO_ICON,
- resize = true,
- widget = wibox.widget.imagebox,
-}
-
-local volumearc = wibox.widget {
- icon,
- max_value = 1,
- thickness = 2,
- start_angle = 4.71238898, -- 2pi*3/4
- forced_height = 18,
- forced_width = 18,
- bg = "#ffffff11",
- paddings = 2,
- widget = wibox.container.arcchart
-}
-
-local update_graphic = function(widget, stdout, _, _, _)
- local mute = string.match(stdout, "%[(o%D%D?)%]")
- local volume = string.match(stdout, "(%d?%d?%d)%%")
- volume = tonumber(string.format("% 3d", volume))
-
- widget.value = volume / 100;
- widget.colors = mute == 'off' and { beautiful.widget_red }
- or { beautiful.widget_main_color }
+local widget = {}
-end
+local function worker(args)
+
+ local args = args or {}
+
+ local main_color = args.main_color or beautiful.fg_color
+ local mute_color = args.mute_color or beautiful.fg_urgent
+ local path_to_icon = args.path_to_icon or PATH_TO_ICON
+ local thickness = args.thickness or 2
+ local height = args.height or 18
+
+ local get_volume_cmd = args.get_volume_cmd or GET_VOLUME_CMD
+ local inc_volume_cmd = args.inc_volume_cmd or INC_VOLUME_CMD
+ local dec_volume_cmd = args.dec_volume_cmd or DEC_VOLUME_CMD
+ local tog_volume_cmd = args.tog_volume_cmd or TOG_VOLUME_CMD
+
+ local icon = {
+ id = "icon",
+ image = path_to_icon,
+ resize = true,
+ widget = wibox.widget.imagebox,
+ }
-volumearc:connect_signal("button::press", function(_, _, _, button)
- if (button == 4) then awful.spawn(INC_VOLUME_CMD, false)
- elseif (button == 5) then awful.spawn(DEC_VOLUME_CMD, false)
- elseif (button == 1) then awful.spawn(TOG_VOLUME_CMD, false)
+ local volumearc = wibox.widget {
+ icon,
+ max_value = 1,
+ thickness = thickness,
+ start_angle = 4.71238898, -- 2pi*3/4
+ forced_height = height,
+ forced_width = height,
+ bg = "#ffffff11",
+ paddings = 2,
+ widget = wibox.container.arcchart
+ }
+
+ local update_graphic = function(widget, stdout, _, _, _)
+ local mute = string.match(stdout, "%[(o%D%D?)%]") -- \[(o\D\D?)\] - [on] or [off]
+ local volume = string.match(stdout, "(%d?%d?%d)%%") -- (\d?\d?\d)\%)
+ volume = tonumber(string.format("% 3d", volume))
+
+ widget.value = volume / 100;
+ widget.colors = mute == 'off'
+ and { mute_color }
+ or { main_color }
end
- spawn.easy_async(GET_VOLUME_CMD, function(stdout, stderr, exitreason, exitcode)
- update_graphic(volumearc, stdout, stderr, exitreason, exitcode)
+ volumearc:connect_signal("button::press", function(_, _, _, button)
+ if (button == 4) then awful.spawn(inc_volume_cmd, false)
+ elseif (button == 5) then awful.spawn(dec_volume_cmd, false)
+ elseif (button == 1) then awful.spawn(tog_volume_cmd, false)
+ end
+
+ spawn.easy_async(get_volume_cmd, function(stdout, stderr, exitreason, exitcode)
+ update_graphic(volumearc, stdout, stderr, exitreason, exitcode)
+ end)
end)
-end)
-watch(GET_VOLUME_CMD, 1, update_graphic, volumearc)
+ watch(get_volume_cmd, 1, update_graphic, volumearc)
+
+ return volumearc
+end
-return volumearc \ No newline at end of file
+return setmetatable(widget, { __call = function(_, ...) return worker(...) end })