1 // adf.cxx - distance-measuring equipment.
2 // Written by David Megginson, started 2003.
4 // This file is in the Public Domain and comes with no warranty.
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>
15 #include <Main/fg_props.hxx>
16 #include <Main/util.hxx>
17 #include <Navaids/navlist.hxx>
20 #include <Sound/morse.hxx>
28 // Use a bigger number to be more responsive, or a smaller number
29 // to be more sluggish.
30 #define RESPONSIVENESS 0.5
34 * Fiddle with the reception range a bit.
36 * TODO: better reception at night (??).
39 adjust_range (double transmitter_elevation_ft, double aircraft_altitude_ft,
42 double delta_elevation_ft =
43 aircraft_altitude_ft - transmitter_elevation_ft;
44 double range_nm = max_range_nm;
46 // kludge slightly better reception at
48 if (delta_elevation_ft < 0)
49 delta_elevation_ft = 200;
50 if (delta_elevation_ft <= 1000)
51 range_nm *= sqrt(delta_elevation_ft / 1000);
52 else if (delta_elevation_ft >= 5000)
53 range_nm *= sqrt(delta_elevation_ft / 5000);
54 if (range_nm >= max_range_nm * 3)
55 range_nm = max_range_nm * 3;
57 double rand = sg_random();
58 return range_nm + (range_nm * rand * rand);
62 ADF::ADF (SGPropertyNode *node )
64 _name(node->getStringValue("name", "adf")),
65 _num(node->getIntValue("number", 0)),
66 _time_before_search_sec(0),
67 _last_frequency_khz(-1),
68 _transmitter_valid(false),
69 _transmitter_pos(SGGeod::fromDeg(0, 0)),
70 _transmitter_cart(0, 0, 0),
71 _transmitter_range_nm(0),
87 branch = "/instrumentation/" + _name;
88 SGPropertyNode *node = fgGetNode(branch.c_str(), _num, true );
90 // instrument properties
91 _error_node = node->getChild("error-deg", 0, true);
92 _mode_node = node->getChild("mode", 0, true);
93 _volume_node = node->getChild("volume-norm", 0, true);
94 _in_range_node = node->getChild("in-range", 0, true);
95 _bearing_node = node->getChild("indicated-bearing-deg", 0, true);
96 _ident_node = node->getChild("ident", 0, true);
97 _ident_audible_node = node->getChild("ident-audible", 0, true);
98 _serviceable_node = node->getChild("serviceable", 0, true);
99 _power_btn_node = node->getChild("power-btn", 0, true);
100 _operable_node = node->getChild("operable", 0, true);
102 // frequency properties
103 SGPropertyNode *fnode = node->getChild("frequencies", 0, true);
104 _frequency_node = fnode->getChild("selected-khz", 0, true);
106 // foreign simulator properties
107 _electrical_node = fgGetNode("/systems/electrical/outputs/adf", true);
108 _longitude_node = fgGetNode("/position/longitude-deg", true);
109 _latitude_node = fgGetNode("/position/latitude-deg", true);
110 _altitude_node = fgGetNode("/position/altitude-ft", true);
111 _heading_node = fgGetNode("/orientation/heading-deg", true);
113 // backward compatibility check
114 if (_power_btn_node->getType() == simgear::props::NONE)
115 _power_btn_node->setBoolValue(true); // front end didn't implement a power button
117 // sound support (audible ident code)
118 SGSoundMgr *smgr = globals->get_soundmgr();
119 _sgr = smgr->find("avionics", true);
120 _sgr->tie_to_listener();
122 std::ostringstream temp;
123 temp << _name << _num;
124 _adf_ident = temp.str();
128 ADF::update (double delta_time_sec)
130 // If it's off, don't waste any time.
131 if (_electrical_node->getDoubleValue() < 8.0
132 || !_serviceable_node->getBoolValue()
133 || !_power_btn_node->getBoolValue() ) {
134 _in_range_node->setBoolValue(false);
135 _operable_node->setBoolValue(false);
136 _ident_node->setStringValue("");
140 _operable_node->setBoolValue(true);
142 string mode = _mode_node->getStringValue();
143 if (mode == "ant" || mode == "test") set_bearing(delta_time_sec, 90);
144 if (mode != "bfo" && mode != "adf") {
145 _in_range_node->setBoolValue(false);
146 _ident_node->setStringValue("");
150 int frequency_khz = _frequency_node->getIntValue();
151 if (frequency_khz != _last_frequency_khz) {
152 _time_before_search_sec = 0;
153 _last_frequency_khz = frequency_khz;
156 // Get the aircraft position
157 double longitude_deg = _longitude_node->getDoubleValue();
158 double latitude_deg = _latitude_node->getDoubleValue();
159 double altitude_m = _altitude_node->getDoubleValue();
161 double longitude_rad = longitude_deg * SGD_DEGREES_TO_RADIANS;
162 double latitude_rad = latitude_deg * SGD_DEGREES_TO_RADIANS;
164 // On timeout, scan again
165 _time_before_search_sec -= delta_time_sec;
166 if (_time_before_search_sec < 0)
167 search(frequency_khz, longitude_rad, latitude_rad, altitude_m);
169 if (!_transmitter_valid) {
170 _in_range_node->setBoolValue(false);
171 _ident_node->setStringValue("");
175 // Calculate the bearing to the transmitter
176 SGGeod geod = SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m);
177 SGVec3d location = SGVec3d::fromGeod(geod);
179 double distance_nm = dist(_transmitter_cart, location) * SG_METER_TO_NM;
180 double range_nm = adjust_range(_transmitter_pos.getElevationFt(),
181 altitude_m * SG_METER_TO_FEET,
182 _transmitter_range_nm);
184 if (distance_nm <= range_nm) {
186 double bearing, az2, s;
187 double heading = _heading_node->getDoubleValue();
189 geo_inverse_wgs_84(geod, _transmitter_pos,
191 _in_range_node->setBoolValue(true);
196 set_bearing(delta_time_sec, bearing);
200 if ( _ident_audible_node->getBoolValue() )
201 volume = _volume_node->getFloatValue();
205 if ( volume != _last_volume ) {
206 _last_volume = volume;
208 SGSoundSample *sound;
209 sound = _sgr->find( _adf_ident );
211 sound->set_volume( volume );
213 SG_LOG( SG_INSTR, SG_ALERT, "Can't find adf-ident sound" );
216 time_t cur_time = globals->get_time_params()->get_cur_time();
217 if ( _last_ident_time < cur_time - 30 ) {
218 _last_ident_time = cur_time;
222 if ( _ident_count < 4 ) {
223 if ( !_sgr->is_playing(_adf_ident) && (volume > 0.05) ) {
224 _sgr->play_once( _adf_ident );
229 _in_range_node->setBoolValue(false);
230 _ident_node->setStringValue("");
231 _sgr->stop( _adf_ident );
236 ADF::search (double frequency_khz, double longitude_rad,
237 double latitude_rad, double altitude_m)
241 _time_before_search_sec = 1.0;
243 // try the ILS list first
244 FGNavRecord *nav = globals->get_navlist()->findByFreq(frequency_khz,
245 SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m));
247 _transmitter_valid = (nav != NULL);
248 if ( _transmitter_valid ) {
249 ident = nav->get_trans_ident();
250 if ( ident != _last_ident ) {
251 _transmitter_pos = nav->geod();
252 _transmitter_cart = nav->cart();
253 _transmitter_range_nm = nav->get_range();
257 if ( _last_ident != ident ) {
259 _ident_node->setStringValue(ident.c_str());
261 if ( _sgr->exists( _adf_ident ) ) {
262 // stop is required! -- remove alone wouldn't stop immediately
263 _sgr->stop( _adf_ident );
264 _sgr->remove( _adf_ident );
267 SGSoundSample *sound;
268 sound = FGMorse::instance()->make_ident( ident, FGMorse::LO_FREQUENCY );
269 sound->set_volume(_last_volume = 0);
270 _sgr->add( sound, _adf_ident );
272 int offset = (int)(sg_random() * 30.0);
273 _ident_count = offset / 4;
274 _last_ident_time = globals->get_time_params()->get_cur_time() -
280 ADF::set_bearing (double dt, double bearing_deg)
282 double old_bearing_deg = _bearing_node->getDoubleValue();
284 while ((bearing_deg - old_bearing_deg) >= 180)
285 old_bearing_deg += 360;
286 while ((bearing_deg - old_bearing_deg) <= -180)
287 old_bearing_deg -= 360;
288 bearing_deg += _error_node->getDoubleValue();
290 fgGetLowPass(old_bearing_deg, bearing_deg, dt * RESPONSIVENESS);
292 _bearing_node->setDoubleValue(bearing_deg);