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

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