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    /**
105     * Extra for {@link android.content.Intent#ACTION_BATTERY_CHANGED}:
106     * Int value set to the maximum charging current supported by the charger in micro amperes.
107     * {@hide}
108     */
109    public static final String EXTRA_MAX_CHARGING_CURRENT = "max_charging_current";
110
111    // values for "status" field in the ACTION_BATTERY_CHANGED Intent
112    public static final int BATTERY_STATUS_UNKNOWN = 1;
113    public static final int BATTERY_STATUS_CHARGING = 2;
114    public static final int BATTERY_STATUS_DISCHARGING = 3;
115    public static final int BATTERY_STATUS_NOT_CHARGING = 4;
116    public static final int BATTERY_STATUS_FULL = 5;
117
118    // values for "health" field in the ACTION_BATTERY_CHANGED Intent
119    public static final int BATTERY_HEALTH_UNKNOWN = 1;
120    public static final int BATTERY_HEALTH_GOOD = 2;
121    public static final int BATTERY_HEALTH_OVERHEAT = 3;
122    public static final int BATTERY_HEALTH_DEAD = 4;
123    public static final int BATTERY_HEALTH_OVER_VOLTAGE = 5;
124    public static final int BATTERY_HEALTH_UNSPECIFIED_FAILURE = 6;
125    public static final int BATTERY_HEALTH_COLD = 7;
126
127    // values of the "plugged" field in the ACTION_BATTERY_CHANGED intent.
128    // These must be powers of 2.
129    /** Power source is an AC charger. */
130    public static final int BATTERY_PLUGGED_AC = 1;
131    /** Power source is a USB port. */
132    public static final int BATTERY_PLUGGED_USB = 2;
133    /** Power source is wireless. */
134    public static final int BATTERY_PLUGGED_WIRELESS = 4;
135
136    /** @hide */
137    public static final int BATTERY_PLUGGED_ANY =
138            BATTERY_PLUGGED_AC | BATTERY_PLUGGED_USB | BATTERY_PLUGGED_WIRELESS;
139
140    /**
141     * Sent when the device's battery has started charging (or has reached full charge
142     * and the device is on power).  This is a good time to do work that you would like to
143     * avoid doing while on battery (that is to avoid draining the user's battery due to
144     * things they don't care enough about).
145     *
146     * This is paired with {@link #ACTION_DISCHARGING}.  The current state can always
147     * be retrieved with {@link #isCharging()}.
148     */
149    public static final String ACTION_CHARGING = "android.os.action.CHARGING";
150
151    /**
152     * Sent when the device's battery may be discharging, so apps should avoid doing
153     * extraneous work that would cause it to discharge faster.
154     *
155     * This is paired with {@link #ACTION_CHARGING}.  The current state can always
156     * be retrieved with {@link #isCharging()}.
157     */
158    public static final String ACTION_DISCHARGING = "android.os.action.DISCHARGING";
159
160    /*
161     * Battery property identifiers.  These must match the values in
162     * frameworks/native/include/batteryservice/BatteryService.h
163     */
164    /** Battery capacity in microampere-hours, as an integer. */
165    public static final int BATTERY_PROPERTY_CHARGE_COUNTER = 1;
166
167    /**
168     * Instantaneous 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     */
172    public static final int BATTERY_PROPERTY_CURRENT_NOW = 2;
173
174    /**
175     * Average battery current in microamperes, as an integer.  Positive
176     * values indicate net current entering the battery from a charge source,
177     * negative values indicate net current discharging from the battery.
178     * The time period over which the average is computed may depend on the
179     * fuel gauge hardware and its configuration.
180     */
181    public static final int BATTERY_PROPERTY_CURRENT_AVERAGE = 3;
182
183    /**
184     * Remaining battery capacity as an integer percentage of total capacity
185     * (with no fractional part).
186     */
187    public static final int BATTERY_PROPERTY_CAPACITY = 4;
188
189    /**
190     * Battery remaining energy in nanowatt-hours, as a long integer.
191     */
192    public static final int BATTERY_PROPERTY_ENERGY_COUNTER = 5;
193
194    private final IBatteryStats mBatteryStats;
195    private final IBatteryPropertiesRegistrar mBatteryPropertiesRegistrar;
196
197    /**
198     * @removed Was previously made visible by accident.
199     */
200    public BatteryManager() {
201        mBatteryStats = IBatteryStats.Stub.asInterface(
202                ServiceManager.getService(BatteryStats.SERVICE_NAME));
203        mBatteryPropertiesRegistrar = IBatteryPropertiesRegistrar.Stub.asInterface(
204                ServiceManager.getService("batteryproperties"));
205    }
206
207    /**
208     * Return true if the battery is currently considered to be charging.  This means that
209     * the device is plugged in and is supplying sufficient power that the battery level is
210     * going up (or the battery is fully charged).  Changes in this state are matched by
211     * broadcasts of {@link #ACTION_CHARGING} and {@link #ACTION_DISCHARGING}.
212     */
213    public boolean isCharging() {
214        try {
215            return mBatteryStats.isCharging();
216        } catch (RemoteException e) {
217            return true;
218        }
219    }
220
221    /**
222     * Query a battery property from the batteryproperties service.
223     *
224     * Returns the requested value, or Long.MIN_VALUE if property not
225     * supported on this system or on other error.
226     */
227    private long queryProperty(int id) {
228        long ret;
229
230        if (mBatteryPropertiesRegistrar == null) {
231            return Long.MIN_VALUE;
232        }
233
234        try {
235            BatteryProperty prop = new BatteryProperty();
236
237            if (mBatteryPropertiesRegistrar.getProperty(id, prop) == 0)
238                ret = prop.getLong();
239            else
240                ret = Long.MIN_VALUE;
241        } catch (RemoteException e) {
242            ret = Long.MIN_VALUE;
243        }
244
245        return ret;
246    }
247
248    /**
249     * Return the value of a battery property of integer type.  If the
250     * platform does not provide the property queried, this value will
251     * be Integer.MIN_VALUE.
252     *
253     * @param id identifier of the requested property
254     *
255     * @return the property value, or Integer.MIN_VALUE if not supported.
256     */
257    public int getIntProperty(int id) {
258        return (int)queryProperty(id);
259    }
260
261    /**
262     * Return the value of a battery property of long type If the
263     * platform does not provide the property queried, this value will
264     * be Long.MIN_VALUE.
265     *
266     * @param id identifier of the requested property
267     *
268     * @return the property value, or Long.MIN_VALUE if not supported.
269     */
270    public long getLongProperty(int id) {
271        return queryProperty(id);
272    }
273}
274