src/Instrumentation/navradio.cxx

   1 // navradio.cxx -- class to manage a nav radio instance
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000 - 2002  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include "navradio.hxx"
  29
  30 #include <sstream>
  31 #include <cstring>
  32
  33 #include <simgear/sg_inlines.h>
  34 #include <simgear/timing/sg_time.hxx>
  35 #include <simgear/math/sg_random.h>
  36 #include <simgear/misc/sg_path.hxx>
  37 #include <simgear/math/sg_geodesy.hxx>
  38 #include <simgear/structure/exception.hxx>
  39 #include <simgear/math/interpolater.hxx>
  40 #include <simgear/misc/strutils.hxx>
  41
  42 #include <Navaids/navrecord.hxx>
  43
  44 #include <Airports/runways.hxx>
  45 #include <Navaids/navlist.hxx>
  46 #include <Main/util.hxx>
  47
  48
  49 using std::string;
  50
  51 // General-purpose sawtooth function.  Graph looks like this:
  52 //         /\                                    .
  53 //       \/
  54 // Odd symmetry, inversion symmetry about the origin.
  55 // Unit slope at the origin.
  56 // Max 1, min -1, period 4.
  57 // Two zero-crossings per period, one with + slope, one with - slope.
  58 // Useful for false localizer courses.
  59 static double sawtooth(double xx)
  60 {
  61   return 4.0 * fabs(xx/4.0 + 0.25 - floor(xx/4.0 + 0.75)) - 1.0;
  62 }
  63
  64 // Calculate a unit vector in the horizontal tangent plane
  65 // starting at the given "tail" of the vector and going off
  66 // with the given heading.
  67 static SGVec3d tangentVector(const SGGeod& tail, const SGVec3d& tail_xyz,
  68           const double heading)
  69 {
  70 // The fudge factor here is presumably intended to improve
  71 // numerical stability.  I don't know if it is necessary.
  72 // It gets divided out later.
  73   double fudge(100.0);
  74   SGGeod head;
  75   double az2; // ignored
  76   SGGeodesy::direct(tail, heading, fudge, head, az2);
  77   head.setElevationM(tail.getElevationM());
  78   SGVec3d head_xyz = SGVec3d::fromGeod(head);
  79   return (head_xyz - tail_xyz) * (1.0/fudge);
  80 }
  81
  82 // Create a "serviceable" node with a default value of "true"
  83 SGPropertyNode_ptr createServiceableProp(SGPropertyNode* aParent, const char* aName)
  84 {
  85   SGPropertyNode_ptr n = (aParent->getChild(aName, 0, true)->getChild("serviceable", 0, true));
  86   simgear::props::Type typ = n->getType();
  87   if ((typ == simgear::props::NONE) || (typ == simgear::props::UNSPECIFIED)) {
  88     n->setBoolValue(true);
  89   }
  90   return n;
  91 }
  92
  93 // Constructor
  94 FGNavRadio::FGNavRadio(SGPropertyNode *node) :
  95     term_tbl(NULL),
  96     low_tbl(NULL),
  97     high_tbl(NULL),
  98     lon_node(fgGetNode("/position/longitude-deg", true)),
  99     lat_node(fgGetNode("/position/latitude-deg", true)),
 100     alt_node(fgGetNode("/position/altitude-ft", true)),
 101     _operable(false),
 102     play_count(0),
 103     last_time(0),
 104     target_radial(0.0),
 105     effective_range(0.0),
 106     target_gs(0.0),
 107     twist(0.0),
 108     horiz_vel(0.0),
 109     last_x(0.0),
 110     last_xtrack_error(0.0),
 111     xrate_ms(0.0),
 112     _localizerWidth(5.0),
 113     _name(node->getStringValue("name", "nav")),
 114     _num(node->getIntValue("number", 0)),
 115     _time_before_search_sec(-1.0),
 116     _gsCart(SGVec3d::zeros()),
 117     _gsAxis(SGVec3d::zeros()),
 118     _gsVertical(SGVec3d::zeros()),
 119     _dmeInRange(false),
 120     _toFlag(false),
 121     _fromFlag(false),
 122     _cdiDeflection(0.0),
 123     _cdiCrossTrackErrorM(0.0),
 124     _gsNeedleDeflection(0.0),
 125     _gsNeedleDeflectionNorm(0.0),
 126     _sgr(NULL)
 127 {
 128     SGPath path( globals->get_fg_root() );
 129     SGPath term = path;
 130     term.append( "Navaids/range.term" );
 131     SGPath low = path;
 132     low.append( "Navaids/range.low" );
 133     SGPath high = path;
 134     high.append( "Navaids/range.high" );
 135
 136     term_tbl = new SGInterpTable( term.str() );
 137     low_tbl = new SGInterpTable( low.str() );
 138     high_tbl = new SGInterpTable( high.str() );
 139
 140     string branch("/instrumentation/" + _name);
 141     _radio_node = fgGetNode(branch.c_str(), _num, true);
 142 }
 143
 144
 145 // Destructor
 146 FGNavRadio::~FGNavRadio()
 147 {
 148     if (gps_course_node) {
 149       gps_course_node->removeChangeListener(this);
 150     }
 151
 152     if (nav_slaved_to_gps_node) {
 153       nav_slaved_to_gps_node->removeChangeListener(this);
 154     }
 155
 156     delete term_tbl;
 157     delete low_tbl;
 158     delete high_tbl;
 159 }
 160
 161
 162 void
 163 FGNavRadio::init ()
 164 {
 165     SGSoundMgr *smgr = globals->get_soundmgr();
 166     _sgr = smgr->find("avionics", true);
 167     _sgr->tie_to_listener();
 168
 169     morse.init();
 170
 171     SGPropertyNode* node = _radio_node.get();
 172     bus_power_node =
 173         fgGetNode(("/systems/electrical/outputs/" + _name).c_str(), true);
 174
 175     // inputs
 176     is_valid_node = node->getChild("data-is-valid", 0, true);
 177     power_btn_node = node->getChild("power-btn", 0, true);
 178     power_btn_node->setBoolValue( true );
 179     vol_btn_node = node->getChild("volume", 0, true);
 180     ident_btn_node = node->getChild("ident", 0, true);
 181     ident_btn_node->setBoolValue( true );
 182     audio_btn_node = node->getChild("audio-btn", 0, true);
 183     audio_btn_node->setBoolValue( true );
 184     backcourse_node = node->getChild("back-course-btn", 0, true);
 185     backcourse_node->setBoolValue( false );
 186
 187     nav_serviceable_node = node->getChild("serviceable", 0, true);
 188     cdi_serviceable_node = createServiceableProp(node, "cdi");
 189     gs_serviceable_node = createServiceableProp(node, "gs");
 190     tofrom_serviceable_node = createServiceableProp(node, "to-from");
 191     dme_serviceable_node = createServiceableProp(node, "dme");
 192
 193     falseCoursesEnabledNode =
 194       fgGetNode("/sim/realism/false-radio-courses-enabled");
 195     if (!falseCoursesEnabledNode) {
 196       falseCoursesEnabledNode =
 197         fgGetNode("/sim/realism/false-radio-courses-enabled", true);
 198       falseCoursesEnabledNode->setBoolValue(true);
 199     }
 200
 201     // frequencies
 202     SGPropertyNode *subnode = node->getChild("frequencies", 0, true);
 203     freq_node = subnode->getChild("selected-mhz", 0, true);
 204     alt_freq_node = subnode->getChild("standby-mhz", 0, true);
 205     fmt_freq_node = subnode->getChild("selected-mhz-fmt", 0, true);
 206     fmt_alt_freq_node = subnode->getChild("standby-mhz-fmt", 0, true);
 207
 208     // radials
 209     subnode = node->getChild("radials", 0, true);
 210     sel_radial_node = subnode->getChild("selected-deg", 0, true);
 211     radial_node = subnode->getChild("actual-deg", 0, true);
 212     recip_radial_node = subnode->getChild("reciprocal-radial-deg", 0, true);
 213     target_radial_true_node = subnode->getChild("target-radial-deg", 0, true);
 214     target_auto_hdg_node = subnode->getChild("target-auto-hdg-deg", 0, true);
 215
 216     // outputs
 217     heading_node = node->getChild("heading-deg", 0, true);
 218     time_to_intercept = node->getChild("time-to-intercept-sec", 0, true);
 219     to_flag_node = node->getChild("to-flag", 0, true);
 220     from_flag_node = node->getChild("from-flag", 0, true);
 221     inrange_node = node->getChild("in-range", 0, true);
 222     signal_quality_norm_node = node->getChild("signal-quality-norm", 0, true);
 223     cdi_deflection_node = node->getChild("heading-needle-deflection", 0, true);
 224     cdi_deflection_norm_node = node->getChild("heading-needle-deflection-norm", 0, true);
 225     cdi_xtrack_error_node = node->getChild("crosstrack-error-m", 0, true);
 226     cdi_xtrack_hdg_err_node
 227         = node->getChild("crosstrack-heading-error-deg", 0, true);
 228     has_gs_node = node->getChild("has-gs", 0, true);
 229     loc_node = node->getChild("nav-loc", 0, true);
 230     loc_dist_node = node->getChild("nav-distance", 0, true);
 231     gs_deflection_node = node->getChild("gs-needle-deflection", 0, true);
 232     gs_deflection_deg_node = node->getChild("gs-needle-deflection-deg", 0, true);
 233     gs_deflection_norm_node = node->getChild("gs-needle-deflection-norm", 0, true);
 234     gs_rate_of_climb_node = node->getChild("gs-rate-of-climb", 0, true);
 235     gs_rate_of_climb_fpm_node = node->getChild("gs-rate-of-climb-fpm", 0, true);
 236     gs_dist_node = node->getChild("gs-distance", 0, true);
 237     gs_inrange_node = node->getChild("gs-in-range", 0, true);
 238
 239     nav_id_node = node->getChild("nav-id", 0, true);
 240     id_c1_node = node->getChild("nav-id_asc1", 0, true);
 241     id_c2_node = node->getChild("nav-id_asc2", 0, true);
 242     id_c3_node = node->getChild("nav-id_asc3", 0, true);
 243     id_c4_node = node->getChild("nav-id_asc4", 0, true);
 244
 245     // gps slaving support
 246     nav_slaved_to_gps_node = node->getChild("slaved-to-gps", 0, true);
 247     nav_slaved_to_gps_node->addChangeListener(this);
 248
 249     gps_cdi_deflection_node = fgGetNode("/instrumentation/gps/cdi-deflection", true);
 250     gps_to_flag_node = fgGetNode("/instrumentation/gps/to-flag", true);
 251     gps_from_flag_node = fgGetNode("/instrumentation/gps/from-flag", true);
 252     gps_has_gs_node = fgGetNode("/instrumentation/gps/has-gs", true);
 253     gps_course_node = fgGetNode("/instrumentation/gps/desired-course-deg", true);
 254     gps_course_node->addChangeListener(this);
 255
 256     gps_xtrack_error_nm_node = fgGetNode("/instrumentation/gps/wp/wp[1]/course-error-nm", true);
 257     _magvarNode = fgGetNode("/environment/magnetic-variation-deg", true);
 258
 259     std::ostringstream temp;
 260     temp << _name << "nav-ident" << _num;
 261     nav_fx_name = temp.str();
 262     temp << _name << "dme-ident" << _num;
 263     dme_fx_name = temp.str();
 264 }
 265
 266 void
 267 FGNavRadio::bind ()
 268 {
 269   tie("dme-in-range", SGRawValuePointer<bool>(&_dmeInRange));
 270   tie("operable", SGRawValueMethods<FGNavRadio, bool>(*this, &FGNavRadio::isOperable, NULL));
 271 }
 272
 273
 274 void
 275 FGNavRadio::unbind ()
 276 {
 277   for (unsigned int t=0; t<_tiedNodes.size(); ++t) {
 278     _tiedNodes[t]->untie();
 279   }
 280   _tiedNodes.clear();
 281 }
 282
 283
 284 // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 285 double FGNavRadio::adjustNavRange( double stationElev, double aircraftElev,
 286                                  double nominalRange )
 287 {
 288     if (nominalRange <= 0.0) {
 289       nominalRange = FG_NAV_DEFAULT_RANGE;
 290     }
 291
 292     // extend out actual usable range to be 1.3x the published safe range
 293     const double usability_factor = 1.3;
 294
 295     // assumptions we model the standard service volume, plus
 296     // ... rather than specifying a cylinder, we model a cone that
 297     // contains the cylinder.  Then we put an upside down cone on top
 298     // to model diminishing returns at too-high altitudes.
 299
 300     // altitude difference
 301     double alt = ( aircraftElev * SG_METER_TO_FEET - stationElev );
 302     // cout << "aircraft elev = " << aircraftElev * SG_METER_TO_FEET
 303     //      << " station elev = " << stationElev << endl;
 304
 305     if ( nominalRange < 25.0 + SG_EPSILON ) {
 306         // Standard Terminal Service Volume
 307         return term_tbl->interpolate( alt ) * usability_factor;
 308     } else if ( nominalRange < 50.0 + SG_EPSILON ) {
 309         // Standard Low Altitude Service Volume
 310         // table is based on range of 40, scale to actual range
 311         return low_tbl->interpolate( alt ) * nominalRange / 40.0
 312             * usability_factor;
 313     } else {
 314         // Standard High Altitude Service Volume
 315         // table is based on range of 130, scale to actual range
 316         return high_tbl->interpolate( alt ) * nominalRange / 130.0
 317             * usability_factor;
 318     }
 319 }
 320
 321
 322 // model standard ILS service volumes as per AIM 1-1-9
 323 double FGNavRadio::adjustILSRange( double stationElev, double aircraftElev,
 324                                  double offsetDegrees, double distance )
 325 {
 326     // assumptions we model the standard service volume, plus
 327
 328     // altitude difference
 329     // double alt = ( aircraftElev * SG_METER_TO_FEET - stationElev );
 330 //     double offset = fabs( offsetDegrees );
 331
 332 //     if ( offset < 10 ) {
 333 //      return FG_ILS_DEFAULT_RANGE;
 334 //     } else if ( offset < 35 ) {
 335 //      return 10 + (35 - offset) * (FG_ILS_DEFAULT_RANGE - 10) / 25;
 336 //     } else if ( offset < 45 ) {
 337 //      return (45 - offset);
 338 //     } else if ( offset > 170 ) {
 339 //         return FG_ILS_DEFAULT_RANGE;
 340 //     } else if ( offset > 145 ) {
 341 //      return 10 + (offset - 145) * (FG_ILS_DEFAULT_RANGE - 10) / 25;
 342 //     } else if ( offset > 135 ) {
 343 //         return (offset - 135);
 344 //     } else {
 345 //      return 0;
 346 //     }
 347     return FG_LOC_DEFAULT_RANGE;
 348 }
 349
 350
 351 //////////////////////////////////////////////////////////////////////////
 352 // Update the various nav values based on position and valid tuned in navs
 353 //////////////////////////////////////////////////////////////////////////
 354 void
 355 FGNavRadio::update(double dt)
 356 {
 357   if (dt <= 0.0) {
 358     return; // paused
 359   }
 360
 361   // Create "formatted" versions of the nav frequencies for
 362   // instrument displays.
 363   char tmp[16];
 364   sprintf( tmp, "%.2f", freq_node->getDoubleValue() );
 365   fmt_freq_node->setStringValue(tmp);
 366   sprintf( tmp, "%.2f", alt_freq_node->getDoubleValue() );
 367   fmt_alt_freq_node->setStringValue(tmp);
 368
 369   if (power_btn_node->getBoolValue()
 370       && (bus_power_node->getDoubleValue() > 1.0)
 371       && nav_serviceable_node->getBoolValue() )
 372   {
 373     _operable = true;
 374     updateReceiver(dt);
 375     updateCDI(dt);
 376   } else {
 377     clearOutputs();
 378   }
 379
 380   updateAudio();
 381 }
 382
 383 void FGNavRadio::clearOutputs()
 384 {
 385   inrange_node->setBoolValue( false );
 386   cdi_deflection_node->setDoubleValue( 0.0 );
 387   cdi_deflection_norm_node->setDoubleValue( 0.0 );
 388   cdi_xtrack_error_node->setDoubleValue( 0.0 );
 389   cdi_xtrack_hdg_err_node->setDoubleValue( 0.0 );
 390   time_to_intercept->setDoubleValue( 0.0 );
 391   heading_node->setDoubleValue(0.0);
 392   gs_deflection_node->setDoubleValue( 0.0 );
 393   gs_deflection_deg_node->setDoubleValue(0.0);
 394   gs_deflection_norm_node->setDoubleValue(0.0);
 395   gs_inrange_node->setBoolValue( false );
 396   loc_node->setBoolValue( false );
 397   has_gs_node->setBoolValue(false);
 398
 399   to_flag_node->setBoolValue( false );
 400   from_flag_node->setBoolValue( false );
 401   is_valid_node->setBoolValue(false);
 402   nav_id_node->setStringValue("");
 403
 404   _dmeInRange = false;
 405   _operable = false;
 406   _navaid = NULL;
 407 }
 408
 409 void FGNavRadio::updateReceiver(double dt)
 410 {
 411   SGGeod pos = SGGeod::fromDegFt(lon_node->getDoubleValue(),
 412                                lat_node->getDoubleValue(),
 413                                alt_node->getDoubleValue());
 414   SGVec3d aircraft = SGVec3d::fromGeod(pos);
 415   double loc_dist = 0;
 416
 417   // Do a nav station search only once a second to reduce
 418   // unnecessary work. (Also, make sure to do this before caching
 419   // any values!)
 420   _time_before_search_sec -= dt;
 421   if ( _time_before_search_sec < 0 ) {
 422    search();
 423   }
 424
 425   if (_navaid)
 426   {
 427       loc_dist = dist(aircraft, _navaid->cart());
 428       loc_dist_node->setDoubleValue( loc_dist );
 429   }
 430   updateDME(aircraft);
 431
 432   if (nav_slaved_to_gps_node->getBoolValue()) {
 433     // when slaved to GPS: only allow stuff above: tune NAV station
 434     // upate DME. All other data driven by GPS only.
 435     updateGPSSlaved();
 436     return;
 437   }
 438
 439   if (!_navaid) {
 440     _cdiDeflection = 0.0;
 441     _cdiCrossTrackErrorM = 0.0;
 442     _toFlag = _fromFlag = false;
 443     _gsNeedleDeflection = 0.0;
 444     _gsNeedleDeflectionNorm = 0.0;
 445     heading_node->setDoubleValue(0.0);
 446     inrange_node->setBoolValue(false);
 447     return;
 448   }
 449
 450   double nav_elev = _navaid->get_elev_ft();
 451
 452   bool is_loc = loc_node->getBoolValue();
 453   double signal_quality_norm = signal_quality_norm_node->getDoubleValue();
 454
 455   double az2, s;
 456   //////////////////////////////////////////////////////////
 457         // compute forward and reverse wgs84 headings to localizer
 458   //////////////////////////////////////////////////////////
 459   double hdg;
 460   SGGeodesy::inverse(pos, _navaid->geod(), hdg, az2, s);
 461   heading_node->setDoubleValue(hdg);
 462   double radial = az2 - twist;
 463   double recip = radial + 180.0;
 464   SG_NORMALIZE_RANGE(recip, 0.0, 360.0);
 465   radial_node->setDoubleValue( radial );
 466   recip_radial_node->setDoubleValue( recip );
 467
 468   //////////////////////////////////////////////////////////
 469   // compute the target/selected radial in "true" heading
 470   //////////////////////////////////////////////////////////
 471   if (!is_loc) {
 472     target_radial = sel_radial_node->getDoubleValue();
 473   }
 474
 475   // VORs need twist (mag-var) added; ILS/LOCs don't but we set twist to 0.0
 476   double trtrue = target_radial + twist;
 477   SG_NORMALIZE_RANGE(trtrue, 0.0, 360.0);
 478   target_radial_true_node->setDoubleValue( trtrue );
 479
 480   //////////////////////////////////////////////////////////
 481   // adjust reception range for altitude
 482   // FIXME: make sure we are using the navdata range now that
 483   //        it is valid in the data file
 484   //////////////////////////////////////////////////////////
 485         if ( is_loc ) {
 486             double offset = radial - target_radial;
 487       SG_NORMALIZE_RANGE(offset, -180.0, 180.0);
 488             effective_range
 489                 = adjustILSRange( nav_elev, pos.getElevationM(), offset,
 490                                   loc_dist * SG_METER_TO_NM );
 491         } else {
 492             effective_range
 493                 = adjustNavRange( nav_elev, pos.getElevationM(), _navaid->get_range() );
 494         }
 495
 496   double effective_range_m = effective_range * SG_NM_TO_METER;
 497
 498   //////////////////////////////////////////////////////////
 499   // compute signal quality
 500   // 100% within effective_range
 501   // decreases 1/x^2 further out
 502   //////////////////////////////////////////////////////////
 503   double last_signal_quality_norm = signal_quality_norm;
 504
 505   if ( loc_dist < effective_range_m ) {
 506     signal_quality_norm = 1.0;
 507   } else {
 508     double range_exceed_norm = loc_dist/effective_range_m;
 509     signal_quality_norm = 1/(range_exceed_norm*range_exceed_norm);
 510   }
 511
 512   signal_quality_norm = fgGetLowPass( last_signal_quality_norm,
 513            signal_quality_norm, dt );
 514
 515   signal_quality_norm_node->setDoubleValue( signal_quality_norm );
 516   bool inrange = signal_quality_norm > 0.2;
 517   inrange_node->setBoolValue( inrange );
 518
 519   //////////////////////////////////////////////////////////
 520   // compute to/from flag status
 521   //////////////////////////////////////////////////////////
 522   if (inrange) {
 523     if (is_loc) {
 524       _toFlag = true;
 525     } else {
 526       double offset = fabs(radial - target_radial);
 527       _toFlag = (offset > 90.0 && offset < 270.0);
 528     }
 529     _fromFlag = !_toFlag;
 530   } else {
 531     _toFlag = _fromFlag = false;
 532   }
 533
 534   // CDI deflection
 535   double r = target_radial - radial;
 536   SG_NORMALIZE_RANGE(r, -180.0, 180.0);
 537
 538   if ( is_loc ) {
 539     if (falseCoursesEnabledNode->getBoolValue()) {
 540       // The factor of 30.0 gives a period of 120 which gives us 3 cycles and six
 541       // zeros i.e. six courses: one front course, one back course, and four
 542       // false courses. Three of the six are reverse sensing.
 543       _cdiDeflection = 30.0 * sawtooth(r / 30.0);
 544     } else {
 545       // no false courses, but we do need to create a back course
 546       if (fabs(r) > 90.0) { // front course
 547         _cdiDeflection = r - copysign(180.0, r);
 548       } else {
 549         _cdiDeflection = r; // back course
 550       }
 551
 552       _cdiDeflection = -_cdiDeflection; // reverse for outbound radial
 553     } // of false courses disabled
 554
 555     const double VOR_FULL_ARC = 20.0; // VOR is -10 .. 10 degree swing
 556     _cdiDeflection *= VOR_FULL_ARC / _localizerWidth; // increased localiser sensitivity
 557
 558     if (backcourse_node->getBoolValue()) {
 559       _cdiDeflection = -_cdiDeflection;
 560     }
 561   } else {
 562     // handle the TO side of the VOR
 563     if (fabs(r) > 90.0) {
 564       r = ( r<0.0 ? -r-180.0 : -r+180.0 );
 565     }
 566     _cdiDeflection = r;
 567   } // of non-localiser case
 568
 569   SG_CLAMP_RANGE(_cdiDeflection, -10.0, 10.0 );
 570   _cdiDeflection *= signal_quality_norm;
 571
 572   // cross-track error (in metres)
 573   _cdiCrossTrackErrorM = loc_dist * sin(r * SGD_DEGREES_TO_RADIANS);
 574
 575   updateGlideSlope(dt, aircraft, signal_quality_norm);
 576 }
 577
 578 void FGNavRadio::updateGlideSlope(double dt, const SGVec3d& aircraft, double signal_quality_norm)
 579 {
 580   _gsNeedleDeflection = 0.0;
 581   if (!_gs || !inrange_node->getBoolValue()) {
 582     gs_dist_node->setDoubleValue( 0.0 );
 583     gs_inrange_node->setBoolValue(false);
 584     _gsNeedleDeflection = 0.0;
 585     _gsNeedleDeflectionNorm = 0.0;
 586     return;
 587   }
 588
 589   double gsDist = dist(aircraft, _gsCart);
 590   gs_dist_node->setDoubleValue(gsDist);
 591   bool gsInRange = (gsDist < (_gs->get_range() * SG_NM_TO_METER));
 592   gs_inrange_node->setBoolValue(gsInRange);
 593
 594   if (!gsInRange) {
 595     _gsNeedleDeflection = 0.0;
 596     _gsNeedleDeflectionNorm = 0.0;
 597     return;
 598   }
 599
 600   SGVec3d pos = aircraft - _gsCart; // relative vector from gs antenna to aircraft
 601   // The positive GS axis points along the runway in the landing direction,
 602   // toward the far end, not toward the approach area, so we need a - sign here:
 603   double dot_h = -dot(pos, _gsAxis);
 604   double dot_v = dot(pos, _gsVertical);
 605   double angle = atan2(dot_v, dot_h) * SGD_RADIANS_TO_DEGREES;
 606   double deflectionAngle = target_gs - angle;
 607
 608   if (falseCoursesEnabledNode->getBoolValue()) {
 609     // Construct false glideslopes.  The scale factor of 1.5
 610     // in the sawtooth gives a period of 6 degrees.
 611     // There will be zeros at 3, 6r, 9, 12r et cetera
 612     // where "r" indicates reverse sensing.
 613     // This is is consistent with conventional pilot lore
 614     // e.g. http://www.allstar.fiu.edu/aerojava/ILS.htm
 615     // but inconsistent with
 616     // http://www.freepatentsonline.com/3757338.html
 617     //
 618     // It may be that some of each exist.
 619     if (deflectionAngle < 0) {
 620       deflectionAngle = 1.5 * sawtooth(deflectionAngle / 1.5);
 621     } else {
 622       // no false GS below the true GS
 623     }
 624   }
 625
 626   _gsNeedleDeflection = deflectionAngle * 5.0;
 627   _gsNeedleDeflection *= signal_quality_norm;
 628
 629   SG_CLAMP_RANGE(deflectionAngle, -0.7, 0.7);
 630   _gsNeedleDeflectionNorm = (deflectionAngle / 0.7) * signal_quality_norm;
 631
 632   //////////////////////////////////////////////////////////
 633   // Calculate desired rate of climb for intercepting the GS
 634   //////////////////////////////////////////////////////////
 635   double gs_diff = target_gs - angle;
 636   // convert desired vertical path angle into a climb rate
 637   double des_angle = angle - 10 * gs_diff;
 638   /* printf("target_gs=%.1f angle=%.1f gs_diff=%.1f des_angle=%.1f\n",
 639      target_gs, angle, gs_diff, des_angle); */
 640
 641   // estimate horizontal speed towards ILS in meters per minute
 642   double elapsedDistance = last_x - gsDist;
 643   last_x = gsDist;
 644
 645   double new_vel = ( elapsedDistance / dt );
 646   horiz_vel = 0.99 * horiz_vel + 0.01 * new_vel;
 647   /* printf("vel=%.1f (dist=%.1f dt=%.2f)\n", horiz_vel, elapsedDistance, dt);*/
 648
 649   gs_rate_of_climb_node
 650       ->setDoubleValue( -sin( des_angle * SGD_DEGREES_TO_RADIANS )
 651                         * horiz_vel * SG_METER_TO_FEET );
 652   gs_rate_of_climb_fpm_node
 653       ->setDoubleValue( gs_rate_of_climb_node->getDoubleValue() * 60 );
 654 }
 655
 656 void FGNavRadio::updateDME(const SGVec3d& aircraft)
 657 {
 658   if (!_dme || !dme_serviceable_node->getBoolValue()) {
 659     _dmeInRange = false;
 660     return;
 661   }
 662
 663   double dme_distance = dist(aircraft, _dme->cart());
 664   _dmeInRange =  (dme_distance < _dme->get_range() * SG_NM_TO_METER);
 665 }
 666
 667 void FGNavRadio::valueChanged (SGPropertyNode* prop)
 668 {
 669   if (prop == gps_course_node) {
 670     if (!nav_slaved_to_gps_node->getBoolValue()) {
 671       return;
 672     }
 673
 674     // GPS desired course has changed, sync up our selected-course
 675     double v = prop->getDoubleValue();
 676     if (v != sel_radial_node->getDoubleValue()) {
 677       sel_radial_node->setDoubleValue(v);
 678     }
 679   } else if (prop == nav_slaved_to_gps_node) {
 680     if (prop->getBoolValue()) {
 681       // slaved-to-GPS activated, clear obsolete NAV outputs and sync up selected course
 682       clearOutputs();
 683       sel_radial_node->setDoubleValue(gps_course_node->getDoubleValue());
 684     }
 685     // slave-to-GPS enabled/disabled, resync NAV station (update all outputs)
 686     _navaid = NULL;
 687     _time_before_search_sec = 0;
 688   }
 689 }
 690
 691 void FGNavRadio::updateGPSSlaved()
 692 {
 693   has_gs_node->setBoolValue(gps_has_gs_node->getBoolValue());
 694
 695   _toFlag = gps_to_flag_node->getBoolValue();
 696   _fromFlag = gps_from_flag_node->getBoolValue();
 697
 698   bool gpsValid = (_toFlag | _fromFlag);
 699   inrange_node->setBoolValue(gpsValid);
 700   if (!gpsValid) {
 701     signal_quality_norm_node->setDoubleValue(0.0);
 702     _cdiDeflection = 0.0;
 703     _cdiCrossTrackErrorM = 0.0;
 704     _gsNeedleDeflection = 0.0;
 705     _gsNeedleDeflectionNorm = 0.0;
 706     return;
 707   }
 708
 709   // this is unfortunate, but panel instruments use this value to decide
 710   // if the navradio output is valid.
 711   signal_quality_norm_node->setDoubleValue(1.0);
 712
 713   _cdiDeflection =  gps_cdi_deflection_node->getDoubleValue();
 714   // clmap to some range (+/- 10 degrees) as the regular deflection
 715   SG_CLAMP_RANGE(_cdiDeflection, -10.0, 10.0 );
 716
 717   _cdiCrossTrackErrorM = gps_xtrack_error_nm_node->getDoubleValue() * SG_NM_TO_METER;
 718   _gsNeedleDeflection = 0.0; // FIXME, supply this
 719
 720   double trtrue = gps_course_node->getDoubleValue() + _magvarNode->getDoubleValue();
 721   SG_NORMALIZE_RANGE(trtrue, 0.0, 360.0);
 722   target_radial_true_node->setDoubleValue( trtrue );
 723 }
 724
 725 void FGNavRadio::updateCDI(double dt)
 726 {
 727   bool cdi_serviceable = cdi_serviceable_node->getBoolValue();
 728   bool inrange = inrange_node->getBoolValue();
 729
 730   if (tofrom_serviceable_node->getBoolValue()) {
 731     to_flag_node->setBoolValue(_toFlag);
 732     from_flag_node->setBoolValue(_fromFlag);
 733   } else {
 734     to_flag_node->setBoolValue(false);
 735     from_flag_node->setBoolValue(false);
 736   }
 737
 738   if (!cdi_serviceable) {
 739     _cdiDeflection = 0.0;
 740     _cdiCrossTrackErrorM = 0.0;
 741   }
 742
 743   cdi_deflection_node->setDoubleValue(_cdiDeflection);
 744   cdi_deflection_norm_node->setDoubleValue(_cdiDeflection * 0.1);
 745   cdi_xtrack_error_node->setDoubleValue(_cdiCrossTrackErrorM);
 746
 747   //////////////////////////////////////////////////////////
 748   // compute an approximate ground track heading error
 749   //////////////////////////////////////////////////////////
 750   double hdg_error = 0.0;
 751   if ( inrange && cdi_serviceable ) {
 752     double vn = fgGetDouble( "/velocities/speed-north-fps" );
 753     double ve = fgGetDouble( "/velocities/speed-east-fps" );
 754     double gnd_trk_true = atan2( ve, vn ) * SGD_RADIANS_TO_DEGREES;
 755     if ( gnd_trk_true < 0.0 ) { gnd_trk_true += 360.0; }
 756
 757     SGPropertyNode *true_hdg
 758         = fgGetNode("/orientation/heading-deg", true);
 759     hdg_error = gnd_trk_true - true_hdg->getDoubleValue();
 760
 761     // cout << "ground track = " << gnd_trk_true
 762     //      << " orientation = " << true_hdg->getDoubleValue() << endl;
 763   }
 764   cdi_xtrack_hdg_err_node->setDoubleValue( hdg_error );
 765
 766   //////////////////////////////////////////////////////////
 767   // Calculate a suggested target heading to smoothly intercept
 768   // a nav/ils radial.
 769   //////////////////////////////////////////////////////////
 770
 771   // Now that we have cross track heading adjustment built in,
 772   // we shouldn't need to overdrive the heading angle within 8km
 773   // of the station.
 774   //
 775   // The cdi deflection should be +/-10 for a full range of deflection
 776   // so multiplying this by 3 gives us +/- 30 degrees heading
 777   // compensation.
 778   double adjustment = _cdiDeflection * 3.0;
 779   SG_CLAMP_RANGE( adjustment, -30.0, 30.0 );
 780
 781   // determine the target heading to fly to intercept the
 782   // tgt_radial = target radial (true) + cdi offset adjustmest -
 783   // xtrack heading error adjustment
 784   double nta_hdg;
 785   double trtrue = target_radial_true_node->getDoubleValue();
 786   if ( loc_node->getBoolValue() && backcourse_node->getBoolValue() ) {
 787       // tuned to a localizer and backcourse mode activated
 788       trtrue += 180.0;   // reverse the target localizer heading
 789       SG_NORMALIZE_RANGE(trtrue, 0.0, 360.0);
 790       nta_hdg = trtrue - adjustment - hdg_error;
 791   } else {
 792       nta_hdg = trtrue + adjustment - hdg_error;
 793   }
 794
 795   SG_NORMALIZE_RANGE(nta_hdg, 0.0, 360.0);
 796   target_auto_hdg_node->setDoubleValue( nta_hdg );
 797
 798   //////////////////////////////////////////////////////////
 799   // compute the time to intercept selected radial (based on
 800   // current and last cross track errors and dt
 801   //////////////////////////////////////////////////////////
 802   double t = 0.0;
 803   if ( inrange && cdi_serviceable ) {
 804     double cur_rate = (last_xtrack_error - _cdiCrossTrackErrorM) / dt;
 805     xrate_ms = 0.99 * xrate_ms + 0.01 * cur_rate;
 806     if ( fabs(xrate_ms) > 0.00001 ) {
 807         t = _cdiCrossTrackErrorM / xrate_ms;
 808     } else {
 809         t = 9999.9;
 810     }
 811   }
 812   time_to_intercept->setDoubleValue( t );
 813
 814   if (!gs_serviceable_node->getBoolValue() ) {
 815     _gsNeedleDeflection = 0.0;
 816     _gsNeedleDeflectionNorm = 0.0;
 817   }
 818   gs_deflection_node->setDoubleValue(_gsNeedleDeflection);
 819   gs_deflection_deg_node->setDoubleValue(_gsNeedleDeflectionNorm * 0.7);
 820   gs_deflection_norm_node->setDoubleValue(_gsNeedleDeflectionNorm);
 821
 822   last_xtrack_error = _cdiCrossTrackErrorM;
 823 }
 824
 825 void FGNavRadio::updateAudio()
 826 {
 827   if (!_navaid || !inrange_node->getBoolValue() || !nav_serviceable_node->getBoolValue()) {
 828     return;
 829   }
 830
 831         // play station ident via audio system if on + ident,
 832         // otherwise turn it off
 833   if (!power_btn_node->getBoolValue()
 834       || !(bus_power_node->getDoubleValue() > 1.0)
 835       || !ident_btn_node->getBoolValue()
 836       || !audio_btn_node->getBoolValue() ) {
 837     _sgr->stop( nav_fx_name );
 838     _sgr->stop( dme_fx_name );
 839     return;
 840   }
 841
 842   SGSoundSample *sound = _sgr->find( nav_fx_name );
 843   double vol = vol_btn_node->getFloatValue();
 844   SG_CLAMP_RANGE(vol, 0.0, 1.0);
 845
 846   if ( sound != NULL ) {
 847     sound->set_volume( vol );
 848   } else {
 849     SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find nav-vor-ident sound" );
 850   }
 851
 852   sound = _sgr->find( dme_fx_name );
 853   if ( sound != NULL ) {
 854     sound->set_volume( vol );
 855   } else {
 856     SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find nav-dme-ident sound" );
 857   }
 858
 859   const int NUM_IDENT_SLOTS = 5;
 860   const time_t SLOT_LENGTH = 5; // seconds
 861
 862   // There are N slots numbered 0 through (NUM_IDENT_SLOTS-1) inclusive.
 863   // Each slot is 5 seconds long.
 864   // Slots 0 is for DME
 865   // the rest are for azimuth.
 866   time_t now = globals->get_time_params()->get_cur_time();
 867   if ((now >= last_time) && (now < last_time + SLOT_LENGTH)) {
 868     return; // wait longer
 869   }
 870
 871   last_time = now;
 872   play_count = ++play_count % NUM_IDENT_SLOTS;
 873
 874   // Previous ident is out of time;  if still playing, cut it off:
 875   _sgr->stop( nav_fx_name );
 876   _sgr->stop( dme_fx_name );
 877   if (play_count == 0) { // the DME slot
 878     if (_dmeInRange && dme_serviceable_node->getBoolValue()) {
 879       // play DME ident
 880       if (vol > 0.05) _sgr->play_once( dme_fx_name );
 881     }
 882   } else { // NAV slot
 883     if (inrange_node->getBoolValue() && nav_serviceable_node->getBoolValue()) {
 884       if (vol > 0.05) _sgr->play_once(nav_fx_name);
 885     }
 886   }
 887 }
 888
 889 FGNavRecord* FGNavRadio::findPrimaryNavaid(const SGGeod& aPos, double aFreqMHz)
 890 {
 891   FGNavRecord* nav = globals->get_navlist()->findByFreq(aFreqMHz, aPos);
 892   if (nav) {
 893     return nav;
 894   }
 895
 896   return globals->get_loclist()->findByFreq(aFreqMHz, aPos);
 897 }
 898
 899 // Update current nav/adf radio stations based on current postition
 900 void FGNavRadio::search()
 901 {
 902   _time_before_search_sec = 1.0;
 903   SGGeod pos = SGGeod::fromDegFt(lon_node->getDoubleValue(),
 904     lat_node->getDoubleValue(), alt_node->getDoubleValue());
 905   double freq = freq_node->getDoubleValue();
 906
 907   FGNavRecord* nav = findPrimaryNavaid(pos, freq);
 908   if (nav == _navaid) {
 909     return; // found the same as last search, we're done
 910   }
 911
 912   _navaid = nav;
 913   string identBuffer(4, ' ');
 914   if (nav) {
 915     _dme = globals->get_dmelist()->findByFreq(freq, pos);
 916
 917     nav_id_node->setStringValue(nav->get_ident());
 918     identBuffer =  simgear::strutils::rpad( nav->ident(), 4, ' ' );
 919
 920     effective_range = adjustNavRange(nav->get_elev_ft(), pos.getElevationM(), nav->get_range());
 921     loc_node->setBoolValue(nav->type() != FGPositioned::VOR);
 922     twist = nav->get_multiuse();
 923
 924     if (nav->type() == FGPositioned::VOR) {
 925       target_radial = sel_radial_node->getDoubleValue();
 926       _gs = NULL;
 927       has_gs_node->setBoolValue(false);
 928     } else { // ILS or LOC
 929       _gs = globals->get_gslist()->findByFreq(freq, pos);
 930       has_gs_node->setBoolValue(_gs != NULL);
 931       _localizerWidth = nav->localizerWidth();
 932       twist = 0.0;
 933             effective_range = nav->get_range();
 934
 935       target_radial = nav->get_multiuse();
 936       SG_NORMALIZE_RANGE(target_radial, 0.0, 360.0);
 937
 938       if (_gs) {
 939         int tmp = (int)(_gs->get_multiuse() / 1000.0);
 940         target_gs = (double)tmp / 100.0;
 941
 942         // until penaltyForNav goes away, we cannot assume we always pick
 943         // paired LOC/GS trasmsitters. As we pass over a runway threshold, we
 944         // often end up picking the 'wrong' LOC, but the correct GS. To avoid
 945         // breaking the basis computation, ensure we use the GS radial and not
 946         // the (potentially reversed) LOC radial.
 947         double gs_radial = fmod(_gs->get_multiuse(), 1000.0);
 948         SG_NORMALIZE_RANGE(gs_radial, 0.0, 360.0);
 949
 950         // GS axis unit tangent vector
 951         // (along the runway)
 952         _gsCart = _gs->cart();
 953         _gsAxis = tangentVector(_gs->geod(), _gsCart, gs_radial);
 954
 955         // GS baseline unit tangent vector
 956         // (perpendicular to the runay along the ground)
 957         SGVec3d baseline = tangentVector(_gs->geod(), _gsCart, gs_radial + 90.0);
 958         _gsVertical = cross(baseline, _gsAxis);
 959       } // of have glideslope
 960     } // of found LOC or ILS
 961
 962     audioNavidChanged();
 963   } else { // found nothing
 964     _gs = NULL;
 965     _dme = NULL;
 966     nav_id_node->setStringValue("");
 967     loc_node->setBoolValue(false);
 968     has_gs_node->setBoolValue(false);
 969
 970     _sgr->remove( nav_fx_name );
 971     _sgr->remove( dme_fx_name );
 972   }
 973
 974   is_valid_node->setBoolValue(nav != NULL);
 975   id_c1_node->setIntValue( (int)identBuffer[0] );
 976   id_c2_node->setIntValue( (int)identBuffer[1] );
 977   id_c3_node->setIntValue( (int)identBuffer[2] );
 978   id_c4_node->setIntValue( (int)identBuffer[3] );
 979 }
 980
 981 void FGNavRadio::audioNavidChanged()
 982 {
 983   if (_sgr->exists(nav_fx_name)) {
 984                 _sgr->remove(nav_fx_name);
 985   }
 986
 987   try {
 988     string trans_ident(_navaid->get_trans_ident());
 989     SGSoundSample* sound = morse.make_ident(trans_ident, LO_FREQUENCY);
 990     sound->set_volume( 0.3 );
 991     if (!_sgr->add( sound, nav_fx_name )) {
 992       SG_LOG(SG_COCKPIT, SG_WARN, "Failed to add v1-vor-ident sound");
 993     }
 994
 995           if ( _sgr->exists( dme_fx_name ) ) {
 996       _sgr->remove( dme_fx_name );
 997     }
 998
 999     sound = morse.make_ident( trans_ident, HI_FREQUENCY );
1000     sound->set_volume( 0.3 );
1001     _sgr->add( sound, dme_fx_name );
1002
1003           int offset = (int)(sg_random() * 30.0);
1004           play_count = offset / 4;
1005     last_time = globals->get_time_params()->get_cur_time() - offset;
1006   } catch (sg_io_exception& e) {
1007     SG_LOG(SG_GENERAL, SG_ALERT, e.getFormattedMessage());
1008   }
1009 }