src/Instrumentation/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
  36 #include "kr_87.hxx"
  37
  38 #include <string>
  39 SG_USING_STD(string);
  40
  41 static int play_count = 0;
  42 static time_t last_time = 0;
  43
  44
  45 /**
  46  * Boy, this is ugly!  Make the VOR range vary by altitude difference.
  47  */
  48 static double kludgeRange ( double stationElev, double aircraftElev,
  49                             double nominalRange)
  50 {
  51                                 // Assume that the nominal range (usually
  52                                 // 50nm) applies at a 5,000 ft difference.
  53                                 // Just a wild guess!
  54   double factor = (aircraftElev - stationElev)*SG_METER_TO_FEET / 5000.0;
  55   double range = fabs(nominalRange * factor);
  56
  57                                 // Clamp the range to keep it sane; for
  58                                 // now, never less than 50% or more than
  59                                 // 500% of nominal range.
  60   if (range < nominalRange/2.0) {
  61     range = nominalRange/2.0;
  62   } else if (range > nominalRange*5.0) {
  63     range = nominalRange*5.0;
  64   }
  65
  66   return range;
  67 }
  68
  69
  70 // Constructor
  71 FGKR_87::FGKR_87( SGPropertyNode *node ) :
  72     lon_node(fgGetNode("/position/longitude-deg", true)),
  73     lat_node(fgGetNode("/position/latitude-deg", true)),
  74     alt_node(fgGetNode("/position/altitude-ft", true)),
  75     bus_power(fgGetNode("/systems/electrical/outputs/adf", true)),
  76     serviceable(fgGetNode("/instrumentation/adf/serviceable", true)),
  77     need_update(true),
  78     valid(false),
  79     inrange(false),
  80     dist(0.0),
  81     heading(0.0),
  82     goal_needle_deg(0.0),
  83     et_flash_time(0.0),
  84     ant_mode(0),
  85     stby_mode(0),
  86     timer_mode(0),
  87     count_mode(0),
  88     rotation(0),
  89     power_btn(true),
  90     audio_btn(true),
  91     vol_btn(0.5),
  92     adf_btn(true),
  93     bfo_btn(false),
  94     frq_btn(false),
  95     last_frq_btn(false),
  96     flt_et_btn(false),
  97     last_flt_et_btn(false),
  98     set_rst_btn(false),
  99     last_set_rst_btn(false),
 100     freq(0),
 101     stby_freq(0),
 102     needle_deg(0.0),
 103     flight_timer(0.0),
 104     elapsed_timer(0.0),
 105     tmp_timer(0.0),
 106     _time_before_search_sec(0)
 107 {
 108 }
 109
 110
 111 // Destructor
 112 FGKR_87::~FGKR_87() {
 113 }
 114
 115
 116 void FGKR_87::init () {
 117     morse.init();
 118 }
 119
 120
 121 void FGKR_87::bind () {
 122     // internal values
 123     fgTie("/radios/kr-87/internal/valid", this, &FGKR_87::get_valid);
 124     fgTie("/radios/kr-87/internal/inrange", this, &FGKR_87::get_inrange);
 125     fgTie("/radios/kr-87/internal/dist", this, &FGKR_87::get_dist);
 126     fgTie("/radios/kr-87/internal/heading", this, &FGKR_87::get_heading);
 127
 128     // modes
 129     fgTie("/radios/kr-87/modes/ant", this,
 130           &FGKR_87::get_ant_mode);
 131     fgTie("/radios/kr-87/modes/stby", this,
 132           &FGKR_87::get_stby_mode);
 133     fgTie("/radios/kr-87/modes/timer", this,
 134           &FGKR_87::get_timer_mode);
 135     fgTie("/radios/kr-87/modes/count", this,
 136           &FGKR_87::get_count_mode);
 137
 138     // input and buttons
 139     fgTie("/radios/kr-87/inputs/rotation-deg", this,
 140           &FGKR_87::get_rotation, &FGKR_87::set_rotation);
 141     fgSetArchivable("/radios/kr-87/inputs/rotation-deg");
 142     fgTie("/radios/kr-87/inputs/power-btn", this,
 143           &FGKR_87::get_power_btn,
 144           &FGKR_87::set_power_btn);
 145     fgSetArchivable("/radios/kr-87/inputs/power-btn");
 146     fgTie("/radios/kr-87/inputs/audio-btn", this,
 147           &FGKR_87::get_audio_btn,
 148           &FGKR_87::set_audio_btn);
 149     fgSetArchivable("/radios/kr-87/inputs/audio-btn");
 150     fgTie("/radios/kr-87/inputs/volume", this,
 151           &FGKR_87::get_vol_btn,
 152           &FGKR_87::set_vol_btn);
 153     fgSetArchivable("/radios/kr-87/inputs/volume");
 154     fgTie("/radios/kr-87/inputs/adf-btn", this,
 155           &FGKR_87::get_adf_btn,
 156           &FGKR_87::set_adf_btn);
 157     fgTie("/radios/kr-87/inputs/bfo-btn", this,
 158           &FGKR_87::get_bfo_btn,
 159           &FGKR_87::set_bfo_btn);
 160     fgTie("/radios/kr-87/inputs/frq-btn", this,
 161           &FGKR_87::get_frq_btn,
 162           &FGKR_87::set_frq_btn);
 163     fgTie("/radios/kr-87/inputs/flt-et-btn", this,
 164           &FGKR_87::get_flt_et_btn,
 165           &FGKR_87::set_flt_et_btn);
 166     fgTie("/radios/kr-87/inputs/set-rst-btn", this,
 167           &FGKR_87::get_set_rst_btn,
 168           &FGKR_87::set_set_rst_btn);
 169
 170     // outputs
 171     fgTie("/radios/kr-87/outputs/selected-khz", this,
 172           &FGKR_87::get_freq, &FGKR_87::set_freq);
 173     fgSetArchivable("/radios/kr-87/outputs/selected-khz");
 174     fgTie("/radios/kr-87/outputs/standby-khz", this,
 175           &FGKR_87::get_stby_freq, &FGKR_87::set_stby_freq);
 176     fgSetArchivable("/radios/kr-87/outputs/standby-khz");
 177     fgTie("/radios/kr-87/outputs/needle-deg", this,
 178           &FGKR_87::get_needle_deg);
 179     fgTie("/radios/kr-87/outputs/flight-timer", this, &FGKR_87::get_flight_timer);
 180     fgTie("/radios/kr-87/outputs/elapsed-timer", this,
 181           &FGKR_87::get_elapsed_timer,
 182           &FGKR_87::set_elapsed_timer);
 183
 184     // annunciators
 185     fgTie("/radios/kr-87/annunciators/ant", this, &FGKR_87::get_ant_ann );
 186     fgTie("/radios/kr-87/annunciators/adf", this, &FGKR_87::get_adf_ann );
 187     fgTie("/radios/kr-87/annunciators/bfo", this, &FGKR_87::get_bfo_ann );
 188     fgTie("/radios/kr-87/annunciators/frq", this, &FGKR_87::get_frq_ann );
 189     fgTie("/radios/kr-87/annunciators/flt", this, &FGKR_87::get_flt_ann );
 190     fgTie("/radios/kr-87/annunciators/et", this, &FGKR_87::get_et_ann );
 191 }
 192
 193
 194 void FGKR_87::unbind () {
 195     // internal values
 196     fgUntie("/radios/kr-87/internal/valid");
 197     fgUntie("/radios/kr-87/internal/inrange");
 198     fgUntie("/radios/kr-87/internal/dist");
 199     fgUntie("/radios/kr-87/internal/heading");
 200
 201     // modes
 202     fgUntie("/radios/kr-87/modes/ant");
 203     fgUntie("/radios/kr-87/modes/stby");
 204     fgUntie("/radios/kr-87/modes/timer");
 205     fgUntie("/radios/kr-87/modes/count");
 206
 207     // input and buttons
 208     fgUntie("/radios/kr-87/inputs/rotation-deg");
 209     fgUntie("/radios/kr-87/inputs/power-btn");
 210     fgUntie("/radios/kr-87/inputs/volume");
 211     fgUntie("/radios/kr-87/inputs/adf-btn");
 212     fgUntie("/radios/kr-87/inputs/bfo-btn");
 213     fgUntie("/radios/kr-87/inputs/frq-btn");
 214     fgUntie("/radios/kr-87/inputs/flt-et-btn");
 215     fgUntie("/radios/kr-87/inputs/set-rst-btn");
 216     fgUntie("/radios/kr-87/inputs/ident-btn");
 217
 218     // outputs
 219     fgUntie("/radios/kr-87/outputs/selected-khz");
 220     fgUntie("/radios/kr-87/outputs/standby-khz");
 221     fgUntie("/radios/kr-87/outputs/needle-deg");
 222     fgUntie("/radios/kr-87/outputs/flight-timer");
 223     fgUntie("/radios/kr-87/outputs/elapsed-timer");
 224
 225     // annunciators
 226     fgUntie("/radios/kr-87/annunciators/ant");
 227     fgUntie("/radios/kr-87/annunciators/adf");
 228     fgUntie("/radios/kr-87/annunciators/bfo");
 229     fgUntie("/radios/kr-87/annunciators/frq");
 230     fgUntie("/radios/kr-87/annunciators/flt");
 231     fgUntie("/radios/kr-87/annunciators/et");
 232 }
 233
 234
 235 // Update the various nav values based on position and valid tuned in navs
 236 void FGKR_87::update( double dt_sec ) {
 237     double acft_lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 238     double acft_lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 239     double acft_elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
 240
 241     need_update = false;
 242
 243     Point3D aircraft = sgGeodToCart( Point3D( acft_lon, acft_lat, acft_elev ) );
 244     Point3D station;
 245     double az1, az2, s;
 246
 247     // On timeout, scan again
 248     _time_before_search_sec -= dt_sec;
 249     if ( _time_before_search_sec < 0 ) {
 250         search();
 251     }
 252
 253     ////////////////////////////////////////////////////////////////////////
 254     // Radio
 255     ////////////////////////////////////////////////////////////////////////
 256
 257     if ( has_power() && serviceable->getBoolValue() ) {
 258         // buttons
 259         if ( adf_btn == 0 ) {
 260             ant_mode = 1;
 261         } else {
 262             ant_mode = 0;
 263         }
 264         // cout << "ant_mode = " << ant_mode << endl;
 265
 266         if ( frq_btn && frq_btn != last_frq_btn && stby_mode == 0 ) {
 267             int tmp = freq;
 268             freq = stby_freq;
 269             stby_freq = tmp;
 270         } else if ( frq_btn ) {
 271             stby_mode = 0;
 272             count_mode = 0;
 273         }
 274         last_frq_btn = frq_btn;
 275
 276         if ( flt_et_btn && flt_et_btn != last_flt_et_btn ) {
 277             if ( stby_mode == 0 ) {
 278                 timer_mode = 0;
 279             } else {
 280                 timer_mode = !timer_mode;
 281             }
 282             stby_mode = 1;
 283         }
 284         last_flt_et_btn = flt_et_btn;
 285
 286         if ( set_rst_btn == 1 && set_rst_btn != last_set_rst_btn ) {
 287             // button depressed
 288            tmp_timer = 0.0;
 289         }
 290         if ( set_rst_btn == 1 && set_rst_btn == last_set_rst_btn ) {
 291             // button depressed and was last iteration too
 292             tmp_timer += dt_sec;
 293             // cout << "tmp_timer = " << tmp_timer << endl;
 294             if ( tmp_timer > 2.0 ) {
 295                 // button held depressed for 2 seconds
 296                 // cout << "entering elapsed count down mode" << endl;
 297                 timer_mode = 1;
 298                 count_mode = 2;
 299                 elapsed_timer = 0.0;
 300             }
 301         }
 302         if ( set_rst_btn == 0 && set_rst_btn != last_set_rst_btn ) {
 303             // button released
 304             if ( tmp_timer > 2.0 ) {
 305                 // button held depressed for 2 seconds, don't adjust
 306                 // mode, just exit
 307             } else if ( count_mode == 2 ) {
 308                 count_mode = 1;
 309             } else {
 310                 count_mode = 0;
 311                 elapsed_timer = 0.0;
 312             }
 313         }
 314         last_set_rst_btn = set_rst_btn;
 315
 316         // timers
 317         flight_timer += dt_sec;
 318
 319         if ( set_rst_btn == 0 ) {
 320             // only count if set/rst button not depressed
 321             if ( count_mode == 0 ) {
 322                 elapsed_timer += dt_sec;
 323             } else if ( count_mode == 1 ) {
 324                 elapsed_timer -= dt_sec;
 325                 if ( elapsed_timer < 1.0 ) {
 326                     count_mode = 0;
 327                     elapsed_timer = 0.0;
 328                 }
 329             }
 330         }
 331
 332         // annunciators
 333         ant_ann = !adf_btn;
 334         adf_ann = adf_btn;
 335         bfo_ann = bfo_btn;
 336         frq_ann = !stby_mode;
 337         flt_ann = stby_mode && !timer_mode;
 338         if ( count_mode < 2 ) {
 339             et_ann = stby_mode && timer_mode;
 340         } else {
 341             et_flash_time += dt_sec;
 342             if ( et_ann && et_flash_time > 0.5 ) {
 343                 et_ann = false;
 344                 et_flash_time -= 0.5;
 345             } else if ( !et_ann && et_flash_time > 0.2 ) {
 346                 et_ann = true;
 347                 et_flash_time -= 0.2;
 348             }
 349         }
 350
 351         if ( valid ) {
 352             // cout << "adf is valid" << endl;
 353             // staightline distance
 354             station = Point3D( x, y, z );
 355             dist = aircraft.distance3D( station );
 356
 357             // wgs84 heading
 358             geo_inverse_wgs_84( acft_elev,
 359                                 acft_lat * SGD_RADIANS_TO_DEGREES,
 360                                 acft_lon * SGD_RADIANS_TO_DEGREES,
 361                                 stn_lat, stn_lon,
 362                                 &az1, &az2, &s );
 363             heading = az1;
 364             // cout << " heading = " << heading
 365             //      << " dist = " << dist << endl;
 366
 367             effective_range = kludgeRange(stn_elev, acft_elev, range);
 368             if ( dist < effective_range * SG_NM_TO_METER ) {
 369                 inrange = true;
 370             } else if ( dist < 2 * effective_range * SG_NM_TO_METER ) {
 371                 inrange = sg_random() <
 372                     ( 2 * effective_range * SG_NM_TO_METER - dist ) /
 373                     (effective_range * SG_NM_TO_METER);
 374             } else {
 375                 inrange = false;
 376             }
 377
 378             // cout << "inrange = " << inrange << endl;
 379
 380             if ( inrange ) {
 381                 goal_needle_deg = heading
 382                     - fgGetDouble("/orientation/heading-deg");
 383             }
 384         } else {
 385             inrange = false;
 386         }
 387
 388         if ( ant_mode ) {
 389             goal_needle_deg = 90.0;
 390         }
 391     } else {
 392         // unit turned off
 393         goal_needle_deg = 0.0;
 394         flight_timer = 0.0;
 395         elapsed_timer = 0.0;
 396         ant_ann = false;
 397         adf_ann = false;
 398         bfo_ann = false;
 399         frq_ann = false;
 400         flt_ann = false;
 401         et_ann = false;
 402     }
 403
 404     // formatted timer
 405     double time;
 406     int hours, min, sec;
 407     if ( timer_mode == 0 ) {
 408         time = flight_timer;
 409     } else {
 410         time = elapsed_timer;
 411     }
 412     // cout << time << endl;
 413     hours = (int)(time / 3600.0);
 414     time -= hours * 3600.00;
 415     min = (int)(time / 60.0);
 416     time -= min * 60.0;
 417     sec = (int)time;
 418     int big, little;
 419     if ( hours > 0 ) {
 420         big = hours;
 421         if ( big > 99 ) {
 422             big = 99;
 423         }
 424         little = min;
 425     } else {
 426         big = min;
 427         little = sec;
 428     }
 429     if ( big > 99 ) {
 430         big = 99;
 431     }
 432     char formatted_timer[128];
 433     // cout << big << ":" << little << endl;
 434     snprintf(formatted_timer, 6, "%02d:%02d", big, little);
 435     fgSetString( "/radios/kr-87/outputs/timer-string", formatted_timer );
 436
 437     while ( goal_needle_deg < 0.0 ) { goal_needle_deg += 360.0; }
 438     while ( goal_needle_deg >= 360.0 ) { goal_needle_deg -= 360.0; }
 439
 440     double diff = goal_needle_deg - needle_deg;
 441     while ( diff < -180.0 ) { diff += 360.0; }
 442     while ( diff > 180.0 ) { diff -= 360.0; }
 443
 444     needle_deg += diff * dt_sec * 4;
 445     while ( needle_deg < 0.0 ) { needle_deg += 360.0; }
 446     while ( needle_deg >= 360.0 ) { needle_deg -= 360.0; }
 447
 448     // cout << "goal = " << goal_needle_deg << " actual = " << needle_deg
 449     //      << endl;
 450     // cout << "flt = " << flight_timer << " et = " << elapsed_timer
 451     //      << " needle = " << needle_deg << endl;
 452
 453     if ( valid && inrange && serviceable->getBoolValue() ) {
 454         // play station ident via audio system if on + ant mode,
 455         // otherwise turn it off
 456         if ( vol_btn >= 0.01 && audio_btn ) {
 457             SGSoundSample *sound;
 458             sound = globals->get_soundmgr()->find( "adf-ident" );
 459             if ( sound != NULL ) {
 460                 if ( !adf_btn ) {
 461                     sound->set_volume( vol_btn );
 462                 } else {
 463                     sound->set_volume( vol_btn / 4.0 );
 464                 }
 465             } else {
 466                 SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find adf-ident sound" );
 467             }
 468             if ( last_time <
 469                  globals->get_time_params()->get_cur_time() - 30 ) {
 470                 last_time = globals->get_time_params()->get_cur_time();
 471                 play_count = 0;
 472             }
 473             if ( play_count < 4 ) {
 474                 // play ADF ident
 475                 if ( !globals->get_soundmgr()->is_playing("adf-ident") ) {
 476                     globals->get_soundmgr()->play_once( "adf-ident" );
 477                     ++play_count;
 478                 }
 479             }
 480         } else {
 481             globals->get_soundmgr()->stop( "adf-ident" );
 482         }
 483     }
 484 }
 485
 486
 487 // Update current nav/adf radio stations based on current postition
 488 void FGKR_87::search() {
 489     double acft_lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 490     double acft_lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 491     double acft_elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
 492
 493                                 // FIXME: the panel should handle this
 494     static string last_ident = "";
 495
 496     // reset search time
 497     _time_before_search_sec = 1.0;
 498
 499     ////////////////////////////////////////////////////////////////////////
 500     // ADF.
 501     ////////////////////////////////////////////////////////////////////////
 502
 503     FGNavRecord *adf
 504         = globals->get_navlist()->findByFreq( freq, acft_lon, acft_lat,
 505                                               acft_elev );
 506     if ( adf != NULL ) {
 507         char sfreq[128];
 508         snprintf( sfreq, 10, "%d", freq );
 509         ident = sfreq;
 510         ident += adf->get_ident();
 511         // cout << "adf ident = " << ident << endl;
 512         valid = true;
 513         if ( last_ident != ident ) {
 514             last_ident = ident;
 515
 516             trans_ident = adf->get_trans_ident();
 517             stn_lon = adf->get_lon();
 518             stn_lat = adf->get_lat();
 519             stn_elev = adf->get_elev_ft();
 520             range = adf->get_range();
 521             effective_range = kludgeRange(stn_elev, acft_elev, range);
 522             x = adf->get_x();
 523             y = adf->get_y();
 524             z = adf->get_z();
 525
 526             if ( globals->get_soundmgr()->exists( "adf-ident" ) ) {
 527                 globals->get_soundmgr()->remove( "adf-ident" );
 528             }
 529             SGSoundSample *sound;
 530             sound = morse.make_ident( trans_ident, LO_FREQUENCY );
 531             sound->set_volume( 0.3 );
 532             globals->get_soundmgr()->add( sound, "adf-ident" );
 533
 534             int offset = (int)(sg_random() * 30.0);
 535             play_count = offset / 4;
 536             last_time = globals->get_time_params()->get_cur_time() -
 537                 offset;
 538             // cout << "offset = " << offset << " play_count = "
 539             //      << play_count << " last_time = "
 540             //      << last_time << " current time = "
 541             //      << globals->get_time_params()->get_cur_time() << endl;
 542
 543             // cout << "Found an adf station in range" << endl;
 544             // cout << " id = " << nav->get_ident() << endl;
 545         }
 546     } else {
 547         valid = false;
 548         ident = "";
 549         trans_ident = "";
 550         globals->get_soundmgr()->remove( "adf-ident" );
 551         last_ident = "";
 552         // cout << "not picking up adf. :-(" << endl;
 553     }
 554 }
 555
 556
 557 int FGKR_87::get_stby_freq() const {
 558     if ( stby_mode == 0 ) {
 559         return stby_freq;
 560     } else {
 561         if ( timer_mode == 0 ) {
 562             return (int)flight_timer;
 563         } else {
 564             return (int)elapsed_timer;
 565         }
 566     }
 567 }