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

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