BatteryManager.java revision 4870e9d5eba59fb257a87f97f1adf0b734cf48d3 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.os;
18
19import android.content.Context;
20import android.os.BatteryProperty;
21import android.os.IBatteryPropertiesRegistrar;
22import android.os.RemoteException;
23import android.os.ServiceManager;
24import com.android.internal.app.IBatteryStats;
25
26/**
27 * The BatteryManager class contains strings and constants used for values
28 * in the {@link android.content.Intent#ACTION_BATTERY_CHANGED} Intent, and
29 * provides a method for querying battery and charging properties.
30 */
31public class BatteryManager {
32    /**
33     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
34     * integer containing the current status constant.
35     */
36    public static final String EXTRA_STATUS = "status";
37
38    /**
39     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
40     * integer containing the current health constant.
41     */
42    public static final String EXTRA_HEALTH = "health";
43
44    /**
45     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
46     * boolean indicating whether a battery is present.
47     */
48    public static final String EXTRA_PRESENT = "present";
49
50    /**
51     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
52     * integer field containing the current battery level, from 0 to
53     * {@link #EXTRA_SCALE}.
54     */
55    public static final String EXTRA_LEVEL = "level";
56
57    /**
58     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
59     * integer containing the maximum battery level.
60     */
61    public static final String EXTRA_SCALE = "scale";
62
63    /**
64     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
65     * integer containing the resource ID of a small status bar icon
66     * indicating the current battery state.
67     */
68    public static final String EXTRA_ICON_SMALL = "icon-small";
69
70    /**
71     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
72     * integer indicating whether the device is plugged in to a power
73     * source; 0 means it is on battery, other constants are different
74     * types of power sources.
75     */
76    public static final String EXTRA_PLUGGED = "plugged";
77
78    /**
79     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
80     * integer containing the current battery voltage level.
81     */
82    public static final String EXTRA_VOLTAGE = "voltage";
83
84    /**
85     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
86     * integer containing the current battery temperature.
87     */
88    public static final String EXTRA_TEMPERATURE = "temperature";
89
90    /**
91     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
92     * String describing the technology of the current battery.
93     */
94    public static final String EXTRA_TECHNOLOGY = "technology";
95
96    /**
97     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
98     * Int value set to nonzero if an unsupported charger is attached
99     * to the device.
100     * {@hide}
101     */
102    public static final String EXTRA_INVALID_CHARGER = "invalid_charger";
103
104    // values for "status" field in the ACTION_BATTERY_CHANGED Intent
105    public static final int BATTERY_STATUS_UNKNOWN = 1;
106    public static final int BATTERY_STATUS_CHARGING = 2;
107    public static final int BATTERY_STATUS_DISCHARGING = 3;
108    public static final int BATTERY_STATUS_NOT_CHARGING = 4;
109    public static final int BATTERY_STATUS_FULL = 5;
110
111    // values for "health" field in the ACTION_BATTERY_CHANGED Intent
112    public static final int BATTERY_HEALTH_UNKNOWN = 1;
113    public static final int BATTERY_HEALTH_GOOD = 2;
114    public static final int BATTERY_HEALTH_OVERHEAT = 3;
115    public static final int BATTERY_HEALTH_DEAD = 4;
116    public static final int BATTERY_HEALTH_OVER_VOLTAGE = 5;
117    public static final int BATTERY_HEALTH_UNSPECIFIED_FAILURE = 6;
118    public static final int BATTERY_HEALTH_COLD = 7;
119
120    // values of the "plugged" field in the ACTION_BATTERY_CHANGED intent.
121    // These must be powers of 2.
122    /** Power source is an AC charger. */
123    public static final int BATTERY_PLUGGED_AC = 1;
124    /** Power source is a USB port. */
125    public static final int BATTERY_PLUGGED_USB = 2;
126    /** Power source is wireless. */
127    public static final int BATTERY_PLUGGED_WIRELESS = 4;
128
129    /** @hide */
130    public static final int BATTERY_PLUGGED_ANY =
131            BATTERY_PLUGGED_AC | BATTERY_PLUGGED_USB | BATTERY_PLUGGED_WIRELESS;
132
133    /**
134     * Sent when the device's battery has started charging (or has reached full charge
135     * and the device is on power).  This is a good time to do work that you would like to
136     * avoid doing while on battery (that is to avoid draining the user's battery due to
137     * things they don't care enough about).
138     *
139     * This is paired with {@link #ACTION_DISCHARGING}.  The current state can always
140     * be retrieved with {@link #isCharging()}.
141     */
142    public static final String ACTION_CHARGING = "android.os.action.CHARGING";
143
144    /**
145     * Sent when the device's battery may be discharging, so apps should avoid doing
146     * extraneous work that would cause it to discharge faster.
147     *
148     * This is paired with {@link #ACTION_CHARGING}.  The current state can always
149     * be retrieved with {@link #isCharging()}.
150     */
151    public static final String ACTION_DISCHARGING = "android.os.action.DISCHARGING";
152
153    /*
154     * Battery property identifiers.  These must match the values in
155     * frameworks/native/include/batteryservice/BatteryService.h
156     */
157    /** Battery capacity in microampere-hours, as an integer. */
158    public static final int BATTERY_PROPERTY_CHARGE_COUNTER = 1;
159
160    /**
161     * Instantaneous battery current in microamperes, as an integer.  Positive
162     * values indicate net current entering the battery from a charge source,
163     * negative values indicate net current discharging from the battery.
164     */
165    public static final int BATTERY_PROPERTY_CURRENT_NOW = 2;
166
167    /**
168     * Average battery current in microamperes, as an integer.  Positive
169     * values indicate net current entering the battery from a charge source,
170     * negative values indicate net current discharging from the battery.
171     * The time period over which the average is computed may depend on the
172     * fuel gauge hardware and its configuration.
173     */
174    public static final int BATTERY_PROPERTY_CURRENT_AVERAGE = 3;
175
176    /**
177     * Remaining battery capacity as an integer percentage of total capacity
178     * (with no fractional part).
179     */
180    public static final int BATTERY_PROPERTY_CAPACITY = 4;
181
182    /**
183     * Battery remaining energy in nanowatt-hours, as a long integer.
184     */
185    public static final int BATTERY_PROPERTY_ENERGY_COUNTER = 5;
186
187    private final IBatteryStats mBatteryStats;
188    private final IBatteryPropertiesRegistrar mBatteryPropertiesRegistrar;
189
190    /**
191     * @removed Was previously made visible by accident.
192     */
193    public BatteryManager() {
194        mBatteryStats = IBatteryStats.Stub.asInterface(
195                ServiceManager.getService(BatteryStats.SERVICE_NAME));
196        mBatteryPropertiesRegistrar = IBatteryPropertiesRegistrar.Stub.asInterface(
197                ServiceManager.getService("batteryproperties"));
198    }
199
200    /**
201     * Return true if the battery is currently considered to be charging.  This means that
202     * the device is plugged in and is supplying sufficient power that the battery level is
203     * going up (or the battery is fully charged).  Changes in this state are matched by
204     * broadcasts of {@link #ACTION_CHARGING} and {@link #ACTION_DISCHARGING}.
205     */
206    public boolean isCharging() {
207        try {
208            return mBatteryStats.isCharging();
209        } catch (RemoteException e) {
210            return true;
211        }
212    }
213
214    /**
215     * Query a battery property from the batteryproperties service.
216     *
217     * Returns the requested value, or Long.MIN_VALUE if property not
218     * supported on this system or on other error.
219     */
220    private long queryProperty(int id) {
221        long ret;
222
223        if (mBatteryPropertiesRegistrar == null) {
224            return Long.MIN_VALUE;
225        }
226
227        try {
228            BatteryProperty prop = new BatteryProperty();
229
230            if (mBatteryPropertiesRegistrar.getProperty(id, prop) == 0)
231                ret = prop.getLong();
232            else
233                ret = Long.MIN_VALUE;
234        } catch (RemoteException e) {
235            ret = Long.MIN_VALUE;
236        }
237
238        return ret;
239    }
240
241    /**
242     * Return the value of a battery property of integer type.  If the
243     * platform does not provide the property queried, this value will
244     * be Integer.MIN_VALUE.
245     *
246     * @param id identifier of the requested property
247     *
248     * @return the property value, or Integer.MIN_VALUE if not supported.
249     */
250    public int getIntProperty(int id) {
251        return (int)queryProperty(id);
252    }
253
254    /**
255     * Return the value of a battery property of long type If the
256     * platform does not provide the property queried, this value will
257     * be Long.MIN_VALUE.
258     *
259     * @param id identifier of the requested property
260     *
261     * @return the property value, or Long.MIN_VALUE if not supported.
262     */
263    public long getLongProperty(int id) {
264        return queryProperty(id);
265    }
266}
267