src/plugins/battery.lua

   1 --[[
   2 =pod
   3
   4 =head1 NAME
   5
   6 battery.lua - wmiirc-lua plugin for battery percentage
   7
   8 =head1 SYNOPSIS
   9
  10     -- in your wmiirc
  11     wmii.load_plugin("battery")
  12
  13     -- To configure (after loading plugin)
  14
  15     -- Multiple batteries
  16     wmii.set_conf("battery.names", "BAT0,BAT1");
  17
  18     -- Polling rate (in seconds)
  19     wmii.set_conf("battery.poll_rate", 30)
  20
  21 =head1 DESCRIPTION
  22
  23 This plugin module provides a battery usage display.
  24
  25 =head1 CONFIGURATION AND ENVIRONMENT
  26
  27 There are several configurable options at the moment, most of which will not
  28 need to be modified from the defaults for most users.
  29
  30 =over 4
  31
  32 =item battery.names
  33
  34 A comma-separated list of battery names to poll for status.  This allows the
  35 widget to display multiple battery names.
  36
  37 Defaults to "BAT0"
  38
  39 =item battery.poll_rate
  40
  41 Time in seconds to wait between checks for battery status.
  42
  43 Defaults to 30
  44
  45 =item battery.low
  46
  47 Provide a "low battery" warning at this percentage of remaining capacity.
  48 Colour of widget will change to the defined value, and the low_action, if any,
  49 will be invoked.
  50
  51 Defaults to 15
  52
  53 =item battery.low_fgcolor
  54
  55 Foreground colour of widget when in low battery state.
  56
  57 Defaults to #000000
  58
  59 =item battery.low_bgcolor
  60
  61 Background colour of widget when in low battery state.
  62
  63 Defaults to #FFFF66
  64
  65 =item battery.low_action
  66
  67 Shell command to invoke on entering low battery state.
  68
  69 Defaults to
  70
  71     echo "Low battery" | xmessage -center -buttons quit:0 -default quit -file -
  72
  73 =item battery.critical
  74
  75 Provide a "critical battery" warning at this percentage of remaining capacity.
  76 Colour of widget will change to the defined value, and the critical_action, if any,
  77 will be invoked.
  78
  79 Defaults to 5
  80
  81 =item battery.critical_fgcolor
  82
  83 Foreground colour of widget when in critical battery state.
  84
  85 Defaults to #000000
  86
  87 =item battery.critical_bgcolor
  88
  89 Background colour of widget when in critical battery state.
  90
  91 Defaults to #FF0000
  92
  93 =item battery.critical_action
  94
  95 Shell command to invoke on entering critical battery state.
  96
  97 Defaults to
  98
  99     echo "Critical battery" | xmessage -center -buttons quit:0 -default quit -file -
 100
 101 =back
 102
 103 =head1 BUGS AND LIMITATIONS
 104
 105 Please report problems to the author.
 106 Patches are welcome.
 107
 108 =over 4
 109
 110 =item *
 111
 112 You can't have different low/critical warning thresholds or colours per
 113 battery.  If you actually want this, please send a patch.
 114
 115 =back
 116
 117 =head1 SEE ALSO
 118
 119 L<wmii(1)>, L<lua(1)>
 120
 121 =head1 AUTHOR
 122
 123 Dave O'Neill <dmo@dmo.ca>
 124
 125 Based on a port by Stefan Riegler <sr@bigfatflat.net> of the ruby-wmiirc
 126 standard-plugin.rb battery handling originally written Mauricio Fernandez.
 127
 128 =head1 LICENCE AND COPYRIGHT
 129
 130 Copyright (c) 2007, Stefan Riegler <sr@bigfatflat.net>
 131 Copyright (c) 2008, Dave O'Neill <dmo@dmo.ca>
 132
 133 This is free software.  You may redistribute copies of it under the terms of
 134 the GNU General Public License L<http://www.gnu.org/licenses/gpl.html>.  There
 135 is NO WARRANTY, to the extent permitted by law.
 136
 137 =cut
 138
 139 --]]
 140
 141 local wmii   = require("wmii")
 142 local io     = require("io")
 143 local os     = require("os")
 144 local string = require("string")
 145
 146 module("battery")
 147 api_version=0.1
 148
 149 --
 150 -- Configuration Settings
 151 --
 152 wmii.set_conf ("battery.poll_rate", 30)
 153
 154 wmii.set_conf ("battery.names", "BAT0")
 155
 156 wmii.set_conf ("battery.low", 15)
 157 wmii.set_conf ("battery.low_fgcolor", "#000000")
 158 wmii.set_conf ("battery.low_bgcolor", "#FFFF66")
 159 wmii.set_conf ("battery.low_action",  'echo "Low battery" | xmessage -center -buttons quit:0 -default quit -file -')
 160
 161 wmii.set_conf ("battery.critical", 5)
 162 wmii.set_conf ("battery.critical_fgcolor", "#000000")
 163 wmii.set_conf ("battery.critical_bgcolor", "#FF0000")
 164 wmii.set_conf ("battery.critical_action",  'echo "Critical battery" | xmessage -center -buttons quit:0 -default quit -file -')
 165
 166 -- Should not need to be modified on Linux
 167 wmii.set_conf ("battery.statefile", "/proc/acpi/battery/%s/state")
 168 wmii.set_conf ("battery.infofile",  "/proc/acpi/battery/%s/info")
 169
 170 wmii.set_conf ("battery.showtime", true)
 171 wmii.set_conf ("battery.showrate", true)
 172
 173 --
 174 -- Local Variables
 175 --
 176 local batteries       = { }
 177
 178 -- The actual work performed here.
 179 -- parses info, state file and preps for display
 180 local function update_single_battery ( battery )
 181
 182         local printout = "N/A"
 183         local colors   = wmii.get_ctl("normcolors")
 184
 185         local fbatt    = io.open(string.format(wmii.get_conf("battery.statefile"), battery["name"] ),"r")
 186         if fbatt == nil then
 187                 return battery["widget"]:show(printout, colors)
 188         end
 189
 190         local batt = fbatt:read("*a")
 191         fbatt:close()
 192
 193         local battpresent = batt:match('present:%s+(%w+)')
 194         if battpresent ~= "yes" then
 195                 return battery["widget"]:show(printout, colors)
 196         end
 197
 198         local low          = wmii.get_conf ("battery.low")
 199         local critical     = wmii.get_conf ("battery.critical")
 200
 201         local fbattinfo    = io.open(string.format(wmii.get_conf("battery.infofile"), battery["name"]),"r")
 202         local battinfo     = fbattinfo:read("*a")
 203         fbattinfo:close()
 204
 205         local batt_percent = batt:match('remaining capacity:%s+(%d+)')
 206                              / battinfo:match('last full capacity:%s+(%d+)') * 100
 207         local batt_state   = batt:match('charging state:%s+(%w+)')
 208
 209         -- Take action in case battery is low/critical
 210         if batt_percent <= critical then
 211                 if batt_state == "discharging" and not battery["warned_crit"] then
 212                         wmii.log("Warning about critical battery.")
 213                         os.execute(wmii.get_conf("battmon.critical_action"), "&")
 214                         battery["warned_crit"] = true
 215                 end
 216                 colors = string.gsub(colors, "^%S+ %S+",
 217                         wmii.get_conf ("battery.critical_fgcolor")
 218                         .. " "
 219                         ..  wmii.get_conf ("battery.critical_bgcolor"),
 220                         1)
 221         elseif batt_percent <= low then
 222                 if batt_state == "discharging" and not battery["warned_low"] then
 223                         wmii.log("Warning about low battery.")
 224                         os.execute(wmii.get_conf("battmon.low_action"), "&")
 225                         battery["warned_low"] = true
 226                 end
 227                 colors = string.gsub(colors, "^%S+ %S+",
 228                         wmii.get_conf ("battery.low_fgcolor")
 229                         .. " "
 230                         ..  wmii.get_conf ("battery.low_bgcolor"),
 231                         1)
 232         else
 233                 battery["warned_low"] = true
 234                 battery["warned_crit"] = true
 235         end
 236
 237
 238         -- If percent is 100 and state is discharging then
 239         -- the battery is full and not discharging.
 240         if (batt_state == "charged") or (batt_state == "discharging" and batt_percent >= 97)  then
 241                 batt_state = "="
 242         end
 243         if batt_state == "charging" then
 244                 batt_state = "^"
 245         end
 246         if batt_state == "discharging" then
 247                 batt_state = "v"
 248         end
 249
 250         local batt_rate = batt:match('present rate:%s+(%d+)') * 1
 251
 252         local batt_time = ""
 253         if wmii.get_conf(battery.showtime) then
 254                 batt_time = "inf"
 255                 if batt_rate > 0 then
 256                         if batt_state == "^" then
 257                                 batt_time = (battinfo:match('last full capacity:%s+(%d+)') - batt:match('remaining capacity:%s+(%d+)')) / batt_rate
 258                         else
 259                                 batt_time = batt:match('remaining capacity:%s+(%d+)') / batt_rate
 260                         end
 261                         local hour = string.format("%d",batt_time)
 262                         local min = (batt_time - hour) * 60
 263
 264                         if min > 59 then
 265                                 min = min - 60
 266                                 hour = hour + 1
 267                         end
 268                         if min < 0 then
 269                                 min = 0
 270                         end
 271                         batt_time = hour .. ':'
 272                         batt_time = batt_time .. string.format("%.2d",min)
 273                 end
 274         end
 275
 276         local battrate_string = ""
 277         if wmii.get_conf(battery.showrate) then
 278                 batt_rate = batt_rate/1000
 279                 battrate_string = string.format("%.2f",batt_rate) .. 'W '
 280         end
 281         printout =  battrate_string .. batt_time .. '(' .. batt_state .. string.format("%.0f",batt_percent) .. batt_state .. ')'
 282
 283         battery["widget"]:show(printout, colors)
 284 end
 285
 286 -- ------------------------------------------------------------
 287 -- The battery status update function (wmii.timer function)
 288 local function update_batt_data (time_since_update)
 289
 290         local batt_names = wmii.get_conf("battery.names");
 291
 292         for battery in batt_names:gmatch("%w+") do
 293                 if( not batteries[battery] ) then
 294                         batteries[battery] = {
 295                                 name        = battery,
 296                                 widget      = wmii.widget:new ("901_battery_" .. battery),
 297                                 warned_low  = false,
 298                                 warned_crit = false,
 299                         }
 300                 end
 301                 update_single_battery( batteries[battery] )
 302         end
 303
 304         return wmii.get_conf("battery.poll_rate")
 305 end
 306
 307
 308 local timer = wmii.timer:new (update_batt_data, 1)
 309