Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/svartalf/rust-battery

Rust crate providing cross-platform information about the notebook batteries.
https://github.com/svartalf/rust-battery

battery battery-information dragonflybsd freebsd linux macos rust rust-crate windows

Last synced: about 1 month ago
JSON representation

Rust crate providing cross-platform information about the notebook batteries.

Awesome Lists containing this project

README 

        
# battery



[![Latest Version](https://img.shields.io/crates/v/battery.svg)](https://crates.io/crates/battery)

[![Latest Version](https://docs.rs/battery/badge.svg)](https://docs.rs/battery)

[![Build Status](https://github.com/svartalf/rust-battery/workflows/Continuous%20integration/badge.svg)](https://github.com/svartalf/rust-battery/actions?workflow=Continuous+integration)

![Minimum rustc version](https://img.shields.io/badge/rustc-1.36+-yellow.svg)

![Apache 2.0 OR MIT licensed](https://img.shields.io/badge/license-Apache2.0%2FMIT-blue.svg)

[![Backers on Open Collective](https://opencollective.com/rust-battery/backers/badge.svg)](#backers)

[![Sponsors on Open Collective](https://opencollective.com/rust-battery/sponsors/badge.svg)](#sponsors)



> Rust crate providing cross-platform information about the notebook batteries.



## Table of contents



 * [Overview](#overview)

 * [Supported platforms](#supported-platforms)

 * [Install](#install)

 * [Examples](#examples)

 * [FFI bindings](#ffi-bindings)

 * [Users](#users)

 * [License](#license)

 * [Donations](#donations)

 * [Contributors](#contributors)

 * [Backers](#backers)

 * [Sponsors](#sponsors)



## Overview



`battery` provides a cross-platform unified API to a notebook batteries state.



Its main goal is to wrap the OS-specific interfaces, cover all the hacks and legacy cases

and get the batteries information (such as state of charge, energy rate, voltage and temperature)

as a typed values, recalculated as necessary to be returned as a [SI measurement units](https://www.bipm.org/en/measurement-units/).



## Supported platforms



* Linux 2.6.39+

* MacOS 10.10+

* iOS

* Windows 7+

* FreeBSD

* DragonFlyBSD



Do note that iOS implementation uses IOKit bindings, your application

might be automatically rejected by Apple based on that fact. Use it on your own risk.



## Install



As a prerequisite, `battery` crate requires at least Rustc version **1.36** or greater.



Add the following line into a `Cargo.toml`:



```toml

[dependencies]

battery = "0.7.8"

```



## Examples



```rust

fn main() -> Result<(), battery::Error> {

    let manager = battery::Manager::new()?;



    for (idx, maybe_battery) in manager.batteries()?.enumerate() {

        let battery = maybe_battery?;

        println!("Battery #{}:", idx);

        println!("Vendor: {:?}", battery.vendor());

        println!("Model: {:?}", battery.model());

        println!("State: {:?}", battery.state());

        println!("Time to full charge: {:?}", battery.time_to_full());

        println!("");

    }



    Ok(())

}

```



See the `battery/examples/` folder in the [repository](https://github.com/svartalf/rust-battery/blob/master/battery/examples/simple.rs)

for additional examples.



## FFI bindings



Experimental [battery-ffi](https://crates.io/crates/battery-ffi) crate provides the FFI bindings to the `battery` crate,

so it can be used with other languages, such as C, Python or NodeJS.



Check its [README](https://github.com/svartalf/rust-battery/tree/master/battery-ffi)

and [documentation](https://docs.rs/battery-ffi) for details.



## Users



This an incomplete list of the `battery` crate users. If you are using it too,

send me a message and I'll add your project here!



### battop



[`battop`](https://github.com/svartalf/rust-battop) is an interactive viewer,

similar to `top`, `htop` and other \*top utilities, but about the batteries installed in your notebook.\

It is using the `battery` crate API to show the batteries information in your terminal.



### starship



[`starship`](https://github.com/starship/starship) is a Rust port of the minimalistic, powerful,

and extremely customizable prompt Spaceship ZSH.\

It is using the `battery` crate to show the the current battery level and status in a shell prompt.



Here is what [@matchai](https://github.com/matchai) says:



> I really appreciate how easily we were able to get your library up and running!

> Battery APIs were a headache for us in predecessors of this project 😅



And there is [this tweet](https://twitter.com/matchai/status/1135906726392283136) also!



## License



Licensed under either of [Apache License 2.0](https://github.com/svartalf/rust-battery/blob/master/LICENSE-APACHE)

or [MIT license](https://github.com/svartalf/rust-battery/blob/master/LICENSE-MIT) at your option.



Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you,

as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.



## Donations



If you appreciate my work and want to support me, you can do it [here](https://svartalf.info/donate/) or

support this project at [Open Collective](https://opencollective.com/rust-battery).



## Contributors



This project exists thanks to all the people who contribute.




## Backers



Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/rust-battery#backer)]






## Sponsors



Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/rust-battery#sponsor)]