]> git.madduck.net Git - etc/awesome.git/blobdiff - widgets/bat.lua

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

renaming rockspec file and adding optional dependencies as regular dependencies
[etc/awesome.git] / widgets / bat.lua
index a064e304054047a110ed16b5cfd77e9fe5ba419f..991885a7aab82d0830c1062289594ed5de8a5afe 100644 (file)
@@ -1,10 +1,10 @@
 
 --[[
-                                                  
-     Licensed under GNU General Public License v2 
-      * (c) 2013,      Luke Bonham                
-      * (c) 2010-2012, Peter Hofmann              
-                                                  
+                                                                                                                       
+        Licensed under GNU General Public License v2 
+         * (c) 2013,      Luke Bonham                
+         * (c) 2010-2012, Peter Hofmann              
+                                                                                                                       
 --]]
 
 local newtimer     = require("lain.helpers").newtimer
@@ -13,126 +13,161 @@ local first_line   = require("lain.helpers").first_line
 local naughty      = require("naughty")
 local wibox        = require("wibox")
 
-local math         = { floor  = math.floor }
+local math         = { abs    = math.abs,
+                       floor  = math.floor,
+                       log10  = math.log10,
+                       min    = math.min }
 local string       = { format = string.format }
-local tonumber     = tonumber
 
+local type         = type
+local tonumber     = tonumber
 local setmetatable = setmetatable
 
 -- Battery infos
 -- lain.widgets.bat
-local bat = {}
 
 local function worker(args)
-    local args = args or {}
-    local timeout = args.timeout or 30
-    local battery = args.battery or "BAT0"
-    local settings = args.settings or function() end
+    local bat       = {}
+    local args      = args or {}
+    local timeout   = args.timeout or 30
+    local batteries = args.batteries or (args.battery and {args.battery}) or {"BAT0"}
+    local ac        = args.ac or "AC0"
+    local notify    = args.notify or "on"
+    local settings  = args.settings or function() end
 
     bat.widget = wibox.widget.textbox('')
 
-    function update()
-        bat_now = {
-            status = "Not present",
-            perc   = "N/A",
-            time   = "N/A",
-            watt   = "N/A"
-        }
-
-        local bstr  = "/sys/class/power_supply/" .. battery
-
-        local present = first_line(bstr .. "/present")
-
-        if present == "1"
-        then
-            local rate  = first_line(bstr .. "/power_now") or
-                          first_line(bstr .. "/current_now")
-
-            local ratev = first_line(bstr .. "/voltage_now")
-
-            local rem   = first_line(bstr .. "/energy_now") or
-                          first_line(bstr .. "/charge_now")
-
-            local tot   = first_line(bstr .. "/energy_full") or
-                          first_line(bstr .. "/charge_full")
-
-            bat_now.status = first_line(bstr .. "/status") or "N/A"
-
-            rate  = tonumber(rate)
-            ratev = tonumber(ratev)
-            rem   = tonumber(rem)
-            tot   = tonumber(tot)
+    bat_notification_low_preset = {
+        title   = "Battery low",
+        text    = "Plug the cable!",
+        timeout = 15,
+        fg      = "#202020",
+        bg      = "#CDCDCD"
+    }
+
+    bat_notification_critical_preset = {
+        title   = "Battery exhausted",
+        text    = "Shutdown imminent",
+        timeout = 15,
+        fg      = "#000000",
+        bg      = "#FFFFFF"
+    }
+
+    bat_now = {
+        status    = "N/A",
+        ac_status = "N/A",
+        perc      = "N/A",
+        time      = "N/A",
+        watt      = "N/A"
+    }
+
+    bat_now.n_status = {}
+    bat_now.n_perc   = {}
+    for i = 1, #batteries do
+        bat_now.n_status[i] = "N/A"
+        bat_now.n_perc[i] = 0
+    end
 
-            local time_rat = 0
-            if bat_now.status == "Charging"
-            then
-                time_rat = (tot - rem) / rate
-            elseif bat_now.status == "Discharging"
-            then
-                time_rat = rem / rate
+    function update()
+        local sum_rate_current = 0
+        local sum_rate_voltage = 0
+        local sum_rate_power   = 0
+        local sum_rate_energy  = 0
+        local sum_energy_now   = 0
+        local sum_energy_full  = 0
+        local pspath           = "/sys/class/power_supply/"
+
+        for i, battery in ipairs(batteries) do
+            local bstr    = pspath .. battery
+            local present = first_line(bstr .. "/present")
+
+            if tonumber(present) == 1 then
+                -- current_now(I)[uA], voltage_now(U)[uV], power_now(P)[uW]
+                local rate_current = tonumber(first_line(bstr .. "/current_now"))
+                local rate_voltage = tonumber(first_line(bstr .. "/voltage_now"))
+                local rate_power   = tonumber(first_line(bstr .. "/power_now"))
+
+                -- energy_now(P)[uWh], charge_now(I)[uAh]
+                local energy_now        = tonumber(first_line(bstr .. "/energy_now") or
+                                          first_line(bstr .. "/charge_now"))
+
+                -- energy_full(P)[uWh], charge_full(I)[uAh]
+                local energy_full       = tonumber(first_line(bstr .. "/energy_full") or
+                                          first_line(bstr .. "/charge_full"))
+
+                local energy_percentage = tonumber(first_line(bstr .. "/capacity")) or
+                                          math.floor((energy_now / energy_full) * 100)
+
+                bat_now.n_status[i] = first_line(bstr .. "/status") or "N/A"
+                bat_now.n_perc[i]   = energy_percentage or bat_now.n_perc[i]
+
+                sum_rate_current = sum_rate_current + (rate_current or 0)
+                sum_rate_voltage = sum_rate_voltage + (rate_voltage or 0)
+                sum_rate_power   = sum_rate_power + (rate_power or 0)
+                sum_rate_energy  = sum_rate_energy + (rate_power or (((rate_voltage or 0) * (rate_current or 0)) / 1e6))
+                sum_energy_now   = sum_energy_now + (energy_now or 0)
+                sum_energy_full  = sum_energy_full + (energy_full or 0)
             end
+        end
 
-            local hrs = math.floor(time_rat)
-            if hrs < 0 then hrs = 0 elseif hrs > 23 then hrs = 23 end
-
-            local min = math.floor((time_rat - hrs) * 60)
-            if min < 0 then min = 0 elseif min > 59 then min = 59 end
-
-            bat_now.time = string.format("%02d:%02d", hrs, min)
+        bat_now.status = bat_now.n_status[1]
+        bat_now.ac_status = tonumber(first_line(string.format("%s%s/online", pspath, ac))) or "N/A"
 
-            local perc = (rem / tot) * 100
-            if perc <= 100 then
-                bat_now.perc = string.format("%d", perc)
-            elseif perc > 100 then
-                bat_now.perc = "100"
-            elseif perc < 0 then
-                bat_now.perc = "0"
-            end
+        if bat_now.status ~= "N/A" then
+            -- update {perc,time,watt} iff battery not full and rate > 0
+            if bat_now.status ~= "Full" and (sum_rate_power > 0 or sum_rate_current > 0) then
+                local rate_time = 0
+                local div = (sum_rate_power > 0 and sum_rate_power) or sum_rate_current
 
-            if rate ~= nil and ratev ~= nil then
-                bat_now.watt = string.format("%.2fW", (rate * ratev) / 1e12)
-            else
-                bat_not.watt = "N/A"
-            end
+                if bat_now.status == "Charging" then
+                    rate_time = (sum_energy_full - sum_energy_now) / div
+                else -- Discharging
+                    rate_time = sum_energy_now / div
+                end
 
-            -- notifications for low and critical states
-            if bat_now.status == "Discharging"
-            then
-                if tonumber(bat_now.perc) <= 5
-                then
-                    bat.id = naughty.notify({
-                        text = "shutdown imminent",
-                        title = "battery nearly exhausted",
-                        position = "top_right",
-                        timeout = 15,
-                        fg="#000000",
-                        bg="#ffffff",
-                        ontop = true,
-                        replaces_id = bat.id
-                    }).id
-                elseif tonumber(bat_now.perc) <= 15
-                then
-                    bat.id = naughty.notify({
-                        text = "plug the cable",
-                        title = "battery low",
-                        position = "top_right",
-                        timeout = 15,
-                        fg="#202020",
-                        bg="#cdcdcd",
-                        ontop = true,
-                        replaces_id = bat.id
-                    }).id
+                if 0 < rate_time and rate_time < 0.01 then -- check for magnitude discrepancies (#199)
+                    rate_time_magnitude = math.abs(math.floor(math.log10(rate_time)))
+                    rate_time = rate_time * 10^(rate_time_magnitude - 2)
                 end
+
+                local hours   = math.floor(rate_time)
+                local minutes = math.floor((rate_time - hours) * 60)
+                bat_now.perc  = math.floor(math.min(100, (sum_energy_now / sum_energy_full) * 100))
+                bat_now.time  = string.format("%02d:%02d", hours, minutes)
+                bat_now.watt  = tonumber(string.format("%.2f", sum_rate_energy / 1e6))
+            elseif bat_now.status ~= "Full" and sum_rate_power == 0 and bat_now.ac_status == 1 then
+                                                               bat_now.perc  = math.floor(math.min(100, (sum_energy_now / sum_energy_full) * 100))
+                                                               bat_now.time  = "00:00"
+                                                               bat_now.watt  = 0
+            elseif bat_now.status == "Full" then
+                bat_now.perc  = 100
+                bat_now.time  = "00:00"
+                bat_now.watt  = 0
             end
         end
 
         widget = bat.widget
         settings()
+
+        -- notifications for low and critical states
+        if notify == "on" and type(bat_now.perc) == "number" and bat_now.status == "Discharging" then
+            if bat_now.perc <= 5 then
+                bat.id = naughty.notify({
+                    preset = bat_notification_critical_preset,
+                    replaces_id = bat.id
+                }).id
+            elseif bat_now.perc <= 15 then
+                bat.id = naughty.notify({
+                    preset = bat_notification_low_preset,
+                    replaces_id = bat.id
+                }).id
+            end
+        end
     end
 
-    newtimer("bat", timeout, update)
+    newtimer(battery, timeout, update)
 
-    return bat.widget
+    return setmetatable(bat, { __index = bat.widget })
 end
 
-return setmetatable(bat, { __call = function(_, ...) return worker(...) end })
+return setmetatable({}, { __call = function(_, ...) return worker(...) end })