X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/768d4533ce51d61ce065b28f63aae43c7be0d1cc..0d4afaf7ffb6d1881c9acf9ef03f386cc87254e6:/lisp/battery.el diff --git a/lisp/battery.el b/lisp/battery.el index 42ceec0c90..fc5926efd1 100644 --- a/lisp/battery.el +++ b/lisp/battery.el @@ -1,17 +1,17 @@ -;;; battery.el --- display battery status information +;;; battery.el --- display battery status information -*- coding: iso-8859-1 -*- -;; Copyright (C) 1997, 1998, 2000, 2001, 2003, 2004, 2005 -;; Free Software Foundation, Inc. +;; Copyright (C) 1997, 1998, 2000, 2001, 2002, 2003, 2004, +;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. ;; Author: Ralph Schleicher ;; Keywords: hardware ;; This file is part of GNU Emacs. -;; GNU Emacs is free software; you can redistribute it and/or modify +;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation; either version 2, or (at your option) -;; any later version. +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -19,15 +19,15 @@ ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License -;; along with GNU Emacs; see the file COPYING. If not, write to the -;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; along with GNU Emacs. If not, see . ;;; Commentary: -;; There is at present support for interpreting the new `/proc/apm' -;; file format of Linux version 1.3.58 or newer and for the `/proc/acpi/' -;; directory structure of Linux 2.4.20 and 2.6. +;; There is at present support for GNU/Linux, OS X and Windows. This +;; library supports both the `/proc/apm' file format of Linux version +;; 1.3.58 or newer and the `/proc/acpi/' directory structure of Linux +;; 2.4.20 and 2.6. Darwin (OS X) is supported by using the `pmset' +;; program. Windows is supported by the GetSystemPowerStatus API call. ;;; Code: @@ -46,8 +46,21 @@ 'battery-linux-proc-apm) ((and (eq system-type 'gnu/linux) (file-directory-p "/proc/acpi/battery")) - 'battery-linux-proc-acpi)) - "*Function for getting battery status information. + 'battery-linux-proc-acpi) + ((and (eq system-type 'gnu/linux) + (file-directory-p "/sys/class/power_supply/") + (directory-files "/sys/class/power_supply/" nil "BAT[0-9]$")) + 'battery-linux-sysfs) + ((and (eq system-type 'darwin) + (condition-case nil + (with-temp-buffer + (and (eq (call-process "pmset" nil t nil "-g" "ps") 0) + (> (buffer-size) 0))) + (error nil))) + 'battery-pmset) + ((eq system-type 'windows-nt) + 'w32-battery-status)) + "Function for getting battery status information. The function has to return an alist of conversion definitions. Its cons cells are of the form @@ -59,15 +72,30 @@ introduced by a `%' character in a control string." :group 'battery) (defcustom battery-echo-area-format - (cond ((eq battery-status-function 'battery-linux-proc-apm) - "Power %L, battery %B (%p%% load, remaining time %t)") - ((eq battery-status-function 'battery-linux-proc-acpi) - "Power %L, battery %B at %r (%p%% load, remaining time %t)")) - "*Control string formatting the string to display in the echo area. + (cond ((eq battery-status-function 'battery-linux-proc-acpi) + "Power %L, battery %B at %r (%p%% load, remaining time %t)") + ((eq battery-status-function 'battery-linux-sysfs) + "Power %L, battery %B (%p%% load)") + ((eq battery-status-function 'battery-pmset) + "%L power, battery %B (%p%% load, remaining time %t)") + (battery-status-function + "Power %L, battery %B (%p%% load, remaining time %t)")) + "Control string formatting the string to display in the echo area. Ordinary characters in the control string are printed as-is, while conversion specifications introduced by a `%' character in the control string are substituted as defined by the current value of the variable -`battery-status-function'." +`battery-status-function'. Here are the ones generally available: +%c Current capacity (mAh or mWh) +%r Current rate of charge or discharge +%B Battery status (verbose) +%b Battery status: empty means high, `-' means low, + `!' means critical, and `+' means charging +%d Temperature (in degrees Celsius) +%L AC line status (verbose) +%p Battery load percentage +%m Remaining time (to charge or discharge) in minutes +%h Remaining time (to charge or discharge) in hours +%t Remaining time (to charge or discharge) in the form `h:min'" :type '(choice string (const nil)) :group 'battery) @@ -76,20 +104,43 @@ string are substituted as defined by the current value of the variable ;;;###autoload (put 'battery-mode-line-string 'risky-local-variable t) (defcustom battery-mode-line-format - (cond ((eq battery-status-function 'battery-linux-proc-apm) - "[%b%p%%]") - ((eq battery-status-function 'battery-linux-proc-acpi) - "[%b%p%%,%d°C]")) - "*Control string formatting the string to display in the mode line. + (cond ((eq battery-status-function 'battery-linux-proc-acpi) + "[%b%p%%,%d°C]") + (battery-status-function + "[%b%p%%]")) + "Control string formatting the string to display in the mode line. Ordinary characters in the control string are printed as-is, while conversion specifications introduced by a `%' character in the control string are substituted as defined by the current value of the variable -`battery-status-function'." +`battery-status-function'. Here are the ones generally available: +%c Current capacity (mAh or mWh) +%r Current rate of charge or discharge +%B Battery status (verbose) +%b Battery status: empty means high, `-' means low, + `!' means critical, and `+' means charging +%d Temperature (in degrees Celsius) +%L AC line status (verbose) +%p Battery load percentage +%m Remaining time (to charge or discharge) in minutes +%h Remaining time (to charge or discharge) in hours +%t Remaining time (to charge or discharge) in the form `h:min'" :type '(choice string (const nil)) :group 'battery) (defcustom battery-update-interval 60 - "*Seconds after which the battery status will be updated." + "Seconds after which the battery status will be updated." + :type 'integer + :group 'battery) + +(defcustom battery-load-low 25 + "Upper bound of low battery load percentage. +A battery load percentage below this number is considered low." + :type 'integer + :group 'battery) + +(defcustom battery-load-critical 10 + "Upper bound of critical battery load percentage. +A battery load percentage below this number is considered critical." :type 'integer :group 'battery) @@ -171,53 +222,49 @@ The following %-sequences are provided: %B Battery status (verbose) %b Battery status, empty means high, `-' means low, `!' means critical, and `+' means charging -%p battery load percentage -%s Remaining time in seconds -%m Remaining time in minutes -%h Remaining time in hours -%t Remaining time in the form `h:min'" +%p Battery load percentage +%s Remaining time (to charge or discharge) in seconds +%m Remaining time (to charge or discharge) in minutes +%h Remaining time (to charge or discharge) in hours +%t Remaining time (to charge or discharge) in the form `h:min'" (let (driver-version bios-version bios-interface line-status battery-status battery-status-symbol load-percentage - seconds minutes hours remaining-time buffer tem) - (unwind-protect - (save-excursion - (setq buffer (get-buffer-create " *battery*")) - (set-buffer buffer) - (erase-buffer) - (insert-file-contents "/proc/apm") - (re-search-forward battery-linux-proc-apm-regexp) - (setq driver-version (match-string 1)) - (setq bios-version (match-string 2)) - (setq tem (string-to-number (match-string 3) 16)) - (if (not (logand tem 2)) - (setq bios-interface "not supported") - (setq bios-interface "enabled") - (cond ((logand tem 16) (setq bios-interface "disabled")) - ((logand tem 32) (setq bios-interface "disengaged"))) - (setq tem (string-to-number (match-string 4) 16)) - (cond ((= tem 0) (setq line-status "off-line")) - ((= tem 1) (setq line-status "on-line")) - ((= tem 2) (setq line-status "on backup"))) - (setq tem (string-to-number (match-string 6) 16)) - (if (= tem 255) - (setq battery-status "N/A") - (setq tem (string-to-number (match-string 5) 16)) - (cond ((= tem 0) (setq battery-status "high" - battery-status-symbol "")) - ((= tem 1) (setq battery-status "low" - battery-status-symbol "-")) - ((= tem 2) (setq battery-status "critical" - battery-status-symbol "!")) - ((= tem 3) (setq battery-status "charging" - battery-status-symbol "+"))) - (setq load-percentage (match-string 7)) - (setq seconds (string-to-number (match-string 8))) - (and (string-equal (match-string 9) "min") - (setq seconds (* 60 seconds))) - (setq minutes (/ seconds 60) - hours (/ seconds 3600)) - (setq remaining-time - (format "%d:%02d" hours (- minutes (* 60 hours)))))))) + seconds minutes hours remaining-time tem) + (with-temp-buffer + (ignore-errors (insert-file-contents "/proc/apm")) + (when (re-search-forward battery-linux-proc-apm-regexp) + (setq driver-version (match-string 1)) + (setq bios-version (match-string 2)) + (setq tem (string-to-number (match-string 3) 16)) + (if (not (logand tem 2)) + (setq bios-interface "not supported") + (setq bios-interface "enabled") + (cond ((logand tem 16) (setq bios-interface "disabled")) + ((logand tem 32) (setq bios-interface "disengaged"))) + (setq tem (string-to-number (match-string 4) 16)) + (cond ((= tem 0) (setq line-status "off-line")) + ((= tem 1) (setq line-status "on-line")) + ((= tem 2) (setq line-status "on backup"))) + (setq tem (string-to-number (match-string 6) 16)) + (if (= tem 255) + (setq battery-status "N/A") + (setq tem (string-to-number (match-string 5) 16)) + (cond ((= tem 0) (setq battery-status "high" + battery-status-symbol "")) + ((= tem 1) (setq battery-status "low" + battery-status-symbol "-")) + ((= tem 2) (setq battery-status "critical" + battery-status-symbol "!")) + ((= tem 3) (setq battery-status "charging" + battery-status-symbol "+"))) + (setq load-percentage (match-string 7)) + (setq seconds (string-to-number (match-string 8))) + (and (string-equal (match-string 9) "min") + (setq seconds (* 60 seconds))) + (setq minutes (/ seconds 60) + hours (/ seconds 3600)) + (setq remaining-time + (format "%d:%02d" hours (- minutes (* 60 hours)))))))) (list (cons ?v (or driver-version "N/A")) (cons ?V (or bios-version "N/A")) (cons ?I (or bios-interface "N/A")) @@ -235,21 +282,24 @@ The following %-sequences are provided: (defun battery-linux-proc-acpi () "Get ACPI status information from Linux kernel. -This function works only with the new `/proc/acpi/' format introduced +This function works only with the `/proc/acpi/' format introduced in Linux version 2.4.20 and 2.6.0. The following %-sequences are provided: %c Current capacity (mAh) +%r Current rate %B Battery status (verbose) %b Battery status, empty means high, `-' means low, `!' means critical, and `+' means charging %d Temperature (in degrees Celsius) %L AC line status (verbose) -%p battery load percentage -%m Remaining time in minutes -%h Remaining time in hours -%t Remaining time in the form `h:min'" +%p Battery load percentage +%m Remaining time (to charge or discharge) in minutes +%h Remaining time (to charge or discharge) in hours +%t Remaining time (to charge or discharge) in the form `h:min'" (let ((design-capacity 0) + (last-full-capacity 0) + full-capacity (warn 0) (low 0) capacity rate rate-type charging-state minutes hours) @@ -264,7 +314,7 @@ The following %-sequences are provided: (ignore-errors (insert-file-contents (expand-file-name "state" dir))) (when (re-search-forward "present: +yes$" nil t) (and (re-search-forward "charging state: +\\(.*\\)$" nil t) - (member charging-state '("unknown" nil)) + (member charging-state '("unknown" "charged" nil)) ;; On most multi-battery systems, most of the time only one ;; battery is "charging"/"discharging", the others are ;; "unknown". @@ -289,62 +339,193 @@ The following %-sequences are provided: (when (re-search-forward "design capacity: +\\([0-9]+\\) m[AW]h$" nil t) (incf design-capacity (string-to-number (match-string 1)))) + (when (re-search-forward "last full capacity: +\\([0-9]+\\) m[AW]h$" + nil t) + (incf last-full-capacity (string-to-number (match-string 1)))) (when (re-search-forward "design capacity warning: +\\([0-9]+\\) m[AW]h$" nil t) (incf warn (string-to-number (match-string 1)))) (when (re-search-forward "design capacity low: +\\([0-9]+\\) m[AW]h$" nil t) (incf low (string-to-number (match-string 1))))))) + (setq full-capacity (if (> last-full-capacity 0) + last-full-capacity design-capacity)) (and capacity rate (setq minutes (if (zerop rate) 0 (floor (* (/ (float (if (string= charging-state "charging") - (- design-capacity capacity) - capacity)) rate) 60))) + (- full-capacity capacity) + capacity)) + rate) + 60))) hours (/ minutes 60))) (list (cons ?c (or (and capacity (number-to-string capacity)) "N/A")) - (cons ?L (or (when (file-exists-p "/proc/acpi/ac_adapter/AC/state") - (with-temp-buffer - (insert-file-contents - "/proc/acpi/ac_adapter/AC/state") - (when (re-search-forward "state: +\\(.*\\)$" nil t) - (match-string 1)))) + (cons ?L (or (battery-search-for-one-match-in-files + (mapcar (lambda (e) (concat e "/state")) + (ignore-errors + (directory-files "/proc/acpi/ac_adapter/" + t "\\`[^.]"))) + "state: +\\(.*\\)$" 1) + "N/A")) - (cons ?d (or (when (file-exists-p - "/proc/acpi/thermal_zone/THRM/temperature") - (with-temp-buffer - (insert-file-contents - "/proc/acpi/thermal_zone/THRM/temperature") - (when (re-search-forward - "temperature: +\\([0-9]+\\) C$" nil t) - (match-string 1)))) - (when (file-exists-p - "/proc/acpi/thermal_zone/THM/temperature") - (with-temp-buffer - (insert-file-contents - "/proc/acpi/thermal_zone/THM/temperature") - (when (re-search-forward - "temperature: +\\([0-9]+\\) C$" nil t) - (match-string 1)))) + (cons ?d (or (battery-search-for-one-match-in-files + (mapcar (lambda (e) (concat e "/temperature")) + (ignore-errors + (directory-files "/proc/acpi/thermal_zone/" + t "\\`[^.]"))) + "temperature: +\\([0-9]+\\) C$" 1) + "N/A")) (cons ?r (or (and rate (concat (number-to-string rate) " " rate-type)) "N/A")) (cons ?B (or charging-state "N/A")) (cons ?b (or (and (string= charging-state "charging") "+") - (and (< capacity low) "!") - (and (< capacity warn) "-") + (and capacity (< capacity low) "!") + (and capacity (< capacity warn) "-") "")) (cons ?h (or (and hours (number-to-string hours)) "N/A")) (cons ?m (or (and minutes (number-to-string minutes)) "N/A")) (cons ?t (or (and minutes (format "%d:%02d" hours (- minutes (* 60 hours)))) "N/A")) - (cons ?p (or (and design-capacity capacity + (cons ?p (or (and full-capacity capacity + (> full-capacity 0) (number-to-string (floor (/ capacity - (/ (float design-capacity) 100))))) + (/ (float full-capacity) 100))))) "N/A"))))) + +;;; `/sys/class/power_supply/BATN' interface for Linux. + +(defun battery-linux-sysfs () + "Get ACPI status information from Linux kernel. +This function works only with the new `/sys/class/power_supply/' +format introduced in Linux version 2.4.25. + +The following %-sequences are provided: +%c Current capacity (mAh or mWh) +%B Battery status (verbose) +%p Battery load percentage +%L AC line status (verbose)" + (let (charging-state + (charge-full 0.0) + (charge-now 0.0) + (energy-full 0.0) + (energy-now 0.0)) + ;; SysFS provides information about each battery present in the + ;; system in a separate subdirectory. We are going to merge the + ;; available information together. + (with-temp-buffer + (dolist (dir (ignore-errors + (directory-files + "/sys/class/power_supply/" t "BAT[0-9]$"))) + (erase-buffer) + (ignore-errors (insert-file-contents + (expand-file-name "uevent" dir))) + (when (re-search-forward "POWER_SUPPLY_PRESENT=1$" nil t) + (goto-char (point-min)) + (and (re-search-forward "POWER_SUPPLY_STATUS=\\(.*\\)$" nil t) + (member charging-state '("Unknown" "Full" nil)) + (setq charging-state (match-string 1))) + (let (full-string now-string) + ;; Sysfs may list either charge (mAh) or energy (mWh). + ;; Keep track of both, and choose which to report later. + (cond ((and (re-search-forward + "POWER_SUPPLY_CHARGE_FULL=\\([0-9]*\\)$" nil t) + (setq full-string (match-string 1)) + (re-search-forward + "POWER_SUPPLY_CHARGE_NOW=\\([0-9]*\\)$" nil t) + (setq now-string (match-string 1))) + (setq charge-full (+ charge-full + (string-to-number full-string)) + charge-now (+ charge-now + (string-to-number now-string)))) + ((and (re-search-forward + "POWER_SUPPLY_ENERGY_FULL=\\([0-9]*\\)$" nil t) + (setq full-string (match-string 1)) + (re-search-forward + "POWER_SUPPLY_ENERGY_NOW=\\([0-9]*\\)$" nil t) + (setq now-string (match-string 1))) + (setq energy-full (+ energy-full + (string-to-number full-string)) + energy-now (+ energy-now + (string-to-number now-string))))))))) + (list (cons ?c (cond ((or (> charge-full 0) (> charge-now 0)) + (number-to-string charge-now)) + ((or (> energy-full 0) (> energy-now 0)) + (number-to-string energy-now)) + (t "N/A"))) + (cons ?B (or charging-state "N/A")) + (cons ?p (cond ((> charge-full 0) + (format "%.1f" + (/ (* 100 charge-now) charge-full))) + ((> energy-full 0) + (format "%.1f" + (/ (* 100 energy-now) energy-full))) + (t "N/A"))) + (cons ?L (if (file-readable-p "/sys/class/power_supply/AC/online") + (if (battery-search-for-one-match-in-files + (list "/sys/class/power_supply/AC/online" + "/sys/class/power_supply/ACAD/online") + "1" 0) + "AC" + "BAT") + "N/A"))))) + + + +;;; `pmset' interface for Darwin (OS X). + +(defun battery-pmset () + "Get battery status information using `pmset'. + +The following %-sequences are provided: +%L Power source (verbose) +%B Battery status (verbose) +%b Battery status, empty means high, `-' means low, + `!' means critical, and `+' means charging +%p Battery load percentage +%h Remaining time in hours +%m Remaining time in minutes +%t Remaining time in the form `h:min'" + (let (power-source load-percentage battery-status battery-status-symbol + remaining-time hours minutes) + (with-temp-buffer + (ignore-errors (call-process "pmset" nil t nil "-g" "ps")) + (goto-char (point-min)) + (when (re-search-forward "Currentl?y drawing from '\\(AC\\|Battery\\) Power'" nil t) + (setq power-source (match-string 1)) + (when (re-search-forward "^ -InternalBattery-0[ \t]+" nil t) + (when (looking-at "\\([0-9]\\{1,3\\}\\)%") + (setq load-percentage (match-string 1)) + (goto-char (match-end 0)) + (cond ((looking-at "; charging") + (setq battery-status "charging" + battery-status-symbol "+")) + ((< (string-to-number load-percentage) battery-load-low) + (setq battery-status "low" + battery-status-symbol "-")) + ((< (string-to-number load-percentage) battery-load-critical) + (setq battery-status "critical" + battery-status-symbol "!")) + (t + (setq battery-status "high" + battery-status-symbol ""))) + (when (re-search-forward "\\(\\([0-9]+\\):\\([0-9]+\\)\\) remaining" nil t) + (setq remaining-time (match-string 1)) + (let ((h (string-to-number (match-string 2))) + (m (string-to-number (match-string 3)))) + (setq hours (number-to-string (+ h (if (< m 30) 0 1))) + minutes (number-to-string (+ (* h 60) m))))))))) + (list (cons ?L (or power-source "N/A")) + (cons ?p (or load-percentage "N/A")) + (cons ?B (or battery-status "N/A")) + (cons ?b (or battery-status-symbol "")) + (cons ?h (or hours "N/A")) + (cons ?m (or minutes "N/A")) + (cons ?t (or remaining-time "N/A"))))) + ;;; Private functions. @@ -358,6 +539,17 @@ The following %-sequences are provided: (or (cdr (assoc char alist)) "")))) format t t)) +(defun battery-search-for-one-match-in-files (files regexp match-num) + "Search REGEXP in the content of the files listed in FILES. +If a match occurred, return the parenthesized expression numbered by +MATCH-NUM in the match. Otherwise, return nil." + (with-temp-buffer + (catch 'found + (dolist (file files) + (and (ignore-errors (insert-file-contents file nil nil nil 'replace)) + (re-search-forward regexp nil t) + (throw 'found (match-string match-num))))))) + (provide 'battery)