mirror of
https://github.com/liberatedsystems/openCom-Companion.git
synced 2024-11-24 22:30:37 +01:00
55 lines
1.1 KiB
Python
55 lines
1.1 KiB
Python
|
'''
|
||
|
|
Battery
|
||
|
|
=======
|
||
|
|
|
||
|
|
The :class:`Battery` provides information about the battery of your device.
|
||
|
|
|
||
|
|
.. note::
|
||
|
|
On Android the `BATTERY_STATS` permission is needed.
|
||
|
|
|
||
|
|
Simple Example
|
||
|
|
---------------
|
||
|
|
|
||
|
|
To get battery status::
|
||
|
|
|
||
|
|
>>> from plyer import battery
|
||
|
|
>>> battery.status
|
||
|
|
{'percentage': 82.0, 'isCharging': False}
|
||
|
|
|
||
|
|
Supported Platforms
|
||
|
|
-------------------
|
||
|
|
Android, iOS, Windows, OS X, Linux
|
||
|
|
|
||
|
|
'''
|
||
|
|
|
||
|
|
|
||
|
|
class Battery:
|
||
|
|
'''
|
||
|
|
Battery info facade.
|
||
|
|
'''
|
||
|
|
|
||
|
|
@property
|
||
|
|
def status(self):
|
||
|
|
'''
|
||
|
|
Property that contains a dict with the following fields:
|
||
|
|
* **isCharging** *(bool)*: Battery is charging
|
||
|
|
* **percentage** *(float)*: Battery charge remaining
|
||
|
|
|
||
|
|
.. warning::
|
||
|
|
If any of the fields is not readable, it is set as
|
||
|
|
None.
|
||
|
|
'''
|
||
|
|
return self.get_state()
|
||
|
|
|
||
|
|
def get_state(self):
|
||
|
|
'''
|
||
|
|
Public method for filling battery.status via platform-specific
|
||
|
|
API in plyer.platforms.
|
||
|
|
'''
|
||
|
|
return self._get_state()
|
||
|
|
|
||
|
|
# private
|
||
|
|
|
||
|
|
def _get_state(self):
|
||
|
|
raise NotImplementedError()
|