]> git.madduck.net Git - etc/awesome.git/blob - 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:

battery: safety checks; #208
[etc/awesome.git] / widgets / bat.lua
1
2 --[[
3                                                                                                                         
4          Licensed under GNU General Public License v2 
5           * (c) 2013,      Luke Bonham                
6           * (c) 2010-2012, Peter Hofmann              
7                                                                                                                         
8 --]]
9
10 local newtimer     = require("lain.helpers").newtimer
11 local first_line   = require("lain.helpers").first_line
12
13 local naughty      = require("naughty")
14 local wibox        = require("wibox")
15
16 local math         = { abs    = math.abs,
17                        floor  = math.floor,
18                        log10  = math.log10,
19                        min    = math.min }
20 local string       = { format = string.format }
21
22 local tonumber     = tonumber
23 local setmetatable = setmetatable
24
25 -- Battery infos
26 -- lain.widgets.bat
27
28 local function worker(args)
29     local bat       = {}
30     local args      = args or {}
31     local timeout   = args.timeout or 30
32     local batteries = args.batteries or (args.battery and {args.battery}) or {"BAT0"}
33     local ac        = args.ac or "AC0"
34     local notify    = args.notify or "on"
35     local settings  = args.settings or function() end
36
37     bat.widget = wibox.widget.textbox('')
38
39     bat_notification_low_preset = {
40         title   = "Battery low",
41         text    = "Plug the cable!",
42         timeout = 15,
43         fg      = "#202020",
44         bg      = "#CDCDCD"
45     }
46
47     bat_notification_critical_preset = {
48         title   = "Battery exhausted",
49         text    = "Shutdown imminent",
50         timeout = 15,
51         fg      = "#000000",
52         bg      = "#FFFFFF"
53     }
54
55     bat_now = {
56         status    = "N/A",
57         ac_status = "N/A",
58         perc      = "N/A",
59         time      = "N/A",
60         watt      = "N/A"
61     }
62
63     bat_now.n_status = {}
64     for i = 1, #batteries do
65         bat_now.n_status[i] = "N/A"
66     end
67
68     function update()
69         local sum_rate_current      = 0
70         local sum_rate_voltage      = 0
71         local sum_rate_power        = 0
72         local sum_rate_energy       = 0
73         local sum_energy_now        = 0
74         local sum_energy_full       = 0
75         local sum_energy_percentage = 0
76         local pspath                = "/sys/class/power_supply/"
77
78         for i, battery in ipairs(batteries) do
79             local bstr    = pspath .. battery
80             local present = first_line(bstr .. "/present")
81
82             if tonumber(present) == 1 then
83                 -- current_now(I)[uA], voltage_now(U)[uV], power_now(P)[uW]
84                 local rate_current      = tonumber(first_line(bstr .. "/current_now"))
85                 local rate_voltage      = tonumber(first_line(bstr .. "/voltage_now"))
86                 local rate_power        = tonumber(first_line(bstr .. "/power_now"))
87
88                 -- energy_now(P)[uWh], charge_now(I)[uAh]
89                 local energy_now        = tonumber(first_line(bstr .. "/energy_now") or
90                                           first_line(bstr .. "/charge_now"))
91
92                 -- energy_full(P)[uWh], charge_full(I)[uAh]
93                 local energy_full       = tonumber(first_line(bstr .. "/energy_full") or
94                                           first_line(bstr .. "/charge_full"))
95
96                 local energy_percentage = tonumber(first_line(bstr .. "/capacity")) or
97                                           math.floor((energy_now / energy_full) * 100)
98
99                 bat_now.n_status[i] = first_line(bstr .. "/status") or "N/A"
100
101                 sum_rate_current      = sum_rate_current + (rate_current or 0)
102                 sum_rate_voltage      = sum_rate_voltage + (rate_voltage or 0)
103                 sum_rate_power        = sum_rate_power + (rate_power or 0)
104                 sum_rate_energy       = sum_rate_energy + (rate_power or (((rate_voltage or 0) * (rate_current or 0)) / 1e6))
105                 sum_energy_now        = sum_energy_now + (energy_now or 0)
106                 sum_energy_full       = sum_energy_full + (energy_full or 0)
107                 sum_energy_percentage = sum_energy_percentage + (energy_percentage or 0)
108             end
109         end
110
111         bat_now.status = bat_now.n_status[1]
112         bat_now.ac_status = tonumber(first_line(string.format("%s%s/online", pspath, ac))) or "N/A"
113
114         if bat_now.status ~= "N/A" then
115             -- update {perc,time,watt} iff battery not full and rate > 0
116             if bat_now.status ~= "Full" and (sum_rate_power > 0 or sum_rate_current > 0) then
117                 local rate_time = 0
118                 local div = (sum_rate_power > 0 and sum_rate_power) or sum_rate_current
119
120                 if bat_now.status == "Charging" then
121                     rate_time = (sum_energy_full - sum_energy_now) / div
122                 else -- Discharging
123                     rate_time = sum_energy_now / div
124                 end
125
126                 if rate_time < 0.01 then -- check for magnitude discrepancies (#199)
127                     rate_time_magnitude = math.abs(math.floor(math.log10(rate_time)))
128                     rate_time = rate_time * 10^(rate_time_magnitude - 2)
129                 end
130
131                 local hours     = math.floor(rate_time)
132                 local minutes   = math.floor((rate_time - hours) * 60)
133                 bat_now.perc    = tonumber(string.format("%d", math.min(100, sum_energy_percentage / #batteries)))
134                 bat_now.time    = string.format("%02d:%02d", hours, minutes)
135                 bat_now.watt    = tonumber(string.format("%.2f", sum_rate_energy / 1e6))
136             elseif bat_now.status == "Full" then
137                 bat_now.perc    = 100
138                 bat_now.time    = "00:00"
139                 bat_now.watt    = 0
140             end
141         end
142
143         widget = bat.widget
144         settings()
145
146         -- notifications for low and critical states
147         if notify == "on" and bat_now.perc and bat_now.status == "Discharging" then
148             if bat_now.perc <= 5 then
149                 bat.id = naughty.notify({
150                     preset = bat_notification_critical_preset,
151                     replaces_id = bat.id
152                 }).id
153             elseif bat_now.perc <= 15 then
154                 bat.id = naughty.notify({
155                     preset = bat_notification_low_preset,
156                     replaces_id = bat.id
157                 }).id
158             end
159         end
160     end
161
162     newtimer(battery, timeout, update)
163
164     return setmetatable(bat, { __index = bat.widget })
165 end
166
167 return setmetatable({}, { __call = function(_, ...) return worker(...) end })