simconnect-sdk 0.2.3

SimConnect SDK. An opinionated SimConnect Client that encapsulates the C API fully and optimizes for developer experience.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use crate::bindings;

/// Facility Type. The simulation keeps a facilities cache of all the airports, waypoints, NDB and VOR stations within a certain radius of the user aircraft.
/// They can be requested using [`crate::SimConnect::subscribe_to_facilities`] or [`crate::SimConnect::request_facilities_list`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum FacilityType {
    Airport,
    Waypoint,
    NDB,
    VOR,
}

impl From<FacilityType> for i32 {
    fn from(facility_type: FacilityType) -> Self {
        match facility_type {
            FacilityType::Airport => {
                bindings::SIMCONNECT_FACILITY_LIST_TYPE_SIMCONNECT_FACILITY_LIST_TYPE_AIRPORT
            }
            FacilityType::Waypoint => {
                bindings::SIMCONNECT_FACILITY_LIST_TYPE_SIMCONNECT_FACILITY_LIST_TYPE_WAYPOINT
            }
            FacilityType::NDB => {
                bindings::SIMCONNECT_FACILITY_LIST_TYPE_SIMCONNECT_FACILITY_LIST_TYPE_NDB
            }
            FacilityType::VOR => {
                bindings::SIMCONNECT_FACILITY_LIST_TYPE_SIMCONNECT_FACILITY_LIST_TYPE_VOR
            }
        }
    }
}

impl FacilityType {
    pub fn to_type_name(&self) -> String {
        match self {
            FacilityType::Airport => std::any::type_name::<Airport>(),
            FacilityType::Waypoint => std::any::type_name::<Waypoint>(),
            FacilityType::NDB => std::any::type_name::<NDB>(),
            FacilityType::VOR => std::any::type_name::<VOR>(),
        }
        .into()
    }
}

/// Information on a single airport in the facilities cache.
#[derive(Debug, Clone)]
pub struct Airport {
    /// ICAO of the facility.
    pub icao: String,
    /// Latitude of the airport in facility.
    pub lat: f64,
    /// Longitude of the airport in facility.
    pub lon: f64,
    /// Altitude of the facility in meters.
    pub alt: f64,
}

/// Information on a single waypoint in the facilities cache.
#[derive(Debug, Clone)]
pub struct Waypoint {
    /// ICAO of the facility.
    pub icao: String,
    /// Latitude of the airport in facility.
    pub lat: f64,
    /// Longitude of the airport in facility.
    pub lon: f64,
    /// Altitude of the facility in meters.
    pub alt: f64,
    /// The magnetic variation of the waypoint in degrees.
    pub mag_var: f32,
}

/// Information on a single NDB station in the facilities cache.
#[derive(Debug, Clone)]
pub struct NDB {
    /// ICAO of the facility.
    pub icao: String,
    /// Latitude of the airport in facility.
    pub lat: f64,
    /// Longitude of the airport in facility.
    pub lon: f64,
    /// Altitude of the facility in meters.
    pub alt: f64,
    /// The magnetic variation of the waypoint in degrees.
    pub mag_var: f32,
    /// Frequency of the station in Hz.
    pub frequency: u32,
}

/// Information on a single VOR station in the facilities cache.
#[derive(Debug, Clone)]
pub struct VOR {
    /// ICAO of the facility.
    pub icao: String,
    /// Latitude of the airport in facility.
    pub lat: f64,
    /// Longitude of the airport in facility.
    pub lon: f64,
    /// Altitude of the facility in meters.
    pub alt: f64,
    /// The magnetic variation of the waypoint in degrees.
    pub mag_var: f32,
    /// True if the station has a NAV transmitter, and if so, `glide_lat`, `glide_lon` and `glide_alt` contain valid data.
    pub has_nav_signal: bool,
    /// True if the station transmits an ILS localizer angle, and if so `localizer` contains valid data.
    pub has_localizer: bool,
    /// True if the station transmits an ILS approach angle, and if so `glide_slope_angle` contains valid data.
    pub has_glide_slope: bool,
    /// True if the station transmits a DME signal, and if so the inherited DME fFrequency contains valid data.
    pub has_dme: bool,
    /// The ILS localizer angle in degrees.
    pub localizer: Option<f32>,
    /// The latitude of the glide slope transmitter in degrees.
    pub glide_lat: Option<f64>,
    /// The longitude of the glide slope transmitter in degrees.
    pub glide_lon: Option<f64>,
    /// The altitude of the glide slope transmitter in degrees.
    pub glide_alt: Option<f64>,
    /// The ILS approach angle in degrees.
    pub glide_slope_angle: Option<f32>,
    /// Frequency of the station in Hz.
    pub frequency: Option<u32>,
}