src/Cockpit/kr_87.cxx

   1 // kr-87.cxx -- class to impliment the King KR 87 Digital ADF
   2 //
   3 // Written by Curtis Olson, started April 2002.
   4 //
   5 // Copyright (C) 2002  Curtis L. Olson - curt@flightgear.org
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <stdio.h>      // snprintf
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/math/sg_random.h>
  32
  33 #include <Aircraft/aircraft.hxx>
  34 #include <Navaids/navlist.hxx>
  35 #include <Time/FGEventMgr.hxx>
  36
  37 #include "kr_87.hxx"
  38
  39 #include <string>
  40 SG_USING_STD(string);
  41
  42 static int play_count = 0;
  43 static time_t last_time = 0;
  44
  45
  46 /**
  47  * Boy, this is ugly!  Make the VOR range vary by altitude difference.
  48  */
  49 static double kludgeRange ( double stationElev, double aircraftElev,
  50                             double nominalRange)
  51 {
  52                                 // Assume that the nominal range (usually
  53                                 // 50nm) applies at a 5,000 ft difference.
  54                                 // Just a wild guess!
  55   double factor = ((aircraftElev*SG_METER_TO_FEET) - stationElev) / 5000.0;
  56   double range = fabs(nominalRange * factor);
  57
  58                                 // Clamp the range to keep it sane; for
  59                                 // now, never less than 25% or more than
  60                                 // 500% of nominal range.
  61   if (range < nominalRange/4.0) {
  62     range = nominalRange/4.0;
  63   } else if (range > nominalRange*5.0) {
  64     range = nominalRange*5.0;
  65   }
  66
  67   return range;
  68 }
  69
  70
  71 // Constructor
  72 FGKR_87::FGKR_87() :
  73     lon_node(fgGetNode("/position/longitude-deg", true)),
  74     lat_node(fgGetNode("/position/latitude-deg", true)),
  75     alt_node(fgGetNode("/position/altitude-ft", true)),
  76     need_update(true),
  77     valid(false),
  78     freq(0.0),
  79     stby_freq(0.0),
  80     on_off_vol_btn(0.5),
  81     adf_btn(true),
  82     bfo_btn(false),
  83     frq_btn(false),
  84     last_frq_btn(false),
  85     flt_et_btn(false),
  86     last_flt_et_btn(false),
  87     set_rst_btn(false),
  88     last_set_rst_btn(false),
  89     goal_needle_deg(0.0),
  90     needle_deg(0.0),
  91     flight_timer(0.0),
  92     elapsed_timer(0.0),
  93     tmp_timer(0.0),
  94     ant_mode(0),
  95     stby_mode(0),
  96     timer_mode(0),
  97     count_mode(0)
  98 {
  99     SGPath path( globals->get_fg_root() );
 100     SGPath term = path;
 101     term.append( "Navaids/range.term" );
 102     SGPath low = path;
 103     low.append( "Navaids/range.low" );
 104     SGPath high = path;
 105     high.append( "Navaids/range.high" );
 106
 107     term_tbl = new SGInterpTable( term.str() );
 108     low_tbl = new SGInterpTable( low.str() );
 109     high_tbl = new SGInterpTable( high.str() );
 110 }
 111
 112
 113 // Destructor
 114 FGKR_87::~FGKR_87()
 115 {
 116     delete term_tbl;
 117     delete low_tbl;
 118     delete high_tbl;
 119 }
 120
 121
 122 void
 123 FGKR_87::init ()
 124 {
 125     morse.init();
 126
 127     update(0);                  // FIXME: use dt
 128 }
 129
 130 void
 131 FGKR_87::bind ()
 132 {
 133                                 // User inputs
 134     fgTie("/radios/adf/frequencies/selected-khz", this,
 135           &FGKR_87::get_freq, &FGKR_87::set_freq);
 136     fgSetArchivable("/radios/adf/frequencies/selected-khz");
 137     fgTie("/radios/adf/frequencies/standby-khz", this,
 138           &FGKR_87::get_stby_freq, &FGKR_87::set_stby_freq);
 139     fgSetArchivable("/radios/adf/frequencies/standby-khz");
 140     fgTie("/radios/adf/rotation-deg", this,
 141           &FGKR_87::get_rotation, &FGKR_87::set_rotation);
 142     fgSetArchivable("/radios/adf/rotation-deg");
 143     fgTie("/radios/adf/needle-deg", this,
 144           &FGKR_87::get_needle_deg);
 145     fgTie("/radios/adf/on-off-volume", this,
 146           &FGKR_87::get_on_off_vol_btn,
 147           &FGKR_87::set_on_off_vol_btn);
 148     fgSetArchivable("/radios/adf/on-off-volume");
 149     fgTie("/radios/adf/adf-btn", this,
 150           &FGKR_87::get_adf_btn,
 151           &FGKR_87::set_adf_btn);
 152     fgTie("/radios/adf/bfo-btn", this,
 153           &FGKR_87::get_bfo_btn,
 154           &FGKR_87::set_bfo_btn);
 155     fgTie("/radios/adf/frq-btn", this,
 156           &FGKR_87::get_frq_btn,
 157           &FGKR_87::set_frq_btn);
 158     fgTie("/radios/adf/flt-et-btn", this,
 159           &FGKR_87::get_flt_et_btn,
 160           &FGKR_87::set_flt_et_btn);
 161     fgTie("/radios/adf/set-rst-btn", this,
 162           &FGKR_87::get_set_rst_btn,
 163           &FGKR_87::set_set_rst_btn);
 164     fgTie("/radios/adf/stby-mode", this,
 165           &FGKR_87::get_stby_mode);
 166     fgTie("/radios/adf/timer-mode", this,
 167           &FGKR_87::get_timer_mode);
 168     fgTie("/radios/adf/count-mode", this,
 169           &FGKR_87::get_count_mode);
 170     fgTie("/radios/adf/ident", this,
 171           &FGKR_87::get_ident_btn,
 172           &FGKR_87::set_ident_btn);
 173     fgSetArchivable("/radios/adf/ident");
 174
 175                                 // calculated values
 176     fgTie("/radios/adf/inrange", this, &FGKR_87::get_inrange);
 177     fgTie("/radios/adf/heading", this, &FGKR_87::get_heading);
 178     fgTie("/radios/adf/flight-timer", this, &FGKR_87::get_flight_timer);
 179     fgTie("/radios/adf/elapsed-timer", this,
 180           &FGKR_87::get_elapsed_timer,
 181           &FGKR_87::set_elapsed_timer);
 182 }
 183
 184 void
 185 FGKR_87::unbind ()
 186 {
 187     fgUntie("/radios/adf/frequencies/selected-khz");
 188     fgUntie("/radios/adf/frequencies/standby-khz");
 189     fgUntie("/radios/adf/rotation-deg");
 190     fgUntie("/radios/adf/needle-deg");
 191     fgUntie("/radios/adf/on-off-volume");
 192     fgUntie("/radios/adf/adf-btn");
 193     fgUntie("/radios/adf/bfo-btn");
 194     fgUntie("/radios/adf/frq-btn");
 195     fgUntie("/radios/adf/flt-et-btn");
 196     fgUntie("/radios/adf/set-rst-btn");
 197     fgUntie("/radios/adf/timer-mode");
 198     fgUntie("/radios/adf/count-mode");
 199     fgUntie("/radios/adf/ident");
 200     fgUntie("/radios/adf/inrange");
 201     fgUntie("/radios/adf/heading");
 202     fgUntie("/radios/adf/flight-timer");
 203     fgUntie("/radios/adf/elapsed-timer");
 204 }
 205
 206
 207 // Update the various nav values based on position and valid tuned in navs
 208 void
 209 FGKR_87::update(double dt)
 210 {
 211     double acft_lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 212     double acft_lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 213     double acft_elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
 214
 215     need_update = false;
 216
 217     Point3D aircraft = sgGeodToCart( Point3D( acft_lon, acft_lat, acft_elev ) );
 218     Point3D station;
 219     double az1, az2, s;
 220
 221     ////////////////////////////////////////////////////////////////////////
 222     // Radio
 223     ////////////////////////////////////////////////////////////////////////
 224
 225     if ( on_off_vol_btn >= 0.01 ) {
 226         // buttons
 227         if ( adf_btn == 0 ) {
 228             ant_mode = 1;
 229         } else {
 230             ant_mode = 0;
 231         }
 232
 233         if ( frq_btn && frq_btn != last_frq_btn && stby_mode == 0 ) {
 234             double tmp = freq;
 235             freq = stby_freq;
 236             stby_freq = tmp;
 237         } else if ( frq_btn ) {
 238             stby_mode = 0;
 239             count_mode = 0;
 240         }
 241         last_frq_btn = frq_btn;
 242
 243         if ( flt_et_btn && flt_et_btn != last_flt_et_btn ) {
 244             if ( stby_mode == 0 ) {
 245                 timer_mode = 0;
 246             } else {
 247                 timer_mode = !timer_mode;
 248             }
 249             stby_mode = 1;
 250         }
 251         last_flt_et_btn = flt_et_btn;
 252
 253         if ( set_rst_btn == 1 && set_rst_btn != last_set_rst_btn ) {
 254             // button depressed
 255            tmp_timer = 0.0;
 256         }
 257         if ( set_rst_btn == 1 && set_rst_btn == last_set_rst_btn ) {
 258             // button depressed and was last iteration too
 259             tmp_timer += dt;
 260             cout << "tmp_timer = " << tmp_timer << endl;
 261             if ( tmp_timer > 2.0 ) {
 262                 // button held depressed for 2 seconds
 263                 cout << "entering elapsed count down mode" << endl;
 264                 timer_mode = 1;
 265                 count_mode = 2;
 266                 elapsed_timer = 0.0;
 267             }
 268         }
 269         if ( set_rst_btn == 0 && set_rst_btn != last_set_rst_btn ) {
 270             // button released
 271             if ( tmp_timer > 2.0 ) {
 272                 // button held depressed for 2 seconds, don't adjust
 273                 // mode, just exit
 274             } else if ( count_mode == 2 ) {
 275                 count_mode = 1;
 276             } else {
 277                 count_mode = 0;
 278                 elapsed_timer = 0.0;
 279             }
 280         }
 281         last_set_rst_btn = set_rst_btn;
 282
 283         // timers
 284         flight_timer += dt;
 285
 286         if ( set_rst_btn == 0 ) {
 287             // only count if set/rst button not depressed
 288             if ( count_mode == 0 ) {
 289                 elapsed_timer += dt;
 290             } else if ( count_mode == 1 ) {
 291                 elapsed_timer -= dt;
 292                 if ( elapsed_timer < 1.0 ) {
 293                     count_mode = 0;
 294                     elapsed_timer = 0.0;
 295                 }
 296             }
 297         }
 298
 299         if ( valid ) {
 300             // staightline distance
 301             station = Point3D( x, y, z );
 302             dist = aircraft.distance3D( station );
 303
 304             // wgs84 heading
 305             geo_inverse_wgs_84( acft_elev,
 306                                 acft_lat * SGD_RADIANS_TO_DEGREES,
 307                                 acft_lon * SGD_RADIANS_TO_DEGREES,
 308                                 stn_lat, stn_lon,
 309                                 &az1, &az2, &s );
 310             heading = az1;
 311             // cout << " heading = " << heading
 312             //      << " dist = " << dist << endl;
 313
 314             effective_range = kludgeRange(stn_elev, acft_elev, range);
 315             if ( dist < effective_range * SG_NM_TO_METER ) {
 316                 inrange = true;
 317             } else if ( dist < 2 * effective_range * SG_NM_TO_METER ) {
 318                 inrange = sg_random() <
 319                     ( 2 * effective_range * SG_NM_TO_METER - dist ) /
 320                     (effective_range * SG_NM_TO_METER);
 321             } else {
 322                 inrange = false;
 323             }
 324
 325             if ( inrange ) {
 326                 goal_needle_deg = heading
 327                     - fgGetDouble("/orientation/heading-deg");
 328             }
 329         } else {
 330             inrange = false;
 331         }
 332
 333         if ( ant_mode ) {
 334             goal_needle_deg = 90.0;
 335         }
 336     } else {
 337         goal_needle_deg = 0.0;
 338         flight_timer = 0.0;
 339         elapsed_timer = 0.0;
 340     }
 341
 342     // cout << "goal = " << goal_needle_deg << "actual = " << needle_deg
 343     //      << endl;
 344     double diff = goal_needle_deg - needle_deg;
 345     while ( diff < -180.0 ) { diff += 360.0; }
 346     while ( diff > 180.0 ) { diff -= 360.0; }
 347     needle_deg += diff * dt * 4;
 348
 349     // cout << "flt = " << flight_timer << " et = " << elapsed_timer
 350     //      << " needle = " << needle_deg << endl;
 351
 352 #ifdef ENABLE_AUDIO_SUPPORT
 353     if ( valid && inrange ) {
 354         // play station ident via audio system if on + ident,
 355         // otherwise turn it off
 356         if ( on_off_vol_btn >= 0.01 && ident_btn ) {
 357             FGSimpleSound *sound;
 358             sound = globals->get_soundmgr()->find( "adf-ident" );
 359             if ( sound != NULL ) {
 360                 sound->set_volume( on_off_vol_btn );
 361             } else {
 362                 SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find adf-ident sound" );
 363             }
 364             if ( last_time <
 365                  globals->get_time_params()->get_cur_time() - 30 ) {
 366                 last_time = globals->get_time_params()->get_cur_time();
 367                 play_count = 0;
 368             }
 369             if ( play_count < 4 ) {
 370                 // play ADF ident
 371                 if ( !globals->get_soundmgr()->is_playing("adf-ident") ) {
 372                     globals->get_soundmgr()->play_once( "adf-ident" );
 373                     ++play_count;
 374                 }
 375             }
 376         } else {
 377             globals->get_soundmgr()->stop( "adf-ident" );
 378         }
 379     }
 380 #endif
 381 }
 382
 383
 384 // Update current nav/adf radio stations based on current postition
 385 void FGKR_87::search()
 386 {
 387     double acft_lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 388     double acft_lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 389     double acft_elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
 390
 391                                 // FIXME: the panel should handle this
 392     FGNav nav;
 393
 394     static string last_ident = "";
 395
 396     ////////////////////////////////////////////////////////////////////////
 397     // ADF.
 398     ////////////////////////////////////////////////////////////////////////
 399
 400     if ( current_navlist->query( acft_lon, acft_lat, acft_elev, freq, &nav ) ) {
 401         char sfreq[128];
 402         snprintf( sfreq, 10, "%.0f", freq );
 403         ident = sfreq;
 404         ident += nav.get_ident();
 405 //      cout << "adf ident = " << ident << endl;
 406         valid = true;
 407         if ( last_ident != ident ) {
 408             last_ident = ident;
 409
 410             trans_ident = nav.get_trans_ident();
 411             stn_lon = nav.get_lon();
 412             stn_lat = nav.get_lat();
 413             stn_elev = nav.get_elev();
 414             range = nav.get_range();
 415             effective_range = kludgeRange(stn_elev, acft_elev, range);
 416             x = nav.get_x();
 417             y = nav.get_y();
 418             z = nav.get_z();
 419
 420 #ifdef ENABLE_AUDIO_SUPPORT
 421             if ( globals->get_soundmgr()->exists( "adf-ident" ) ) {
 422                 globals->get_soundmgr()->remove( "adf-ident" );
 423             }
 424             FGSimpleSound *sound;
 425             sound = morse.make_ident( trans_ident, LO_FREQUENCY );
 426             sound->set_volume( 0.3 );
 427             globals->get_soundmgr()->add( sound, "adf-ident" );
 428
 429             int offset = (int)(sg_random() * 30.0);
 430             play_count = offset / 4;
 431             last_time = globals->get_time_params()->get_cur_time() -
 432                 offset;
 433             // cout << "offset = " << offset << " play_count = "
 434             //      << play_count << " last_time = "
 435             //      << last_time << " current time = "
 436             //      << globals->get_time_params()->get_cur_time() << endl;
 437 #endif
 438
 439             // cout << "Found an adf station in range" << endl;
 440             // cout << " id = " << nav.get_ident() << endl;
 441         }
 442     } else {
 443         valid = false;
 444         ident = "";
 445         trans_ident = "";
 446 #ifdef ENABLE_AUDIO_SUPPORT
 447         globals->get_soundmgr()->remove( "adf-ident" );
 448 #endif
 449         last_ident = "";
 450         // cout << "not picking up adf. :-(" << endl;
 451     }
 452 }
 453
 454
 455 double FGKR_87::get_stby_freq() const {
 456     if ( stby_mode == 0 ) {
 457         return stby_freq;
 458     } else {
 459         if ( timer_mode == 0 ) {
 460             return flight_timer;
 461         } else {
 462             return elapsed_timer;
 463         }
 464     }
 465 }