https://github.com/pwittchen/rxbattery
monitors battery state of the Android device
https://github.com/pwittchen/rxbattery
android battery battery-level battery-monitor battery-status broadcast-reciever java kotlin kotlin-android rxandroid rxandroid2 rxjava rxjava2 rxkotlin rxkotlin-android
Last synced: about 1 month ago
JSON representation
monitors battery state of the Android device
- Host: GitHub
- URL: https://github.com/pwittchen/rxbattery
- Owner: pwittchen
- License: apache-2.0
- Created: 2017-06-26T13:53:16.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-19T08:52:27.000Z (almost 5 years ago)
- Last Synced: 2025-03-27T03:41:29.960Z (about 2 months ago)
- Topics: android, battery, battery-level, battery-monitor, battery-status, broadcast-reciever, java, kotlin, kotlin-android, rxandroid, rxandroid2, rxjava, rxjava2, rxkotlin, rxkotlin-android
- Language: Kotlin
- Homepage:
- Size: 510 KB
- Stars: 64
- Watchers: 7
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
RxBattery [](https://travis-ci.org/pwittchen/RxBattery) 
=========
Android library monitoring battery state of the device with RxJava and RxKotlin
Contents
--------
- [Usage](#usage)
- [Examples](#examples)
- [Download](#download)
- [Tests](#tests)
- [Code style](#code-style)
- [Static code analysis](#static-code-analysis)
- [JavaDoc](#javadoc)
- [Changelog](#changelog)
- [Releasing](#releasing)
- [References](#references)
- [Credits](#credits)
- [License](#license)
Usage
-----
In the **Kotlin** application, you can use library as follows:
```kotlin
RxBattery
.observe(context)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe { textView.text = it.toString() }
```
In the **Java** application, you can use library as follows:
```java
RxBattery
.observe(context)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(batteryState -> {
textView.setText(batteryState.toString());
});
```
`BatteryState` data class looks as follows:
```kotlin
data class BatteryState(
val statusCode: Int,
val pluggedCode: Int,
val healthCode: Int,
val level: Int,
val temperature: Int,
val voltage: Int,
) {
fun status(): Status { ... }
fun plugged(): Plugged { ... }
fun health(): Health { ... }
}
```
All `Integer` values returned by `BatteryState` object are reflected in constants of [`BatteryManager`](https://developer.android.com/reference/android/os/BatteryManager) class from the Android SDK. Enums `Status`, `Plugged` and `Health` represents battery state translated from integer codes from `BatteryManager` class.
Examples
--------
Exemplary Kotlin application is located in `app-kotlin` directory.
Download
--------
You can depend on the library through Gradle:
```groovy
dependencies {
implementation 'com.github.pwittchen:rxbattery:0.1.0'
}
```
Tests
-----
Tests are available in `library/src/test/kotlin/` directory and can be executed on JVM without any emulator or Android device from Android Studio or CLI with the following command:
```
./gradlew test
```
Code style
----------
Code style used in the project is called `SquareAndroid` from Java Code Styles repository by Square available at: https://github.com/square/java-code-styles.
Static code analysis
--------------------
Static code analysis runs Checkstyle, FindBugs, PMD, Lint, KtLint and Detekt. It can be executed with command:
```
./gradlew check
```
Reports from analysis are generated in `library/build/reports/` directory.
JavaDoc
-------
Documentation can be generated as follows:
```
./gradlew dokka
```
Output will be generated in `library/build/javadoc`
JavaDoc can be viewed on-line at https://pwittchen.github.io/RxBattery/library/
Changelog
---------
See [CHANGELOG.md](https://github.com/pwittchen/RxBattery/blob/master/CHANGELOG.md) file.
Releasing
---------
See [RELEASING.md](https://github.com/pwittchen/RxBattery/blob/master/RELEASING.md) file.
References
----------
- https://developer.android.com/training/monitoring-device-state/index.html
- https://developer.android.com/training/monitoring-device-state/battery-monitoring.html
- https://developer.android.com/reference/android/os/BatteryManager
- https://developer.android.com/studio/profile/battery-historian.html
- https://stackoverflow.com/questions/3291655/get-battery-level-and-state-in-android
- https://stackoverflow.com/questions/25932677/proper-optimized-way-to-monitor-battery-level-in-android
- https://stackoverflow.com/questions/32608505/broadcast-receiver-monitoring-the-battery-level-and-charging-state
- https://github.com/jaredsburrows/android-gradle-kotlin-app-template
- http://wittchen.io/2018/08/19/writing-my-first-library-in-kotlin/
Credits
-------
Logo of the project was created by [@Yasujizr](https://github.com/Yasujizr).
License
-------
Copyright 2018 Piotr Wittchen
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.