SimConnect_TransmitClientEvent Implementation

[Sector95]

Example usage, setting the COM1 standby frequency to 127.625 and transponder to 7700:

use simconnect_sdk::{SimConnect, EventFlag, ClientEventRequest, ClientEvent};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = SimConnect::new("Test");

    match client {
        Ok(mut client) => {
            client.subscribe_to_client_event(ClientEventRequest::Com1RadioStbySet)?;
            client.subscribe_to_client_event(ClientEventRequest::TransponderSet)?;

            let com1_event: ClientEvent = ClientEvent::Com1RadioStbySet { value: 123.625 };
            client.transmit_client_event(0, com1_event, EventFlag::DoNothing)?;

            let xpndr_event: ClientEvent = ClientEvent::TransponderSet { value: 7700 };
            client.transmit_client_event(0, xpndr_event, EventFlag::DoNothing)?;
        }
        Err(e) => {
            println!("Error: {e:?}")
        }
    }

    Ok(())
}

[mihai-dinculescu]

This is very welcome. Thank you!

Unfortunately, the little there is about ClientEvent and NotificationGroup is neither correct nor ergonomic. Please give me a few days to develop something better to base this PR on.

[mihai-dinculescu]

OK, it's done. It ended up being a pretty chunky refactor. https://github.com/mihai-dinculescu/simconnect-sdk-rs/commit/d89fa524c2bc585f806f44143a7d95d09040968f.

Probably it's best to read the whole changelog for the rebase, but here are the main takeaways:

• register_event has been replaced by subscribe_to_client_event. transmit_client_event will require the user to call subscribe_to_client_event beforehand. It's not ideal, but the SimConnect API is not leaving much choice.
• there is now a client_event_register that can be used to determine if the event has been subscribed to, like here.
• The client event enum is now split into ClientEventRequest and ClientEvent. Having transmit_client_event take a ClientEvent will improve the API by making it evident to the user when they have to provide a data field and its purpose. This conversion will probably prove handy to you.

[Sector95]

Thanks, I'll take a look and rebase when I get a moment here 👍

[SafeShows]

Hey @Sector95 How's the feature coming along as I have an app idea that need to write data to sim and or trigger events in the sim

[Sector95]

Hey @Sector95 How's the feature coming along as I have an app idea that need to write data to sim and or trigger events in the sim

Hey sorry, life's been wild, I'll try to tackle this sometime this week!

[Sector95]

Updated the example, and merged in your code changes. Sorry for the delay!

[Sector95]

Implemented a little cleaner of an interface for both radios and transponders, so the client doesn't have to do conversion or encoding. Updated the example on this PR for the new pattern, demonstrating both setting radios and transponders.

Also swapped i32 for u32 for the From<ClientEvent> for (ClientEventRequest, i32) trait, as the SimConnect::transmit_client_event function requires a u32 for the dword value anyway.

[Sector95]

Think I've addressed what showed up in the format workflow there. Let me know if they're is anything else left outstanding.

[mihai-dinculescu]

The BCD conversion is excellent! Thanks for adding it!

[MrMinimal]

Given that this isn't merged, does simconnect-sdk-rs currently have the ability to transmit client events and set data (e. g. frequencies) in the sim?

[mihai-dinculescu]

Given that this isn't merged, does simconnect-sdk-rs currently have the ability to transmit client events and set data (e. g. frequencies) in the sim?

Not without this PR.

@Sector95 are you happy to wrap up the PR? I believe that it's getting very close.