1 [![Build Status](https://travis-ci.org/ibnfirnas/erlang-x_plane_data.svg?branch=master)](https://travis-ci.org/ibnfirnas/erlang-x_plane_data)
3 X-Plane UDP data parser
4 =======================
9 ### Receive data packet
12 {ok, Socket} = gen_udp:open(Port, [binary, {active, false}]),
13 {ok, {_, _, <<XPlaneDataPacket/binary>>}} = gen_udp:recv(Socket, 0),
19 {ok, {64=Index, GroupsRaw}=DataRaw} = x_plane_data_raw:of_bin(XPlaneDataPacket),
22 ### Access parsed data
26 At this stage, only the structure of the packet was parsed. No attempt at
27 interpreting the values have been made:
30 % Speeds are in group 3
31 {3, Speeds} = lists:keyfind(3, 1, GroupsRaw),
42 % Pitch roll and headings values are in group 17
43 {17, PitchRollHeadings} = lists:keyfind(17, 1, GroupsRaw),
52 } = PitchRollHeadings,
57 Here we identify what each of the numbered groups mean in a given X-Plane
58 version. Right now only X-Plane 10 is supported and I only identified 3 groups
61 - index: `3` , name: `speeds`
62 - index: `17`, name: `pitch_roll_heading`
63 - index: `20`, name: `lat_lon_alt`
65 Unidentified groups (with index other than what is listed above) will be
66 absent from the list of named groups (think of `x_plane_data_named:of_raw/1` as
67 a filter), so you'll have to access their raw version, if needed.
71 {ok, {x_plane_data_v10, GroupsNamed}} = x_plane_data_named:of_raw(DataRaw),
76 -include_lib("x_plane_data_group_lat_lon_alt.hrl").
77 -include_lib("x_plane_data_group_pitch_roll_heading.hrl").
78 -include_lib("x_plane_data_group_speeds.hrl").
82 {speeds, #x_plane_data_group_speeds
83 { vind_kias = VindKias
84 , vind_keas = VindKeas
85 , vtrue_ktas = VtrueKtas
86 , vtrue_ktgs = VtrueKtgs
88 , vtrue_mphas = VtrueMphas
89 , vtrue_mphgs = VtrueMphgs
91 } = lists:keyfind(speeds, 1, GroupsNamed),
93 {pitch_roll_heading, #x_plane_data_group_pitch_roll_heading
94 { pitch_deg = PitchDeg
96 , hding_true = HdingTrue
97 , hding_mag = HdingMag
99 } = lists:keyfind(pitch_roll_heading, 1, GroupsNamed),
102 Data format references
103 ----------------------
105 - http://b58.svglobe.com/data.html
106 - http://www.nuclearprojects.com/xplane/xplaneref.html