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     _power_btn_node = node->getChild("power-btn", 0, true);
 105
 106     SGSoundMgr *smgr = globals->get_soundmgr();
 107     _sgr = smgr->find("avionics", true);
 108     _sgr->tie_to_listener();
 109
 110     morse.init();
 111
 112     std::ostringstream temp;
 113     temp << _name << _num;
 114     _adf_ident = temp.str();
 115 }
 116
 117 void
 118 ADF::update (double delta_time_sec)
 119 {
 120                                 // If it's off, don't waste any time.
 121     if (_electrical_node->getDoubleValue() < 8.0
 122             || !_serviceable_node->getBoolValue()
 123             || !_power_btn_node->getBoolValue()     ) {
 124         _ident_node->setStringValue("");
 125         return;
 126     }
 127
 128     string mode = _mode_node->getStringValue();
 129     if (mode == "ant" || mode == "test") set_bearing(delta_time_sec, 90);
 130     if (mode != "bfo" && mode != "adf") {
 131         _ident_node->setStringValue("");
 132         return;
 133     }
 134                                 // Get the frequency
 135     int frequency_khz = _frequency_node->getIntValue();
 136     if (frequency_khz != _last_frequency_khz) {
 137         _time_before_search_sec = 0;
 138         _last_frequency_khz = frequency_khz;
 139     }
 140
 141                                 // Get the aircraft position
 142     double longitude_deg = _longitude_node->getDoubleValue();
 143     double latitude_deg = _latitude_node->getDoubleValue();
 144     double altitude_m = _altitude_node->getDoubleValue();
 145
 146     double longitude_rad = longitude_deg * SGD_DEGREES_TO_RADIANS;
 147     double latitude_rad = latitude_deg * SGD_DEGREES_TO_RADIANS;
 148
 149                                 // On timeout, scan again
 150     _time_before_search_sec -= delta_time_sec;
 151     if (_time_before_search_sec < 0)
 152         search(frequency_khz, longitude_rad, latitude_rad, altitude_m);
 153
 154     if (!_transmitter_valid) {
 155         _ident_node->setStringValue("");
 156         return;
 157     }
 158
 159                                 // Calculate the bearing to the transmitter
 160     SGGeod geod = SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m);
 161     SGVec3d location = SGVec3d::fromGeod(geod);
 162
 163     double distance_nm = dist(_transmitter_cart, location) * SG_METER_TO_NM;
 164     double range_nm = adjust_range(_transmitter_pos.getElevationFt(),
 165                                    altitude_m * SG_METER_TO_FEET,
 166                                    _transmitter_range_nm);
 167
 168     if (distance_nm <= range_nm) {
 169
 170         double bearing, az2, s;
 171         double heading = _heading_node->getDoubleValue();
 172
 173         geo_inverse_wgs_84(geod, _transmitter_pos,
 174                            &bearing, &az2, &s);
 175         _in_range_node->setBoolValue(true);
 176
 177         bearing -= heading;
 178         if (bearing < 0)
 179             bearing += 360;
 180         set_bearing(delta_time_sec, bearing);
 181
 182         // adf ident sound
 183         float volume;
 184         if ( _ident_audible_node->getBoolValue() )
 185             volume = _volume_node->getFloatValue();
 186         else
 187             volume = 0.0;
 188
 189         if ( volume != _last_volume ) {
 190             _last_volume = volume;
 191
 192             SGSoundSample *sound;
 193             sound = _sgr->find( _adf_ident );
 194             if ( sound != NULL )
 195                 sound->set_volume( volume );
 196             else
 197                 SG_LOG( SG_GENERAL, SG_ALERT, "Can't find adf-ident sound" );
 198         }
 199
 200         time_t cur_time = globals->get_time_params()->get_cur_time();
 201         if ( _last_ident_time < cur_time - 30 ) {
 202             _last_ident_time = cur_time;
 203             _ident_count = 0;
 204         }
 205
 206         if ( _ident_count < 4 ) {
 207             if ( !_sgr->is_playing(_adf_ident) && (volume > 0.05) ) {
 208                 _sgr->play_once( _adf_ident );
 209                 ++_ident_count;
 210             }
 211         }
 212     } else {
 213         _in_range_node->setBoolValue(false);
 214         _ident_node->setStringValue("");
 215         _sgr->stop( _adf_ident );
 216     }
 217 }
 218
 219 void
 220 ADF::search (double frequency_khz, double longitude_rad,
 221              double latitude_rad, double altitude_m)
 222 {
 223     string ident = "";
 224                                 // reset search time
 225     _time_before_search_sec = 1.0;
 226
 227                                 // try the ILS list first
 228     FGNavRecord *nav = globals->get_navlist()->findByFreq(frequency_khz,
 229       SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m));
 230
 231     _transmitter_valid = (nav != NULL);
 232     if ( _transmitter_valid ) {
 233         ident = nav->get_trans_ident();
 234         if ( ident != _last_ident ) {
 235             _transmitter_pos = nav->geod();
 236             _transmitter_cart = nav->cart();
 237             _transmitter_range_nm = nav->get_range();
 238         }
 239     }
 240
 241     if ( _last_ident != ident ) {
 242         _last_ident = ident;
 243         _ident_node->setStringValue(ident.c_str());
 244
 245         if ( _sgr->exists( _adf_ident ) ) {
 246             // stop is required! -- remove alone wouldn't stop immediately
 247             _sgr->stop( _adf_ident );
 248             _sgr->remove( _adf_ident );
 249         }
 250
 251         SGSoundSample *sound;
 252         sound = morse.make_ident( ident, LO_FREQUENCY );
 253         sound->set_volume(_last_volume = 0);
 254         _sgr->add( sound, _adf_ident );
 255
 256         int offset = (int)(sg_random() * 30.0);
 257         _ident_count = offset / 4;
 258         _last_ident_time = globals->get_time_params()->get_cur_time() -
 259             offset;
 260     }
 261 }
 262
 263 void
 264 ADF::set_bearing (double dt, double bearing_deg)
 265 {
 266     double old_bearing_deg = _bearing_node->getDoubleValue();
 267
 268     while ((bearing_deg - old_bearing_deg) >= 180)
 269         old_bearing_deg += 360;
 270     while ((bearing_deg - old_bearing_deg) <= -180)
 271         old_bearing_deg -= 360;
 272     bearing_deg += _error_node->getDoubleValue();
 273     bearing_deg =
 274         fgGetLowPass(old_bearing_deg, bearing_deg, dt * RESPONSIVENESS);
 275
 276     _bearing_node->setDoubleValue(bearing_deg);
 277 }
 278
 279
 280 // end of adf.cxx