1 // kr-87.cxx -- class to impliment the King KR 87 Digital ADF
3 // Written by Curtis Olson, started April 2002.
5 // Copyright (C) 2002 Curtis L. Olson - curt@flightgear.org
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.
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.
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.
28 #include <stdio.h> // snprintf
30 #include <simgear/compiler.h>
31 #include <simgear/math/sg_random.h>
33 #include <Aircraft/aircraft.hxx>
34 #include <Navaids/navlist.hxx>
35 #include <Time/FGEventMgr.hxx>
42 static int play_count = 0;
43 static time_t last_time = 0;
47 * Boy, this is ugly! Make the VOR range vary by altitude difference.
49 static double kludgeRange ( double stationElev, double aircraftElev,
52 // Assume that the nominal range (usually
53 // 50nm) applies at a 5,000 ft difference.
55 double factor = ((aircraftElev*SG_METER_TO_FEET) - stationElev) / 5000.0;
56 double range = fabs(nominalRange * factor);
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;
73 lon_node(fgGetNode("/position/longitude-deg", true)),
74 lat_node(fgGetNode("/position/latitude-deg", true)),
75 alt_node(fgGetNode("/position/altitude-ft", true)),
86 last_flt_et_btn(false),
88 last_set_rst_btn(false),
99 SGPath path( globals->get_fg_root() );
101 term.append( "Navaids/range.term" );
103 low.append( "Navaids/range.low" );
105 high.append( "Navaids/range.high" );
107 term_tbl = new SGInterpTable( term.str() );
108 low_tbl = new SGInterpTable( low.str() );
109 high_tbl = new SGInterpTable( high.str() );
127 update(0); // FIXME: use dt
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");
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);
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");
207 // Update the various nav values based on position and valid tuned in navs
209 FGKR_87::update(double dt)
211 double lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
212 double lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
213 double elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
217 Point3D aircraft = sgGeodToCart( Point3D( lon, lat, elev ) );
221 ////////////////////////////////////////////////////////////////////////
223 ////////////////////////////////////////////////////////////////////////
225 if ( on_off_vol_btn >= 0.01 ) {
227 if ( adf_btn == 0 ) {
233 if ( frq_btn && frq_btn != last_frq_btn && stby_mode == 0 ) {
237 } else if ( frq_btn ) {
241 last_frq_btn = frq_btn;
243 if ( flt_et_btn && flt_et_btn != last_flt_et_btn ) {
244 if ( stby_mode == 0 ) {
247 timer_mode = !timer_mode;
251 last_flt_et_btn = flt_et_btn;
253 if ( set_rst_btn == 1 && set_rst_btn != last_set_rst_btn ) {
257 if ( set_rst_btn == 1 && set_rst_btn == last_set_rst_btn ) {
258 // button depressed and was last iteration too
260 cout << "tmp_timer = " << tmp_timer << endl;
262 if ( set_rst_btn == 0 && set_rst_btn != last_set_rst_btn ) {
264 if ( tmp_timer > 2.0 ) {
265 // button held depressed for 2 seconds
266 cout << "entering elapsed count down mode" << endl;
270 } else if ( count_mode == 2 ) {
277 last_set_rst_btn = set_rst_btn;
282 if ( set_rst_btn == 0 ) {
283 // only count if set/rst button not depressed
284 if ( count_mode == 0 ) {
286 } else if ( count_mode == 1 ) {
288 if ( elapsed_timer < 1.0 ) {
296 // staightline distance
297 station = Point3D( x, y, z );
298 dist = aircraft.distance3D( station );
301 geo_inverse_wgs_84( elev, lat * SGD_RADIANS_TO_DEGREES,
302 lon * SGD_RADIANS_TO_DEGREES,
306 // cout << " heading = " << heading
307 // << " dist = " << dist << endl;
309 effective_range = kludgeRange(elev, elev, range);
310 if ( dist < effective_range * SG_NM_TO_METER ) {
312 } else if ( dist < 2 * effective_range * SG_NM_TO_METER ) {
313 inrange = sg_random() <
314 ( 2 * effective_range * SG_NM_TO_METER - dist ) /
315 (effective_range * SG_NM_TO_METER);
321 goal_needle_deg = heading
322 - fgGetDouble("/orientation/heading-deg");
329 goal_needle_deg = 90.0;
332 goal_needle_deg = 0.0;
337 double diff = goal_needle_deg - needle_deg;
338 needle_deg += diff * dt * 4;
340 // cout << "flt = " << flight_timer << " et = " << elapsed_timer
341 // << " needle = " << needle_deg << endl;
343 #ifdef ENABLE_AUDIO_SUPPORT
344 if ( valid && inrange ) {
345 // play station ident via audio system if on + ident,
346 // otherwise turn it off
347 if ( on_off_vol_btn >= 0.01 && ident_btn ) {
348 FGSimpleSound *sound;
349 sound = globals->get_soundmgr()->find( "adf-ident" );
350 if ( sound != NULL ) {
351 sound->set_volume( on_off_vol_btn );
353 SG_LOG( SG_COCKPIT, SG_ALERT, "Can't find adf-ident sound" );
356 globals->get_time_params()->get_cur_time() - 30 ) {
357 last_time = globals->get_time_params()->get_cur_time();
360 if ( play_count < 4 ) {
362 if ( !globals->get_soundmgr()->is_playing("adf-ident") ) {
363 globals->get_soundmgr()->play_once( "adf-ident" );
368 globals->get_soundmgr()->stop( "adf-ident" );
375 // Update current nav/adf radio stations based on current postition
376 void FGKR_87::search()
378 double lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
379 double lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
380 double elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
382 // FIXME: the panel should handle this
385 static string last_ident = "";
387 ////////////////////////////////////////////////////////////////////////
389 ////////////////////////////////////////////////////////////////////////
391 if ( current_navlist->query( lon, lat, elev, freq, &nav ) ) {
393 snprintf( sfreq, 10, "%.0f", freq );
395 ident += nav.get_ident();
396 // cout << "adf ident = " << ident << endl;
398 if ( last_ident != ident ) {
401 trans_ident = nav.get_trans_ident();
404 elev = nav.get_elev();
405 range = nav.get_range();
406 effective_range = kludgeRange(elev, elev, range);
411 #ifdef ENABLE_AUDIO_SUPPORT
412 if ( globals->get_soundmgr()->exists( "adf-ident" ) ) {
413 globals->get_soundmgr()->remove( "adf-ident" );
415 FGSimpleSound *sound;
416 sound = morse.make_ident( trans_ident, LO_FREQUENCY );
417 sound->set_volume( 0.3 );
418 globals->get_soundmgr()->add( sound, "adf-ident" );
420 int offset = (int)(sg_random() * 30.0);
421 play_count = offset / 4;
422 last_time = globals->get_time_params()->get_cur_time() -
424 // cout << "offset = " << offset << " play_count = "
425 // << play_count << " last_time = "
426 // << last_time << " current time = "
427 // << globals->get_time_params()->get_cur_time() << endl;
430 // cout << "Found an adf station in range" << endl;
431 // cout << " id = " << nav.get_ident() << endl;
437 #ifdef ENABLE_AUDIO_SUPPORT
438 globals->get_soundmgr()->remove( "adf-ident" );
441 // cout << "not picking up adf. :-(" << endl;
446 double FGKR_87::get_stby_freq() const {
447 if ( stby_mode == 0 ) {
450 if ( timer_mode == 0 ) {
453 return elapsed_timer;