widgets/contrib/tpbat/init.lua

   1
   2 --[[
   3
   4      tpbat.lua
   5      Battery status widget for ThinkPad laptops that use SMAPI
   6      lain.widgets.contrib.tpbat
   7
   8      More on tp_smapi: http://www.thinkwiki.org/wiki/Tp_smapi
   9
  10      Licensed under GNU General Public License v2
  11       * (c) 2013,      Conor Heine
  12       * (c) 2013,      Luke Bonham
  13       * (c) 2010-2012, Peter Hofmann
  14
  15 --]]
  16
  17 local debug        = { getinfo = debug.getinfo }
  18 local newtimer     = require("lain.helpers").newtimer
  19 local first_line   = require("lain.helpers").first_line
  20 local beautiful    = require("beautiful")
  21 local naughty      = require("naughty")
  22 local wibox        = require("wibox")
  23
  24 local string       = { format = string.format }
  25 local math         = { floor = math.floor }
  26 local tostring     = tostring
  27 local setmetatable = setmetatable
  28
  29 package.path       = debug.getinfo(1,"S").source:match[[^@?(.*[\/])[^\/]-$]] .. "?.lua;" .. package.path
  30 local smapi        = require("smapi")
  31
  32 -- ThinkPad SMAPI-enabled battery info widget
  33 -- lain.widgets.contrib.tpbat
  34 local tpbat = { }
  35 local tpbat_notification = nil
  36
  37 function tpbat:hide()
  38     if tpbat_notification ~= nil
  39     then
  40         naughty.destroy(tpbat_notification)
  41         tpbat_notification = nil
  42     end
  43 end
  44
  45 function tpbat:show(t_out)
  46     tpbat:hide()
  47
  48     local bat   = self.bat
  49     local t_out = t_out or 0
  50
  51     if bat == nil or not bat:installed() then return end
  52
  53     local mfgr   = bat:get('manufacturer') or "no_mfgr"
  54     local model  = bat:get('model') or "no_model"
  55     local chem   = bat:get('chemistry') or "no_chem"
  56     local status = bat:get('state') or "nil"
  57     local time   = bat:remaining_time()
  58     local msg    = "\t"
  59
  60     if status ~= "idle" and status ~= "nil"
  61     then
  62         if time == "N/A"
  63         then
  64             msg = "...Calculating time remaining..."
  65         else
  66             msg = time .. (status == "charging" and " until charged" or " remaining")
  67         end
  68     else
  69         msg = "On AC Power"
  70     end
  71
  72     local str = string.format("%s : %s %s (%s)\n", bat.name, mfgr, model, chem)
  73                 .. string.format("\n%s \t\t\t %s", status:upper(), msg)
  74
  75     tpbat_notification = naughty.notify({
  76         preset = { fg = beautiful.fg_normal },
  77         text = str,
  78         timeout = t_out
  79     })
  80 end
  81
  82 function tpbat.register(args)
  83     local args = args or {}
  84     local timeout = args.timeout or 30
  85     local battery = args.battery or "BAT0"
  86     local settings = args.settings or function() end
  87
  88     tpbat.bat = smapi:battery(battery) -- Create a new battery
  89     local bat = tpbat.bat
  90
  91     tpbat.widget = wibox.widget.textbox('')
  92
  93     bat_notification_low_preset = {
  94         title = "Battery low",
  95         text = "Plug the cable!",
  96         timeout = 15,
  97         fg = "#202020",
  98         bg = "#CDCDCD"
  99     }
 100
 101     bat_notification_critical_preset = {
 102         title = "Battery exhausted",
 103         text = "Shutdown imminent",
 104         timeout = 15,
 105         fg = "#000000",
 106         bg = "#FFFFFF"
 107     }
 108
 109     if bat:get('state') == nil
 110     then
 111         local n = naughty.notify({
 112             preset = bat_notification_low_preset,
 113             title = "SMAPI Battery Warning: Unable to read battery state!",
 114             text = "This widget is intended for ThinkPads. Is tp_smapi installed? Check your configs & paths."
 115         })
 116     end
 117
 118     function update()
 119         bat_now = {
 120             status = "Not present",
 121             perc   = "N/A",
 122             time   = "N/A",
 123             watt   = "N/A"
 124         }
 125
 126         if bat:installed()
 127         then
 128             bat_now.status = bat:status() or "N/A"
 129             bat_now.perc   = bat:percent()
 130             bat_now.time   = bat:remaining_time()
 131             -- bat_now.watt = string.format("%.2fW", (VOLTS * AMPS) / 1e12)
 132
 133             -- notifications for low and critical states (when discharging)
 134             if bat_now.status == "discharging"
 135             then
 136                 if bat_now.perc <= 5
 137                 then
 138                     tpbat.id = naughty.notify({
 139                         preset = bat_notification_critical_preset,
 140                         replaces_id = tpbat.id
 141                     }).id
 142                 elseif bat_now.perc <= 15
 143                 then
 144                     tpbat.id = naughty.notify({
 145                         preset = bat_notification_low_preset,
 146                         replaces_id = tpbat.id
 147                     }).id
 148                 end
 149             end
 150
 151             bat_now.perc = tostring(bat_now.perc)
 152         end
 153
 154         widget = tpbat.widget
 155         settings()
 156     end
 157
 158     newtimer("tpbat", timeout, update)
 159
 160     widget:connect_signal('mouse::enter', function () tpbat:show() end)
 161     widget:connect_signal('mouse::leave', function () tpbat:hide() end)
 162
 163     return tpbat.widget
 164 end
 165
 166 return setmetatable(tpbat, { __call = function(_, ...) return tpbat.register(...) end })