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