kerb 0.1.2

Real-time telemetry from racing simulators — iRacing, AC Evo, Le Mans Ultimate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Real-time telemetry from sim-racing titles: iRacing, Assetto Corsa, AC Evo, Le Mans Ultimate.
//!
//! # Quick start
//!
//! ```no_run
//! use kerb::{Connection, SimConnection};
//!
//! let conn = SimConnection::connect().expect("no sim running");
//! match conn {
//!     #[cfg(feature = "iracing")]
//!     Connection::IRacing(c) => {
//!         c.wait_for_data(16);
//!         let frame = c.frame().expect("failed to read frame");
//!         println!("rpm={} gear={}", frame.rpm, frame.gear);
//!     }
//!     #[cfg(feature = "ac-evo")]
//!     Connection::AcEvo(c) => {
//!         let frame = c.frame().expect("failed to read frame");
//!         println!("rpm={} gear={}", frame.physics.rpms, frame.physics.gear);
//!     }
//!     #[cfg(feature = "lmu")]
//!     Connection::Lmu(c) => {
//!         let frame = c.frame().expect("failed to read frame");
//!         let _ = frame;
//!     }
//!     _ => {}
//! }
//! ```
//!
//! # Feature flags
//!
//! | Feature   | Sim                            | `Connection` variant  |
//! |-----------|--------------------------------|-----------------------|
//! | `iracing` | iRacing                        | `Connection::IRacing` |
//! | `ac`      | Assetto Corsa + AC Evo (auto)  | `Connection::Ac`      |
//! | `lmu`     | Le Mans Ultimate               | `Connection::Lmu`     |
//!
//! Enable multiple features if your overlay supports several sims.
//! [`SimConnection::connect`] tries each enabled sim in order and returns the
//! first one running.

#[cfg(not(any(feature = "iracing", feature = "ac-evo", feature = "lmu")))]
compile_error!(
    "kerb: no simulator features enabled. \
     Add at least one of: \"iracing\", \"ac\", \"lmu\""
);

#[cfg(not(target_os = "windows"))]
compile_error!("kerb only supports Windows targets (iRacing/AC/LMU use Windows Shared Memory API)");

pub(crate) mod error;
pub(crate) mod serializer;
pub(crate) mod types;
pub(crate) mod utils;

pub(crate) mod connection;
pub(crate) mod sim_string;

#[cfg(feature = "iracing")]
pub mod iracing;

#[cfg(feature = "ac-evo")]
pub mod ac_evo;

#[cfg(feature = "lmu")]
pub mod lmu;

#[doc(hidden)]
#[allow(missing_docs)]
pub mod shm;

pub use connection::{Connection, SimConnection, SimType};
pub use error::SimError;
pub use sim_string::{SimString, SimStringU16};
pub use types::{TelemetryValue, VarMeta};
pub use utils::decode_cp1252;

#[cfg(feature = "iracing")]
pub use utils::save_session;

#[cfg(any(feature = "iracing", feature = "ac-evo", feature = "lmu"))]
pub use utils::{HasSnapshot, save_telemetry_snapshot, save_var_list_snapshot};