SimConnect SDK
An opinionated SimConnect Client that encapsulates the C API fully and optimizes for developer experience.
Usage
[dependencies]
simconnect-sdk = { version = "0.2", features = ["derive"] }
use simconnect_sdk::{Notification, SimConnect, SimConnectObject};
/// A data structure that will be used to receive data from SimConnect.
/// See the documentation of `SimConnectObject` for more information on the arguments of the `simconnect` attribute.
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second")]
#[allow(dead_code)]
struct AirplaneData {
#[simconnect(name = "TITLE")]
title: String,
#[simconnect(name = "CATEGORY")]
category: String,
#[simconnect(name = "PLANE LATITUDE", unit = "degrees")]
lat: f64,
#[simconnect(name = "PLANE LONGITUDE", unit = "degrees")]
lon: f64,
#[simconnect(name = "PLANE ALTITUDE", unit = "feet")]
alt: f64,
#[simconnect(name = "SIM ON GROUND")]
sim_on_ground: bool,
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = SimConnect::new("Receiving data example");
match client {
Ok(mut client) => {
let mut notifications_received = 0;
loop {
let notification = client.get_next_dispatch()?;
match notification {
Some(Notification::Open) => {
println!("Connection opened.");
// After the connection is successfully open, we register the struct
client.register_object::<AirplaneData>()?;
}
Some(Notification::Object(data)) => {
if let Ok(airplane_data) = AirplaneData::try_from(&data) {
println!("{airplane_data:?}");
notifications_received += 1;
// After we have received 10 notifications, we unregister the struct
if notifications_received > 10 {
client.unregister_object::<AirplaneData>()?;
println!("Subscription stopped.");
break;
}
}
}
_ => (),
}
// sleep for about a frame to reduce CPU usage
std::thread::sleep(std::time::Duration::from_millis(16));
}
}
Err(e) => {
println!("Error: {e:?}")
}
}
Ok(())
}
See more examples.
Contributing
Contributions are welcome and encouraged! See CONTRIBUTING.md.
Supported features
See FEATURES.md.
Credits
Inspired by rylev/msfs2020 and Sequal32/simconnect-rust.
2.1k Jan 5, 2023
2.1k Dec 30, 2022
5 Feb 23, 2024
23 Dec 30, 2022
210 Dec 22, 2022
6 Mar 23, 2023
175 Dec 31, 2022
2.3k Jan 1, 2023
16 Oct 3, 2022
14 Dec 26, 2022
4 Jul 23, 2022
14 Dec 10, 2022
134 Dec 8, 2022
179 Nov 18, 2022
2 Jan 3, 2022
5 Dec 21, 2022
139 Dec 30, 2022
2.3k Jan 3, 2023
403 Dec 25, 2022