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