Home | History | Annotate | Download | only in os
      1 /*
      2  * Copyright (C) 2014 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 
     17 package android.os;
     18 
     19 /**
     20  * Battery manager local system service interface.
     21  *
     22  * @hide Only for use within the system server.
     23  */
     24 public abstract class BatteryManagerInternal {
     25     /**
     26      * Returns true if the device is plugged into any of the specified plug types.
     27      *
     28      * This is a simple accessor that's safe to be called from any locks, but internally it may
     29      * wait on the battery service lock.
     30      */
     31     public abstract boolean isPowered(int plugTypeSet);
     32 
     33     /**
     34      * Returns the current plug type.
     35      *
     36      * This is a simple accessor that's safe to be called from any locks, but internally it may
     37      * wait on the battery service lock.
     38      */
     39     public abstract int getPlugType();
     40 
     41     /**
     42      * Returns battery level as a percentage.
     43      *
     44      * This is a simple accessor that's safe to be called from any locks, but internally it may
     45      * wait on the battery service lock.
     46      */
     47     public abstract int getBatteryLevel();
     48 
     49     /**
     50      * Instantaneous battery capacity in uA-h, as defined in the HealthInfo HAL struct.
     51      * Please note apparently it could be bigger than {@link #getBatteryFullCharge}.
     52      *
     53      * This is a simple accessor that's safe to be called from any locks, but internally it may
     54      * wait on the battery service lock.
     55      *
     56      * @see android.hardware.health.V1_0.HealthInfo#batteryChargeCounter
     57      */
     58     public abstract int getBatteryChargeCounter();
     59 
     60     /**
     61      * Battery charge value when it is considered to be "full" in uA-h , as defined in the
     62      * HealthInfo HAL struct.
     63      *
     64      * This is a simple accessor that's safe to be called from any locks, but internally it may
     65      * wait on the battery service lock.
     66      *
     67      * @see android.hardware.health.V1_0.HealthInfo#batteryFullCharge
     68      */
     69     public abstract int getBatteryFullCharge();
     70 
     71     /**
     72      * Returns whether we currently consider the battery level to be low.
     73      *
     74      * This is a simple accessor that's safe to be called from any locks, but internally it may
     75      * wait on the battery service lock.
     76      */
     77     public abstract boolean getBatteryLevelLow();
     78 
     79     /**
     80      * Returns a non-zero value if an unsupported charger is attached.
     81      *
     82      * This is a simple accessor that's safe to be called from any locks, but internally it may
     83      * wait on the battery service lock.
     84      */
     85     public abstract int getInvalidCharger();
     86 }
     87