Merge branch '74-externalize-config' of github.com:streetturtle/awesome-wm-widgets into 74-externalize-config

4 files changed, 82 insertions, 32 deletions

diff --git a/cpu-widget/README.md b/cpu-widget/README.md
index 500e1b9..31fb0d6 100644
--- a/cpu-widget/README.md
+++ b/cpu-widget/README.md
@@ -2,9 +2,7 @@
 
 This widget shows the average CPU load among all cores of the machine:
 
-![screenshot](out.gif)
-
-When the load is more than 80% the graph becomes red. You can easily customize the widget by changing colors, step width, step spacing, width and interval.
+![screenshot](cpu.gif)
 
 ## How it works
 
@@ -18,6 +16,32 @@ cpu  197294 718 50102 2002182 3844 0 2724 0 0 0
 
 and calculates the percentage.
 
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `width` | 50 | Width of the widget |
+| `step_width` | 2 | Width of the step |
+| `step_spacing` | 1 | Space size between steps |
+| `color` | `beautiful.fg_normal` | Color of the graph |
+
+### Example
+
+```lua
+cpu_widget({
+    width = 70,
+    step_width = 2,
+    step_spacing = 0,
+    color = '#434c5e'
+})
+```
+
+The config above results in the following widget:
+
+![custom](./custom.png)
+
 ## Installation
 
 Clone/download repo and use widget in **rc.lua**:
@@ -29,6 +53,14 @@ s.mytasklist, -- Middle widget
 	{ -- Right widgets
     	layout = wibox.layout.fixed.horizontal,
 		...
-		cpu_widget,
+		-- default
+		cpu_widget(),
+		-- or custom
+		cpu_widget({
+            width = 70,
+            step_width = 2,
+            step_spacing = 0,
+            color = '#434c5e'
+        })
 		...
 ```
diff --git a/cpu-widget/cpu-widget.lua b/cpu-widget/cpu-widget.lua
index 88ebea9..0e027dd 100644
--- a/cpu-widget/cpu-widget.lua
+++ b/cpu-widget/cpu-widget.lua
@@ -10,40 +10,58 @@
 
 local watch = require("awful.widget.watch")
 local wibox = require("wibox")
+local beautiful = require("beautiful")
 
-local cpugraph_widget = wibox.widget {
-    max_value = 100,
-    background_color = "#00000000",
-    forced_width = 50,
-    step_width = 2,
-    step_spacing = 1,
-    widget = wibox.widget.graph,
-    color = "linear:0,0:0,22:0,#FF0000:0.3,#FFFF00:0.5,#74aeab"
-}
+local widget = {}
 
---- By default graph widget goes from left to right, so we mirror it and push up a bit
-local cpu_widget = wibox.container.margin(wibox.container.mirror(cpugraph_widget, { horizontal = true }), 0, 0, 0, 2)
+local function worker(args)
 
-local total_prev = 0
-local idle_prev = 0
+    local args = args or {}
 
-watch([[bash -c "cat /proc/stat | grep '^cpu '"]], 1,
-    function(widget, stdout)
-        local user, nice, system, idle, iowait, irq, softirq, steal, guest, guest_nice =
-        stdout:match('(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s')
+    local width = args.width or 50
+    local step_width = args.step_width or 2
+    local step_spacing = args.step_spacing or 1
+    local color= args.color or beautiful.fg_normal
 
-        local total = user + nice + system + idle + iowait + irq + softirq + steal
+    local cpugraph_widget = wibox.widget {
+        max_value = 100,
+        background_color = "#00000000",
+        forced_width = width,
+        step_width = step_width,
+        step_spacing = step_spacing,
+        widget = wibox.widget.graph,
+        color = "linear:0,0:0,20:0,#FF0000:0.3,#FFFF00:0.6," .. color
+    }
 
-        local diff_idle = idle - idle_prev
-        local diff_total = total - total_prev
-        local diff_usage = (1000 * (diff_total - diff_idle) / diff_total + 5) / 10
+    --- By default graph widget goes from left to right, so we mirror it and push up a bit
+    local cpu_widget = wibox.container.margin(wibox.container.mirror(cpugraph_widget, { horizontal = true }), 0, 0, 0, 2)
 
-        widget:add_value(diff_usage)
+    local total_prev = 0
+    local idle_prev = 0
 
-        total_prev = total
-        idle_prev = idle
-    end,
-    cpugraph_widget
-)
+    watch([[bash -c "cat /proc/stat | grep '^cpu '"]], 1,
+            function(widget, stdout)
+                local user, nice, system, idle, iowait, irq, softirq, steal, guest, guest_nice =
+                        stdout:match('(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s(%d+)%s')
 
-return cpu_widget
+                local total = user + nice + system + idle + iowait + irq + softirq + steal
+
+                local diff_idle = idle - idle_prev
+                local diff_total = total - total_prev
+                local diff_usage = (1000 * (diff_total - diff_idle) / diff_total + 5) / 10
+
+                widget:add_value(diff_usage)
+
+                total_prev = total
+                idle_prev = idle
+            end,
+            cpugraph_widget
+    )
+
+    return cpu_widget
+
+end
+
+return setmetatable(widget, { __call = function(_, ...)
+    return worker(...)
+end })
diff --git a/cpu-widget/cpu.gif b/cpu-widget/cpu.gif
new file mode 100644
index 0000000..086e618
--- /dev/null
+++ b/cpu-widget/cpu.gif
diff --git a/cpu-widget/custom.png b/cpu-widget/custom.png
new file mode 100644
index 0000000..be275e4
--- /dev/null
+++ b/cpu-widget/custom.png