src/Instrumentation/adf.cxx

   1 // adf.cxx - distance-measuring equipment.
   2 // Written by David Megginson, started 2003.
   3 //
   4 // This file is in the Public Domain and comes with no warranty.
   5
   6 #ifdef HAVE_CONFIG_H
   7 #  include <config.h>
   8 #endif
   9
  10 #include <simgear/compiler.h>
  11 #include <simgear/math/sg_geodesy.hxx>
  12 #include <simgear/math/sg_random.h>
  13 #include <simgear/timing/sg_time.hxx>
  14
  15 #include <Main/fg_props.hxx>
  16 #include <Main/util.hxx>
  17 #include <Navaids/navlist.hxx>
  18
  19 #include "adf.hxx"
  20
  21 #include <iostream>
  22 #include <string>
  23 #include <sstream>
  24
  25
  26 // Use a bigger number to be more responsive, or a smaller number
  27 // to be more sluggish.
  28 #define RESPONSIVENESS 0.5
  29
  30
  31 /**
  32  * Fiddle with the reception range a bit.
  33  *
  34  * TODO: better reception at night (??).
  35  */
  36 static double
  37 adjust_range (double transmitter_elevation_ft, double aircraft_altitude_ft,
  38               double max_range_nm)
  39 {
  40     double delta_elevation_ft =
  41         aircraft_altitude_ft - transmitter_elevation_ft;
  42     double range_nm = max_range_nm;
  43
  44                                 // kludge slightly better reception at
  45                                 // altitude
  46     if (delta_elevation_ft < 0)
  47         delta_elevation_ft = 200;
  48     if (delta_elevation_ft <= 1000)
  49         range_nm *= sqrt(delta_elevation_ft / 1000);
  50     else if (delta_elevation_ft >= 5000)
  51         range_nm *= sqrt(delta_elevation_ft / 5000);
  52     if (range_nm >= max_range_nm * 3)
  53         range_nm = max_range_nm * 3;
  54
  55     double rand = sg_random();
  56     return range_nm + (range_nm * rand * rand);
  57 }
  58
  59
  60 ADF::ADF (SGPropertyNode *node )
  61     :
  62     _name(node->getStringValue("name", "adf")),
  63     _num(node->getIntValue("number", 0)),
  64     _time_before_search_sec(0),
  65     _last_frequency_khz(-1),
  66     _transmitter_valid(false),
  67     _transmitter_pos(SGGeod::fromDeg(0, 0)),
  68     _transmitter_cart(0, 0, 0),
  69     _transmitter_range_nm(0),
  70     _ident_count(0),
  71     _last_ident_time(0),
  72     _last_volume(-1),
  73     _sgr(0)
  74 {
  75 }
  76
  77 ADF::~ADF ()
  78 {
  79 }
  80
  81 void
  82 ADF::init ()
  83 {
  84     string branch;
  85     branch = "/instrumentation/" + _name;
  86
  87     SGPropertyNode *node = fgGetNode(branch.c_str(), _num, true );
  88     _longitude_node = fgGetNode("/position/longitude-deg", true);
  89     _latitude_node = fgGetNode("/position/latitude-deg", true);
  90     _altitude_node = fgGetNode("/position/altitude-ft", true);
  91     _heading_node = fgGetNode("/orientation/heading-deg", true);
  92     _serviceable_node = node->getChild("serviceable", 0, true);
  93     _error_node = node->getChild("error-deg", 0, true);
  94     _electrical_node = fgGetNode("/systems/electrical/outputs/adf", true);
  95     branch = branch + "/frequencies";
  96     SGPropertyNode *fnode = node->getChild("frequencies", 0, true);
  97     _frequency_node = fnode->getChild("selected-khz", 0, true);
  98     _mode_node = node->getChild("mode", 0, true);
  99     _volume_node = node->getChild("volume-norm", 0, true);
 100     _in_range_node = node->getChild("in-range", 0, true);
 101     _bearing_node = node->getChild("indicated-bearing-deg", 0, true);
 102     _ident_node = node->getChild("ident", 0, true);
 103     _ident_audible_node = node->getChild("ident-audible", 0, true);
 104
 105     SGSoundMgr *smgr = globals->get_soundmgr();
 106     _sgr = smgr->find("avionics", true);
 107     _sgr->tie_to_listener();
 108
 109     morse.init();
 110
 111     std::ostringstream temp;
 112     temp << _name << _num;
 113     _adf_ident = temp.str();
 114 }
 115
 116 void
 117 ADF::update (double delta_time_sec)
 118 {
 119                                 // If it's off, don't waste any time.
 120     if (_electrical_node->getDoubleValue() < 1.0
 121             || !_serviceable_node->getBoolValue()) {
 122         set_bearing(delta_time_sec, 90);
 123         _ident_node->setStringValue("");
 124         return;
 125     }
 126
 127                                 // Get the frequency
 128     int frequency_khz = _frequency_node->getIntValue();
 129     if (frequency_khz != _last_frequency_khz) {
 130         _time_before_search_sec = 0;
 131         _last_frequency_khz = frequency_khz;
 132     }
 133
 134                                 // Get the aircraft position
 135     double longitude_deg = _longitude_node->getDoubleValue();
 136     double latitude_deg = _latitude_node->getDoubleValue();
 137     double altitude_m = _altitude_node->getDoubleValue();
 138
 139     double longitude_rad = longitude_deg * SGD_DEGREES_TO_RADIANS;
 140     double latitude_rad = latitude_deg * SGD_DEGREES_TO_RADIANS;
 141
 142                                 // On timeout, scan again
 143     _time_before_search_sec -= delta_time_sec;
 144     if (_time_before_search_sec < 0)
 145         search(frequency_khz, longitude_rad, latitude_rad, altitude_m);
 146
 147                                 // If it's off, don't bother.
 148     string mode = _mode_node->getStringValue();
 149     if (!_transmitter_valid || (mode != "bfo" && mode != "adf"))
 150     {
 151         set_bearing(delta_time_sec, 90);
 152         _ident_node->setStringValue("");
 153         return;
 154     }
 155
 156                                 // Calculate the bearing to the transmitter
 157     SGGeod geod = SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m);
 158     SGVec3d location = SGVec3d::fromGeod(geod);
 159
 160     double distance_nm = dist(_transmitter_cart, location) * SG_METER_TO_NM;
 161     double range_nm = adjust_range(_transmitter_pos.getElevationFt(),
 162                                    altitude_m * SG_METER_TO_FEET,
 163                                    _transmitter_range_nm);
 164
 165     if (distance_nm <= range_nm) {
 166
 167         double bearing, az2, s;
 168         double heading = _heading_node->getDoubleValue();
 169
 170         geo_inverse_wgs_84(geod, _transmitter_pos,
 171                            &bearing, &az2, &s);
 172         _in_range_node->setBoolValue(true);
 173
 174         bearing -= heading;
 175         if (bearing < 0)
 176             bearing += 360;
 177         set_bearing(delta_time_sec, bearing);
 178
 179         // adf ident sound
 180         float volume;
 181         if ( _ident_audible_node->getBoolValue() )
 182             volume = _volume_node->getFloatValue();
 183         else
 184             volume = 0.0;
 185
 186         if ( volume != _last_volume ) {
 187             _last_volume = volume;
 188
 189             SGSoundSample *sound;
 190             sound = _sgr->find( _adf_ident );
 191             if ( sound != NULL )
 192                 sound->set_volume( volume );
 193             else
 194                 SG_LOG( SG_GENERAL, SG_ALERT, "Can't find adf-ident sound" );
 195         }
 196
 197         time_t cur_time = globals->get_time_params()->get_cur_time();
 198         if ( _last_ident_time < cur_time - 30 ) {
 199             _last_ident_time = cur_time;
 200             _ident_count = 0;
 201         }
 202
 203         if ( _ident_count < 4 ) {
 204             if ( !_sgr->is_playing(_adf_ident) && (volume > 0.05) ) {
 205                 _sgr->play_once( _adf_ident );
 206                 ++_ident_count;
 207             }
 208         }
 209     } else {
 210         _in_range_node->setBoolValue(false);
 211         set_bearing(delta_time_sec, 90);
 212         _ident_node->setStringValue("");
 213         _sgr->stop( _adf_ident );
 214     }
 215 }
 216
 217 void
 218 ADF::search (double frequency_khz, double longitude_rad,
 219              double latitude_rad, double altitude_m)
 220 {
 221     string ident = "";
 222                                 // reset search time
 223     _time_before_search_sec = 1.0;
 224
 225                                 // try the ILS list first
 226     FGNavRecord *nav = globals->get_navlist()->findByFreq(frequency_khz,
 227       SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m));
 228
 229     _transmitter_valid = (nav != NULL);
 230     if ( _transmitter_valid ) {
 231         ident = nav->get_trans_ident();
 232         if ( ident != _last_ident ) {
 233             _transmitter_pos = nav->geod();
 234             _transmitter_cart = nav->cart();
 235             _transmitter_range_nm = nav->get_range();
 236         }
 237     }
 238
 239     if ( _last_ident != ident ) {
 240         _last_ident = ident;
 241         _ident_node->setStringValue(ident.c_str());
 242
 243         if ( _sgr->exists( _adf_ident ) ) {
 244             // stop is required! -- remove alone wouldn't stop immediately
 245             _sgr->stop( _adf_ident );
 246             _sgr->remove( _adf_ident );
 247         }
 248
 249         SGSoundSample *sound;
 250         sound = morse.make_ident( ident, LO_FREQUENCY );
 251         sound->set_volume(_last_volume = 0);
 252         _sgr->add( sound, _adf_ident );
 253
 254         int offset = (int)(sg_random() * 30.0);
 255         _ident_count = offset / 4;
 256         _last_ident_time = globals->get_time_params()->get_cur_time() -
 257             offset;
 258     }
 259 }
 260
 261 void
 262 ADF::set_bearing (double dt, double bearing_deg)
 263 {
 264     double old_bearing_deg = _bearing_node->getDoubleValue();
 265
 266     while ((bearing_deg - old_bearing_deg) >= 180)
 267         old_bearing_deg += 360;
 268     while ((bearing_deg - old_bearing_deg) <= -180)
 269         old_bearing_deg -= 360;
 270     bearing_deg += _error_node->getDoubleValue();
 271     bearing_deg =
 272         fgGetLowPass(old_bearing_deg, bearing_deg, dt * RESPONSIVENESS);
 273
 274     _bearing_node->setDoubleValue(bearing_deg);
 275 }
 276
 277
 278 // end of adf.cxx