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