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

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