AVAM/simconnect-sdk-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve the examples

Browse Source
This commit is contained in:
Mihai Dinculescu
2022-10-12 23:27:19 +01:00
parent 9b7e3b97db
commit 307b83ea95
11 changed files with 367 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
examples/Cargo.toml
View File

@@ -12,8 +12,16 @@ name = "basic"
path = "src/basic.rs"
[[bin]]
name = "basic_no_macros"
path = "src/basic_no_macros.rs"
name = "basic_with_tracing"
path = "src/basic_with_tracing.rs"
[[bin]]
name = "basic_without_macro"
path = "src/basic_without_macro.rs"
[[bin]]
name = "multiple_objects"
path = "src/multiple_objects.rs"
[dependencies]
tracing = "0.1"

32
examples/README.md Normal file
View File

@@ -0,0 +1,32 @@
# SimConnect SDK Examples
## Checkout the repository
```bash
git clone git@github.com:mihai-dinculescu/simconnect-sdk.git
cd simconnect-sdk
```
## Receiving data
```bash
cargo run --bin basic
```
## Using tracing
```bash
RUST_LOG=info cargo run --bin basic_with_tracing
```
## Receiving data without the derive macro
```bash
cargo run --bin basic_without_macro
```
## Multiple objects
```bash
cargo run --bin multiple_objects
```

32
examples/src/basic.rs
View File

@@ -1,9 +1,8 @@
#![allow(dead_code)]
use simconnect_sdk::{Notification, SimConnect, SimConnectObject};
use simconnect_sdk_examples::setup_logging;
use tracing::{error, info};
/// A data structure that will be used to receive data from SimConnect.
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second")]
struct GpsData {
@@ -13,22 +12,9 @@ struct GpsData {
lon: f64,
#[simconnect(name = "PLANE LONGITUDE", unit = "degrees")]
alt: f64,
#[simconnect(name = "GPS GROUND MAGNETIC TRACK", unit = "degrees")]
gps_ground_magnetic_track: f64,
#[simconnect(name = "GPS GROUND SPEED", unit = "Meters per second")]
gps_ground_speed: f64,
}
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second", condition = "changed")]
pub struct OnGround {
#[simconnect(name = "SIM ON GROUND", unit = "bool")]
sim_on_ground: bool,
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
setup_logging()?;
let client = SimConnect::new("Simple Program");
match client {
@@ -37,26 +23,24 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
match notification {
Some(Notification::Open) => {
info!("Open");
println!("Open");
// The struct must be registered after the connection is successfully open
client.register_object::<GpsData>()?;
client.register_object::<OnGround>()?;
}
Some(Notification::Data(data)) => {
if let Ok(gps_data) = GpsData::try_from(&data) {
info!("GPS Data: {gps_data:?}");
continue;
}
if let Ok(on_ground) = OnGround::try_from(&data) {
info!("On Ground data: {on_ground:?}");
continue;
println!("GPS Data: {gps_data:?}");
}
}
_ => (),
}
// sleep for about a frame to reduce CPU usage
std::thread::sleep(std::time::Duration::from_millis(16));
},
Err(e) => {
error!("{e:?}")
println!("Error: {e:?}")
}
}

66
examples/src/basic_with_tracing.rs Normal file
View File

@@ -0,0 +1,66 @@
#![allow(dead_code)]
use simconnect_sdk::{Notification, SimConnect, SimConnectObject};
use tracing::{error, info};
use tracing_subscriber::{fmt, prelude::*, EnvFilter};
/// A data structure that will be used to receive data from SimConnect.
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second")]
struct GpsData {
#[simconnect(name = "PLANE LATITUDE", unit = "degrees")]
lat: f64,
#[simconnect(name = "PLANE LONGITUDE", unit = "degrees")]
lon: f64,
#[simconnect(name = "PLANE LONGITUDE", unit = "degrees")]
alt: f64,
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
setup_logging()?;
let client = SimConnect::new("Simple Program");
match client {
Ok(mut client) => loop {
let notification = client.get_next_dispatch()?;
match notification {
Some(Notification::Open) => {
info!("Open");
// The struct must be registered after the connection is successfully open
client.register_object::<GpsData>()?;
}
Some(Notification::Data(data)) => {
if let Ok(gps_data) = GpsData::try_from(&data) {
info!("GPS Data: {gps_data:?}");
}
}
_ => (),
}
// sleep for about a frame to reduce CPU usage
std::thread::sleep(std::time::Duration::from_millis(16));
},
Err(e) => {
error!("{e:?}")
}
}
Ok(())
}
fn setup_logging() -> Result<(), Box<dyn std::error::Error>> {
let filter_layer = EnvFilter::try_from_default_env().or_else(|_| EnvFilter::try_new("info"))?;
let fmt_layer = fmt::layer()
.with_target(false)
.with_span_events(fmt::format::FmtSpan::FULL);
tracing_subscriber::registry()
.with(filter_layer)
.with(fmt_layer)
.init();
Ok(())
}

59
examples/src/basic_no_macros.rs → examples/src/basic_without_macro.rs
View File

@@ -4,17 +4,13 @@ use simconnect_sdk::{
Condition, DataType, Notification, NotificationData, Period, SimConnect, SimConnectError,
SimConnectObjectExt,
};
use tracing::{error, info};
use simconnect_sdk_examples::setup_logging;
/// A data structure that will be used to receive data from SimConnect.
#[derive(Debug, Clone)]
pub struct GpsData {
lat: f64,
lon: f64,
alt: f64,
gps_ground_magnetic_track: f64,
gps_ground_speed: f64,
}
impl SimConnectObjectExt for GpsData {
@@ -22,18 +18,7 @@ impl SimConnectObjectExt for GpsData {
client.add_to_data_definition(id, "PLANE LATITUDE", "degrees", DataType::Float64)?;
client.add_to_data_definition(id, "PLANE LONGITUDE", "degrees", DataType::Float64)?;
client.add_to_data_definition(id, "PLANE ALTITUDE", "meters", DataType::Float64)?;
client.add_to_data_definition(
id,
"GPS GROUND MAGNETIC TRACK",
"degrees",
DataType::Float64,
)?;
client.add_to_data_definition(
id,
"GPS GROUND SPEED",
"Meters per second",
DataType::Float64,
)?;
client.request_data_on_sim_object(id, Period::Second, Condition::None, 0)?;
Ok(())
@@ -48,31 +33,7 @@ impl TryFrom<&NotificationData> for GpsData {
}
}
#[derive(Debug, Clone)]
pub struct OnGround {
sim_on_ground: bool,
}
impl SimConnectObjectExt for OnGround {
fn register(client: &mut SimConnect, id: u32) -> Result<(), SimConnectError> {
client.add_to_data_definition(id, "SIM ON GROUND", "bool", DataType::Bool)?;
client.request_data_on_sim_object(id, Period::Second, Condition::Changed, 0)?;
Ok(())
}
}
impl TryFrom<&NotificationData> for OnGround {
type Error = SimConnectError;
fn try_from(value: &NotificationData) -> Result<Self, Self::Error> {
value.try_transmute::<OnGround>()
}
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
setup_logging()?;
let client = SimConnect::new("Simple Program");
match client {
@@ -81,26 +42,24 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
match notification {
Some(Notification::Open) => {
info!("Open");
println!("Open");
// The struct must be registered after the connection is successfully open
client.register_object::<GpsData>()?;
client.register_object::<OnGround>()?;
}
Some(Notification::Data(data)) => {
if let Ok(gps_data) = GpsData::try_from(&data) {
info!("GPS Data: {gps_data:?}");
continue;
}
if let Ok(on_ground) = OnGround::try_from(&data) {
info!("On Ground data: {on_ground:?}");
continue;
println!("GPS Data: {gps_data:?}");
}
}
_ => (),
}
// sleep for about a frame to reduce CPU usage
std::thread::sleep(std::time::Duration::from_millis(16));
},
Err(e) => {
error!("{e:?}")
println!("Error: {e:?}")
}
}

15
examples/src/lib.rs
View File

@@ -1,15 +0,0 @@
use tracing_subscriber::{fmt, prelude::*, EnvFilter};
pub fn setup_logging() -> Result<(), Box<dyn std::error::Error>> {
let filter_layer = EnvFilter::try_from_default_env().or_else(|_| EnvFilter::try_new("info"))?;
let fmt_layer = fmt::layer()
.with_target(false)
.with_span_events(fmt::format::FmtSpan::FULL);
tracing_subscriber::registry()
.with(filter_layer)
.with(fmt_layer)
.init();
Ok(())
}

64
examples/src/multiple_objects.rs Normal file
View File

@@ -0,0 +1,64 @@
#![allow(dead_code)]
use simconnect_sdk::{Notification, SimConnect, SimConnectObject};
/// A data structure that will be used to receive data from SimConnect.
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second")]
struct GpsData {
#[simconnect(name = "PLANE LATITUDE", unit = "degrees")]
lat: f64,
#[simconnect(name = "PLANE LONGITUDE", unit = "degrees")]
lon: f64,
#[simconnect(name = "PLANE LONGITUDE", unit = "degrees")]
alt: f64,
}
/// A second data structure that will be used to receive data from SimConnect.
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second", condition = "changed")]
pub struct OnGround {
#[simconnect(name = "SIM ON GROUND", unit = "bool")]
sim_on_ground: bool,
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = SimConnect::new("Simple Program");
match client {
Ok(mut client) => loop {
let notification = client.get_next_dispatch()?;
match notification {
Some(Notification::Open) => {
println!("Open");
// The structs must be registered after the connection is successfully open
client.register_object::<GpsData>()?;
client.register_object::<OnGround>()?;
}
Some(Notification::Data(data)) => {
if let Ok(gps_data) = GpsData::try_from(&data) {
println!("GPS Data: {gps_data:?}");
// We've already got our object, there's no point in trying another in this iteration
continue;
}
if let Ok(on_ground) = OnGround::try_from(&data) {
println!("On Ground data: {on_ground:?}");
// We've already got our object, there's no point in trying another in this iteration
continue;
}
}
_ => (),
}
// sleep for about a frame to reduce CPU usage
std::thread::sleep(std::time::Duration::from_millis(16));
},
Err(e) => {
println!("Error: {e:?}")
}
}
Ok(())
}