1 // radiostack.cxx -- class to manage an instance of the radio stack
3 // Written by Curtis Olson, started April 2000.
5 // Copyright (C) 2000 Curtis L. Olson - curt@flightgear.org
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <simgear/math/sg_random.h>
26 #include <Aircraft/aircraft.hxx>
27 #include <Main/bfi.hxx>
28 #include <Navaids/ilslist.hxx>
29 #include <Navaids/navlist.hxx>
30 #include <Time/event.hxx>
32 #include "radiostack.hxx"
34 static int nav1_play_count = 0;
35 static time_t nav1_last_time = 0;
39 * Boy, this is ugly! Make the VOR range vary by altitude difference.
42 kludgeRange (double stationElev, double aircraftElev, double nominalRange)
44 // Assume that the nominal range (usually
45 // 50nm) applies at a 5,000 ft difference.
47 double factor = ((aircraftElev*METER_TO_FEET) - stationElev) / 1000.0;
48 double range = fabs(nominalRange * factor);
50 // Clamp the range to keep it sane; for
51 // now, never less than 25% or more than
52 // 500% of nominal range.
53 if (range < nominalRange/4.0) {
54 range = nominalRange/4.0;
55 } else if (range > nominalRange*5.0) {
56 range = nominalRange*5.0;
63 FGRadioStack *current_radiostack;
66 // periodic radio station search wrapper
67 static void fgRadioSearch( void ) {
68 current_radiostack->search();
72 FGRadioStack::FGRadioStack() {
78 longitudeVal = fgGetValue("/position/longitude");
79 latitudeVal = fgGetValue("/position/latitude");
80 altitudeVal = fgGetValue("/position/altitude");
85 FGRadioStack::~FGRadioStack()
87 unbind(); // FIXME: should be called externally
99 // Search radio database once per second
100 global_events.Register( "fgRadioSearch()", fgRadioSearch,
101 fgEVENT::FG_EVENT_READY, 1000);
105 FGRadioStack::bind ()
108 fgTie("/radios/nav1/frequencies/selected", this,
109 &FGRadioStack::get_nav1_freq, &FGRadioStack::set_nav1_freq);
110 fgTie("/radios/nav1/frequencies/standby", this,
111 &FGRadioStack::get_nav1_alt_freq, &FGRadioStack::set_nav1_alt_freq);
112 fgTie("/radios/nav1/radials/selected", this,
113 &FGRadioStack::get_nav1_sel_radial,
114 &FGRadioStack::set_nav1_sel_radial);
115 fgTie("/radios/nav1/on", this,
116 &FGRadioStack::get_nav1_on_btn,
117 &FGRadioStack::set_nav1_on_btn);
118 fgTie("/radios/nav1/ident", this,
119 &FGRadioStack::get_nav1_ident_btn,
120 &FGRadioStack::set_nav1_ident_btn);
123 fgTie("/radios/nav1/radials/actual", this, &FGRadioStack::get_nav1_radial);
124 fgTie("/radios/nav1/to-flag", this, &FGRadioStack::get_nav1_to_flag);
125 fgTie("/radios/nav1/from-flag", this, &FGRadioStack::get_nav1_from_flag);
126 fgTie("/radios/nav1/in-range", this, &FGRadioStack::get_nav1_inrange);
127 fgTie("/radios/nav1/dme/distance", this, &FGRadioStack::get_nav1_dme_dist);
128 fgTie("/radios/nav1/dme/in-range", this,
129 &FGRadioStack::get_nav1_dme_inrange);
130 fgTie("/radios/nav1/heading-needle-deflection", this,
131 &FGRadioStack::get_nav1_heading_needle_deflection);
132 fgTie("/radios/nav1/gs-needle-deflection", this,
133 &FGRadioStack::get_nav1_gs_needle_deflection);
136 fgTie("/radios/nav2/frequencies/selected", this,
137 &FGRadioStack::get_nav2_freq, &FGRadioStack::set_nav2_freq);
138 fgTie("/radios/nav2/frequencies/standby", this,
139 &FGRadioStack::get_nav2_alt_freq, &FGRadioStack::set_nav2_alt_freq);
140 fgTie("/radios/nav2/radials/selected", this,
141 &FGRadioStack::get_nav2_sel_radial,
142 &FGRadioStack::set_nav2_sel_radial);
143 fgTie("/radios/nav2/on", this,
144 &FGRadioStack::get_nav2_on_btn,
145 &FGRadioStack::set_nav2_on_btn);
146 fgTie("/radios/nav2/ident", this,
147 &FGRadioStack::get_nav2_ident_btn,
148 &FGRadioStack::set_nav2_ident_btn);
151 fgTie("/radios/nav2/radials/actual", this, &FGRadioStack::get_nav2_radial);
152 fgTie("/radios/nav2/to-flag", this, &FGRadioStack::get_nav2_to_flag);
153 fgTie("/radios/nav2/from-flag", this, &FGRadioStack::get_nav2_from_flag);
154 fgTie("/radios/nav2/in-range", this, &FGRadioStack::get_nav2_inrange);
155 fgTie("/radios/nav2/dme/distance", this, &FGRadioStack::get_nav2_dme_dist);
156 fgTie("/radios/nav2/dme/in-range", this,
157 &FGRadioStack::get_nav2_dme_inrange);
158 fgTie("/radios/nav2/heading-needle-deflection", this,
159 &FGRadioStack::get_nav2_heading_needle_deflection);
160 fgTie("/radios/nav2/gs-needle-deflection", this,
161 &FGRadioStack::get_nav2_gs_needle_deflection);
164 fgTie("/radios/adf/frequencies/selected", this,
165 &FGRadioStack::get_adf_freq, &FGRadioStack::set_adf_freq);
166 fgTie("/radios/adf/frequencies/standby", this,
167 &FGRadioStack::get_adf_alt_freq, &FGRadioStack::set_adf_alt_freq);
168 fgTie("/radios/adf/rotation", this,
169 &FGRadioStack::get_adf_rotation, &FGRadioStack::set_adf_rotation);
173 FGRadioStack::unbind ()
175 fgUntie("/radios/nav1/frequencies/selected");
176 fgUntie("/radios/nav1/frequencies/standby");
177 fgUntie("/radios/nav1/radials/actual");
178 fgUntie("/radios/nav1/radials/selected");
179 fgUntie("/radios/nav1/on");
180 fgUntie("/radios/nav1/ident");
181 fgUntie("/radios/nav1/to-flag");
182 fgUntie("/radios/nav1/from-flag");
183 fgUntie("/radios/nav1/in-range");
184 fgUntie("/radios/nav1/dme/distance");
185 fgUntie("/radios/nav1/dme/in-range");
186 fgUntie("/radios/nav1/heading-needle-deflection");
187 fgUntie("/radios/nav1/gs-needle-deflection");
189 fgUntie("/radios/nav2/frequencies/selected");
190 fgUntie("/radios/nav2/frequencies/standby");
191 fgUntie("/radios/nav2/radials/actual");
192 fgUntie("/radios/nav2/radials/selected");
193 fgUntie("/radios/nav2/on");
194 fgUntie("/radios/nav2/ident");
195 fgUntie("/radios/nav2/to-flag");
196 fgUntie("/radios/nav2/from-flag");
197 fgUntie("/radios/nav2/in-range");
198 fgUntie("/radios/nav2/dme/distance");
199 fgUntie("/radios/nav2/dme/in-range");
200 fgUntie("/radios/nav2/heading-needle-deflection");
201 fgUntie("/radios/nav2/gs-needle-deflection");
203 fgUntie("/radios/adf/frequencies/selected");
204 fgUntie("/radios/adf/frequencies/standby");
205 fgUntie("/radios/adf/rotation");
208 // Update the various nav values based on position and valid tuned in navs
210 FGRadioStack::update()
212 double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
213 double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
214 double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
218 Point3D aircraft = sgGeodToCart( Point3D( lon, lat, elev ) );
223 station = Point3D( nav1_x, nav1_y, nav1_z );
224 nav1_loc_dist = aircraft.distance3D( station );
226 if ( nav1_has_dme ) {
227 // staightline distance
228 station = Point3D( nav1_dme_x, nav1_dme_y, nav1_dme_z );
229 nav1_dme_dist = aircraft.distance3D( station );
235 station = Point3D( nav1_gs_x, nav1_gs_y, nav1_gs_z );
236 nav1_gs_dist = aircraft.distance3D( station );
241 if ( nav1_loc_dist < nav1_effective_range * NM_TO_METER ) {
245 geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
246 nav1_loclat, nav1_loclon,
248 // cout << "az1 = " << az1 << " magvar = " << nav1_magvar << endl;
249 nav1_heading = az1 - nav1_magvar;
250 // Alex: nav1_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
252 // cout << " heading = " << nav1_heading
253 // << " dist = " << nav1_dist << endl;
255 nav1_inrange = false;
260 nav1_radial = nav1_sel_radial;
263 nav1_inrange = false;
265 // cout << "not picking up vor. :-(" << endl;
268 if ( nav1_valid && nav1_inrange ) {
269 // play station ident via audio system if on + ident,
270 // otherwise turn it off
271 if ( nav1_on_btn && nav1_ident_btn ) {
272 if ( nav1_last_time <
273 globals->get_time_params()->get_cur_time() - 30 ) {
274 nav1_last_time = globals->get_time_params()->get_cur_time();
277 if ( nav1_play_count < 4 ) {
279 if ( !globals->get_soundmgr()->is_playing("nav1-vor-ident") ) {
280 globals->get_soundmgr()->play_once( "nav1-vor-ident" );
283 } else if ( nav1_play_count < 5 && nav1_has_dme ) {
285 if ( !globals->get_soundmgr()->is_playing("nav1-vor-ident") &&
286 !globals->get_soundmgr()->is_playing("nav1-dme-ident") ) {
287 globals->get_soundmgr()->play_once( "nav1-dme-ident" );
292 globals->get_soundmgr()->stop( "nav1-vor-ident" );
293 globals->get_soundmgr()->stop( "nav1-dme-ident" );
298 station = Point3D( nav2_x, nav2_y, nav2_z );
299 nav2_loc_dist = aircraft.distance3D( station );
301 if ( nav2_has_dme ) {
302 // staightline distance
303 station = Point3D( nav2_dme_x, nav2_dme_y, nav2_dme_z );
304 nav2_dme_dist = aircraft.distance3D( station );
310 station = Point3D( nav2_gs_x, nav2_gs_y, nav2_gs_z );
311 nav2_gs_dist = aircraft.distance3D( station );
316 if ( nav2_loc_dist < nav2_effective_range * NM_TO_METER ) {
320 geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
321 nav2_loclat, nav2_loclon,
323 nav2_heading = az1 - nav2_magvar;
324 // Alex: nav2_heading = - (az1 - FGBFI::getMagVar() / RAD_TO_DEG);
326 // cout << " heading = " << nav2_heading
327 // << " dist = " << nav2_dist << endl;
329 nav2_inrange = false;
333 nav2_radial = nav2_sel_radial;
336 nav2_inrange = false;
337 // cout << "not picking up vor. :-(" << endl;
342 // staightline distance
343 station = Point3D( adf_x, adf_y, adf_z );
344 adf_dist = aircraft.distance3D( station );
346 if ( adf_dist < adf_effective_range * NM_TO_METER ) {
350 geo_inverse_wgs_84( elev, lat * RAD_TO_DEG, lon * RAD_TO_DEG,
355 // cout << " heading = " << nav2_heading
356 // << " dist = " << nav2_dist << endl;
366 // Update current nav/adf radio stations based on current postition
367 void FGRadioStack::search()
369 double lon = longitudeVal->getDoubleValue() * DEG_TO_RAD;
370 double lat = latitudeVal->getDoubleValue() * DEG_TO_RAD;
371 double elev = altitudeVal->getDoubleValue() * FEET_TO_METER;
377 static string last_nav1_ident = "";
378 static string last_nav2_ident = "";
380 if ( current_ilslist->query( lon, lat, elev, nav1_freq, &ils ) ) {
381 nav1_ident = ils.get_locident();
382 if ( last_nav1_ident != nav1_ident ) {
383 nav1_trans_ident = ils.get_trans_ident();
384 last_nav1_ident = nav1_ident;
387 nav1_has_dme = ils.get_has_dme();
388 nav1_has_gs = ils.get_has_gs();
390 nav1_loclon = ils.get_loclon();
391 nav1_loclat = ils.get_loclat();
392 nav1_gslon = ils.get_gslon();
393 nav1_gslat = ils.get_gslat();
394 nav1_dmelon = ils.get_dmelon();
395 nav1_dmelat = ils.get_dmelat();
396 nav1_elev = ils.get_gselev();
398 nav1_effective_range = FG_ILS_DEFAULT_RANGE;
399 nav1_target_gs = ils.get_gsangle();
400 nav1_radial = ils.get_locheading();
401 while ( nav1_radial < 0.0 ) { nav1_radial += 360.0; }
402 while ( nav1_radial > 360.0 ) { nav1_radial -= 360.0; }
403 nav1_x = ils.get_x();
404 nav1_y = ils.get_y();
405 nav1_z = ils.get_z();
406 nav1_gs_x = ils.get_gs_x();
407 nav1_gs_y = ils.get_gs_y();
408 nav1_gs_z = ils.get_gs_z();
409 nav1_dme_x = ils.get_dme_x();
410 nav1_dme_y = ils.get_dme_y();
411 nav1_dme_z = ils.get_dme_z();
413 if ( globals->get_soundmgr()->exists( "nav1-vor-ident" ) ) {
414 globals->get_soundmgr()->remove( "nav1-vor-ident" );
416 FGSimpleSound *sound;
417 sound = morse.make_ident( nav1_trans_ident, LO_FREQUENCY );
418 sound->set_volume( 0.3 );
419 globals->get_soundmgr()->add( sound, "nav1-vor-ident" );
421 if ( globals->get_soundmgr()->exists( "nav1-dme-ident" ) ) {
422 globals->get_soundmgr()->remove( "nav1-dme-ident" );
424 sound = morse.make_ident( nav1_trans_ident, HI_FREQUENCY );
425 sound->set_volume( 0.3 );
426 globals->get_soundmgr()->add( sound, "nav1-dme-ident" );
428 int offset = (int)(sg_random() * 30.0);
429 nav1_play_count = offset / 4;
430 nav1_last_time = globals->get_time_params()->get_cur_time() -
432 cout << "offset = " << offset << " play_count = " << nav1_play_count
433 << " nav1_last_time = " << nav1_last_time << " current time = "
434 << globals->get_time_params()->get_cur_time() << endl;
436 // cout << "Found an ils station in range" << endl;
437 // cout << " id = " << ils.get_locident() << endl;
439 } else if ( current_navlist->query( lon, lat, elev, nav1_freq, &nav ) ) {
440 nav1_ident = nav.get_ident();
441 if ( last_nav1_ident != nav1_ident ) {
442 last_nav1_ident = nav1_ident;
443 nav1_trans_ident = nav.get_trans_ident();
446 nav1_has_dme = nav.get_has_dme();
448 nav1_loclon = nav.get_lon();
449 nav1_loclat = nav.get_lat();
450 nav1_elev = nav.get_elev();
451 nav1_magvar = nav.get_magvar();
453 = kludgeRange(nav1_elev, elev, nav.get_range());
454 nav1_target_gs = 0.0;
455 nav1_radial = nav1_sel_radial;
456 nav1_x = nav1_dme_x = nav.get_x();
457 nav1_y = nav1_dme_y = nav.get_y();
458 nav1_z = nav1_dme_z = nav.get_z();
460 if ( globals->get_soundmgr()->exists( "nav1-vor-ident" ) ) {
461 globals->get_soundmgr()->remove( "nav1-vor-ident" );
463 FGSimpleSound *sound;
464 sound = morse.make_ident( nav1_trans_ident, LO_FREQUENCY );
465 sound->set_volume( 0.3 );
466 globals->get_soundmgr()->add( sound, "nav1-vor-ident" );
468 if ( globals->get_soundmgr()->exists( "nav1-dme-ident" ) ) {
469 globals->get_soundmgr()->remove( "nav1-dme-ident" );
471 sound = morse.make_ident( nav1_trans_ident, HI_FREQUENCY );
472 sound->set_volume( 0.3 );
473 globals->get_soundmgr()->add( sound, "nav1-dme-ident" );
475 int offset = (int)(sg_random() * 30.0);
476 nav1_play_count = offset / 4;
477 nav1_last_time = globals->get_time_params()->get_cur_time() -
479 cout << "offset = " << offset << " play_count = " << nav1_play_count
480 << " nav1_last_time = " << nav1_last_time << " current time = "
481 << globals->get_time_params()->get_cur_time() << endl;
483 // cout << "Found a vor station in range" << endl;
484 // cout << " id = " << nav.get_ident() << endl;
491 globals->get_soundmgr()->remove( "nav1-vor-ident" );
492 globals->get_soundmgr()->remove( "nav1-dme-ident" );
493 // cout << "not picking up vor1. :-(" << endl;
496 if ( current_ilslist->query( lon, lat, elev, nav2_freq, &ils ) ) {
497 nav2_ident = ils.get_locident();
498 if ( last_nav2_ident != nav2_ident ) {
499 last_nav2_ident = nav2_ident;
500 nav2_trans_ident = ils.get_trans_ident();
503 nav2_has_dme = ils.get_has_dme();
504 nav2_has_gs = ils.get_has_gs();
506 nav2_loclon = ils.get_loclon();
507 nav2_loclat = ils.get_loclat();
508 nav2_elev = ils.get_gselev();
510 nav2_effective_range = FG_ILS_DEFAULT_RANGE;
511 nav2_target_gs = ils.get_gsangle();
512 nav2_radial = ils.get_locheading();
513 while ( nav2_radial < 0.0 ) { nav2_radial += 360.0; }
514 while ( nav2_radial > 360.0 ) { nav2_radial -= 360.0; }
515 nav2_x = ils.get_x();
516 nav2_y = ils.get_y();
517 nav2_z = ils.get_z();
518 nav2_gs_x = ils.get_gs_x();
519 nav2_gs_y = ils.get_gs_y();
520 nav2_gs_z = ils.get_gs_z();
521 nav2_dme_x = ils.get_dme_x();
522 nav2_dme_y = ils.get_dme_y();
523 nav2_dme_z = ils.get_dme_z();
524 // cout << "Found an ils station in range" << endl;
525 // cout << " id = " << ils.get_locident() << endl;
527 } else if ( current_navlist->query( lon, lat, elev, nav2_freq, &nav ) ) {
528 nav2_ident = nav.get_ident();
529 if ( last_nav2_ident != nav2_ident ) {
530 last_nav2_ident = nav2_ident;
531 nav2_trans_ident = nav.get_trans_ident();
534 nav2_has_dme = nav.get_has_dme();
535 nav2_has_dme = false;
536 nav2_loclon = nav.get_lon();
537 nav2_loclat = nav.get_lat();
538 nav2_elev = nav.get_elev();
539 nav2_magvar = nav.get_magvar();
541 = kludgeRange(nav2_elev, elev, nav.get_range());
542 nav2_target_gs = 0.0;
543 nav2_radial = nav2_sel_radial;
544 nav2_x = nav2_dme_x = nav.get_x();
545 nav2_y = nav2_dme_y = nav.get_y();
546 nav2_z = nav2_dme_z = nav.get_z();
547 // cout << "Found a vor station in range" << endl;
548 // cout << " id = " << nav.get_ident() << endl;
555 // cout << "not picking up vor2. :-(" << endl;
559 if ( current_navlist->query( lon, lat, elev, adf_freq, &nav ) ) {
562 adf_lon = nav.get_lon();
563 adf_lat = nav.get_lat();
564 adf_elev = nav.get_elev();
565 adf_effective_range = kludgeRange(adf_elev, elev, nav.get_range());
569 // cout << "Found an adf station in range" << endl;
570 // cout << " id = " << nav.get_ident() << endl;
573 // cout << "not picking up adf. :-(" << endl;
578 // return the amount of heading needle deflection, returns a value
579 // clamped to the range of ( -10 , 10 )
580 double FGRadioStack::get_nav1_heading_needle_deflection() const {
583 if ( nav1_inrange ) {
584 r = nav1_heading - nav1_radial;
585 // cout << "Radial = " << nav1_radial
586 // << " Bearing = " << nav1_heading << endl;
588 while ( r > 180.0 ) { r -= 360.0;}
589 while ( r < -180.0 ) { r += 360.0;}
590 if ( fabs(r) > 90.0 ) {
591 r = ( r<0.0 ? -r-180.0 : -r+180.0 );
597 // According to Robin Peel, the ILS is 4x more sensitive than a vor
598 if ( nav1_loc ) { r *= 4.0; }
599 if ( r < -10.0 ) { r = -10.0; }
600 if ( r > 10.0 ) { r = 10.0; }
608 // return the amount of heading needle deflection, returns a value
609 // clamped to the range of ( -10 , 10 )
610 double FGRadioStack::get_nav2_heading_needle_deflection() const {
613 if ( nav2_inrange ) {
614 r = nav2_heading - nav2_radial;
615 // cout << "Radial = " << nav2_radial
616 // << " Bearing = " << nav2_heading << endl;
618 while (r> 180.0) r-=360.0;
619 while (r<-180.0) r+=360.0;
620 if ( fabs(r) > 90.0 )
621 r = ( r<0.0 ? -r-180.0 : -r+180.0 );
622 // According to Robin Peel, the ILS is 4x more sensitive than a vor
623 if ( nav2_loc ) r *= 4.0;
624 if ( r < -10.0 ) r = -10.0;
625 if ( r > 10.0 ) r = 10.0;
633 // return the amount of glide slope needle deflection (.i.e. the
634 // number of degrees we are off the glide slope * 5.0
635 double FGRadioStack::get_nav1_gs_needle_deflection() const {
636 if ( nav1_inrange && nav1_has_gs ) {
637 double x = nav1_gs_dist;
638 double y = (FGBFI::getAltitude() - nav1_elev) * FEET_TO_METER;
639 double angle = atan2( y, x ) * RAD_TO_DEG;
640 return (nav1_target_gs - angle) * 5.0;
647 // return the amount of glide slope needle deflection (.i.e. the
648 // number of degrees we are off the glide slope * 5.0
649 double FGRadioStack::get_nav2_gs_needle_deflection() const {
650 if ( nav2_inrange && nav2_has_gs ) {
651 double x = nav2_gs_dist;
652 double y = (FGBFI::getAltitude() - nav2_elev) * FEET_TO_METER;
653 double angle = atan2( y, x ) * RAD_TO_DEG;
654 return (nav2_target_gs - angle) * 5.0;
662 * Return true if the NAV1 TO flag should be active.
665 FGRadioStack::get_nav1_to_flag () const
668 double offset = fabs(nav1_heading - nav1_radial);
672 return (offset <= 90.0 || offset >= 270.0);
680 * Return true if the NAV1 FROM flag should be active.
683 FGRadioStack::get_nav1_from_flag () const
686 double offset = fabs(nav1_heading - nav1_radial);
690 return (offset > 90.0 && offset < 270.0);
698 * Return true if the NAV2 TO flag should be active.
701 FGRadioStack::get_nav2_to_flag () const
704 double offset = fabs(nav2_heading - nav2_radial);
708 return (offset <= 90.0 || offset >= 270.0);
716 * Return true if the NAV2 FROM flag should be active.
719 FGRadioStack::get_nav2_from_flag () const
722 double offset = fabs(nav2_heading - nav2_radial);
726 return (offset > 90.0 && offset < 270.0);