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

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