battery_rs/lib.rs
1#![cfg_attr(not(feature = "std"), no_std)]
2#![forbid(unsafe_code)]
3//#![warn(missing_docs)]
4
5//! `battery-rs` is an open framework for battery software engineering.
6//!
7//! It provides common, platform-independent building blocks for battery
8//! algorithms, integration, validation, data handling and deployment.
9
10/// Battery algorithms such as state estimation and diagnostics.
11pub mod algorithms;
12/// Core domain types and framework traits.
13pub mod core;
14/// Battery data representations and processing utilities.
15pub mod data;
16/// Interfaces to hardware, protocols and external tools.
17pub mod integration;
18/// Deployment abstractions for embedded, desktop and backend targets.
19pub mod platform;
20/// Replay, metrics and validation utilities.
21pub mod validation;
22
23pub use crate::core::{
24 BatteryState, Capacity, Current, Energy, Estimator, Measurement, Power, Resistance,
25 StateOfCharge, StateOfHealth, Temperature, TimeDelta, Timestamp, Voltage,
26};