]> 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:

wiki updated
[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 first_line   = require("lain.helpers").first_line
11 local make_widget  = require("lain.helpers").make_widget_textbox
12 local newtimer     = require("lain.helpers").newtimer
13 local naughty      = require("naughty")
14 local wibox        = require("wibox")
15 local math         = { abs    = math.abs,
16                        floor  = math.floor,
17                        log10  = math.log10,
18                        min    = math.min }
19 local string       = { format = string.format }
20 local ipairs       = ipairs
21 local type         = type
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       = make_widget()
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_notification_low_preset = {
38         title   = "Battery low",
39         text    = "Plug the cable!",
40         timeout = 15,
41         fg      = "#202020",
42         bg      = "#CDCDCD"
43     }
44
45     bat_notification_critical_preset = {
46         title   = "Battery exhausted",
47         text    = "Shutdown imminent",
48         timeout = 15,
49         fg      = "#000000",
50         bg      = "#FFFFFF"
51     }
52
53     bat_now = {
54         status    = "N/A",
55         ac_status = "N/A",
56         perc      = "N/A",
57         time      = "N/A",
58         watt      = "N/A"
59     }
60
61     bat_now.n_status = {}
62     bat_now.n_perc   = {}
63     for i = 1, #batteries do
64         bat_now.n_status[i] = "N/A"
65         bat_now.n_perc[i] = 0
66     end
67
68     function bat.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 pspath           = "/sys/class/power_supply/"
76
77         for i, battery in ipairs(batteries) do
78             local bstr    = pspath .. battery
79             local present = first_line(bstr .. "/present")
80
81             if tonumber(present) == 1 then
82                 -- current_now(I)[uA], voltage_now(U)[uV], power_now(P)[uW]
83                 local rate_current = tonumber(first_line(bstr .. "/current_now"))
84                 local rate_voltage = tonumber(first_line(bstr .. "/voltage_now"))
85                 local rate_power   = tonumber(first_line(bstr .. "/power_now"))
86
87                 -- energy_now(P)[uWh], charge_now(I)[uAh]
88                 local energy_now        = tonumber(first_line(bstr .. "/energy_now") or
89                                           first_line(bstr .. "/charge_now"))
90
91                 -- energy_full(P)[uWh], charge_full(I)[uAh]
92                 local energy_full       = tonumber(first_line(bstr .. "/energy_full") or
93                                           first_line(bstr .. "/charge_full"))
94
95                 local energy_percentage = tonumber(first_line(bstr .. "/capacity")) or
96                                           math.floor((energy_now / energy_full) * 100)
97
98                 bat_now.n_status[i] = first_line(bstr .. "/status") or "N/A"
99                 bat_now.n_perc[i]   = energy_percentage or bat_now.n_perc[i]
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             end
108         end
109
110         -- When one of the battery is charging, others' status are either
111         -- "Full", "Unknown" or "Charging". When the laptop is not plugged in,
112         -- one or more of the batteries may be full, but only one battery
113         -- discharging suffices to set global status to "Discharging".
114         bat_now.status = bat_now.n_status[1]
115         for _,status in ipairs(bat_now.n_status) do
116             if status == "Discharging" or status == "Charging" then
117                 bat_now.status = status
118             end
119         end
120         bat_now.ac_status = tonumber(first_line(string.format("%s%s/online", pspath, ac))) or "N/A"
121
122         if bat_now.status ~= "N/A" then
123             if bat_now.status ~= "Full" and sum_rate_power == 0 and bat_now.ac_status == 1 then
124                                                                 bat_now.perc  = math.floor(math.min(100, (sum_energy_now / sum_energy_full) * 100))
125                                                                 bat_now.time  = "00:00"
126                                                                 bat_now.watt  = 0
127
128             -- update {perc,time,watt} iff battery not full and rate > 0
129             elseif bat_now.status ~= "Full" then
130                 local rate_time = 0
131                 -- Calculate time and watt if rates are greater then 0
132                 if (sum_rate_power > 0 or sum_rate_current > 0) then
133                     local div = (sum_rate_power > 0 and sum_rate_power) or sum_rate_current
134
135                     if bat_now.status == "Charging" then
136                         rate_time = (sum_energy_full - sum_energy_now) / div
137                     else -- Discharging
138                         rate_time = sum_energy_now / div
139                     end
140
141                     if 0 < rate_time and rate_time < 0.01 then -- check for magnitude discrepancies (#199)
142                         rate_time_magnitude = math.abs(math.floor(math.log10(rate_time)))
143                         rate_time = rate_time * 10^(rate_time_magnitude - 2)
144                     end
145                  end
146
147                 local hours   = math.floor(rate_time)
148                 local minutes = math.floor((rate_time - hours) * 60)
149                 bat_now.perc  = math.floor(math.min(100, (sum_energy_now / sum_energy_full) * 100))
150                 bat_now.time  = string.format("%02d:%02d", hours, minutes)
151                 bat_now.watt  = tonumber(string.format("%.2f", sum_rate_energy / 1e6))
152             elseif bat_now.status == "Full" then
153                 bat_now.perc  = 100
154                 bat_now.time  = "00:00"
155                 bat_now.watt  = 0
156             end
157         end
158
159         widget = bat.widget
160         settings()
161
162         -- notifications for low and critical states
163         if notify == "on" and type(bat_now.perc) == "number" and bat_now.status == "Discharging" then
164             if bat_now.perc <= 5 then
165                 bat.id = naughty.notify({
166                     preset = bat_notification_critical_preset,
167                     replaces_id = bat.id
168                 }).id
169             elseif bat_now.perc <= 15 then
170                 bat.id = naughty.notify({
171                     preset = bat_notification_low_preset,
172                     replaces_id = bat.id
173                 }).id
174             end
175         end
176     end
177
178     newtimer("batteries", timeout, bat.update)
179     
180     return bat
181 end
182
183 return setmetatable({}, { __call = function(_, ...) return worker(...) end })