115 lines
4.0 KiB
Markdown
115 lines
4.0 KiB
Markdown
# SimConnect SDK
|
|
|
|
[![Crates][crates_badge]][crates]
|
|
[![Documentation][documentation_badge]][documentation]
|
|
[![CI][ci_badge]][ci]
|
|
[![license][license_badge]][license]
|
|
[![Crates.io][crates_downloads_badge]][crates]\
|
|
An opinionated SimConnect Client that encapsulates the C API fully and optimizes for developer experience.
|
|
|
|
## Usage
|
|
|
|
```toml
|
|
[dependencies]
|
|
simconnect-sdk = { version = "0.2", features = ["derive"] }
|
|
```
|
|
|
|
```rust
|
|
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][examples].
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome and encouraged! See [CONTRIBUTING.md][contributing].
|
|
|
|
## Supported features
|
|
|
|
See [FEATURES.md][features].
|
|
|
|
## Credits
|
|
|
|
Inspired by [rylev/msfs2020][msfs2020] and [Sequal32/simconnect-rust][simconnect-rust].
|
|
|
|
[crates_badge]: https://img.shields.io/crates/v/simconnect-sdk.svg
|
|
[crates]: https://crates.io/crates/simconnect-sdk
|
|
[documentation_badge]: https://docs.rs/simconnect-sdk/badge.svg
|
|
[documentation]: https://docs.rs/simconnect-sdk
|
|
[ci_badge]: https://github.com/mihai-dinculescu/simconnect-sdk-rs/workflows/CI/badge.svg?branch=main
|
|
[ci]: https://github.com/mihai-dinculescu/simconnect-sdk-rs/actions
|
|
[license_badge]: https://img.shields.io/crates/l/simconnect-sdk.svg
|
|
[license]: https://github.com/mihai-dinculescu/simconnect-sdk-rs/blob/main/LICENSE
|
|
[crates_downloads_badge]: https://img.shields.io/crates/d/simconnect-sdk?label=downloads
|
|
[examples]: https://github.com/mihai-dinculescu/simconnect-sdk-rs/tree/main/examples
|
|
[contributing]: https://github.com/mihai-dinculescu/simconnect-sdk-rs/blob/main/CONTRIBUTING.md
|
|
[features]: https://github.com/mihai-dinculescu/simconnect-sdk-rs/blob/main/FEATURES.md
|
|
[msfs2020]: https://github.com/rylev/msfs2020
|
|
[simconnect-rust]: https://github.com/Sequal32/simconnect-rust
|