1 // realwx_ctrl.cxx -- Process real weather data
3 // Written by David Megginson, started February 2002.
4 // Rewritten by Torsten Dreyer, August 2010
6 // Copyright (C) 2002 David Megginson - david@megginson.com
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include "realwx_ctrl.hxx"
28 #include "metarproperties.hxx"
29 #include "metarairportfilter.hxx"
30 #include "fgmetar.hxx"
32 #include <Main/fg_props.hxx>
34 #include <simgear/structure/exception.hxx>
35 #include <simgear/misc/strutils.hxx>
36 #include <simgear/props/tiedpropertylist.hxx>
38 #if defined(ENABLE_THREADS)
39 #include <OpenThreads/Thread>
40 #include <simgear/threads/SGQueue.hxx>
44 namespace Environment {
46 /* -------------------------------------------------------------------------------- */
48 class LiveMetarProperties : public MetarProperties {
50 LiveMetarProperties( SGPropertyNode_ptr rootNode );
51 virtual ~LiveMetarProperties();
52 virtual void update( double dt );
54 virtual double getTimeToLive() const { return _timeToLive; }
55 virtual void setTimeToLive( double value ) { _timeToLive = value; }
61 typedef SGSharedPtr<LiveMetarProperties> LiveMetarProperties_ptr;
63 LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode ) :
64 MetarProperties( rootNode ),
67 _tiedProperties.Tie("time-to-live", &_timeToLive );
70 LiveMetarProperties::~LiveMetarProperties()
74 void LiveMetarProperties::update( double dt )
77 if( _timeToLive < 0.0 ) _timeToLive = 0.0;
80 /* -------------------------------------------------------------------------------- */
82 class BasicRealWxController : public RealWxController
85 BasicRealWxController( SGPropertyNode_ptr rootNode );
86 virtual ~BasicRealWxController ();
89 virtual void reinit ();
94 void update( double dt );
96 virtual void update( bool first, double dt ) = 0;
98 long getMetarMaxAgeMin() const { return _max_age_n == NULL ? 0 : _max_age_n->getLongValue(); }
100 SGPropertyNode_ptr _rootNode;
101 SGPropertyNode_ptr _longitude_n;
102 SGPropertyNode_ptr _latitude_n;
103 SGPropertyNode_ptr _ground_elevation_n;
104 SGPropertyNode_ptr _max_age_n;
108 simgear::TiedPropertyList _tiedProperties;
109 ; typedef std::vector<LiveMetarProperties_ptr> MetarPropertiesList;
110 MetarPropertiesList _metarProperties;
113 /* -------------------------------------------------------------------------------- */
116 ~/enabled: bool Enables/Disables the realwx controller
117 ~/metar[1..n]: string Target property path for metar data
120 BasicRealWxController::BasicRealWxController( SGPropertyNode_ptr rootNode ) :
122 _longitude_n( fgGetNode( "/position/longitude-deg", true )),
123 _latitude_n( fgGetNode( "/position/latitude-deg", true )),
124 _ground_elevation_n( fgGetNode( "/position/ground-elev-m", true )),
125 _max_age_n( fgGetNode( "/environment/params/metar-max-age-min", false ) ),
129 // at least instantiate MetarProperties for /environment/metar
130 _metarProperties.push_back( new LiveMetarProperties(
131 fgGetNode( rootNode->getStringValue("metar", "/environment/metar"), true ) ) );
133 PropertyList metars = rootNode->getChildren("metar");
134 for( PropertyList::size_type i = 1; i < metars.size(); i++ ) {
135 SG_LOG( SG_ALL, SG_INFO, "Adding metar properties at " << metars[i]->getStringValue() );
136 _metarProperties.push_back( new LiveMetarProperties(
137 fgGetNode( metars[i]->getStringValue(), true )));
141 BasicRealWxController::~BasicRealWxController()
145 void BasicRealWxController::init()
148 update(0); // fetch data ASAP
151 void BasicRealWxController::reinit()
156 void BasicRealWxController::bind()
158 _tiedProperties.setRoot( _rootNode );
159 _tiedProperties.Tie( "enabled", &_enabled );
162 void BasicRealWxController::unbind()
164 _tiedProperties.Untie();
167 void BasicRealWxController::update( double dt )
170 bool firstIteration = !__enabled; // first iteration after being enabled?
172 // clock tick for every METAR in stock
173 for( MetarPropertiesList::iterator it = _metarProperties.begin();
174 it != _metarProperties.end(); it++ ) {
175 // first round? All received METARs are outdated
176 if( firstIteration ) (*it)->setTimeToLive( 0.0 );
180 update( firstIteration, dt );
187 /* -------------------------------------------------------------------------------- */
189 class NoaaMetarRealWxController : public BasicRealWxController {
191 NoaaMetarRealWxController( SGPropertyNode_ptr rootNode );
192 virtual ~NoaaMetarRealWxController();
193 virtual void update (bool first, double delta_time_sec);
194 virtual void shutdown ();
196 class MetarLoadRequest {
198 MetarLoadRequest( const string & stationId ) :
199 _stationId(stationId),
200 _proxyHost(fgGetNode("/sim/presets/proxy/host", true)->getStringValue()),
201 _proxyPort(fgGetNode("/sim/presets/proxy/port", true)->getStringValue()),
202 _proxyAuth(fgGetNode("/sim/presets/proxy/authentication", true)->getStringValue())
204 MetarLoadRequest( const MetarLoadRequest & other ) :
205 _stationId(other._stationId),
206 _proxyHost(other._proxyAuth),
207 _proxyPort(other._proxyPort),
208 _proxyAuth(other._proxyAuth)
217 class MetarLoadResponse {
219 MetarLoadResponse( const string & stationId, const string metar ) {
220 _stationId = stationId;
223 MetarLoadResponse( const MetarLoadResponse & other ) {
224 _stationId = other._stationId;
225 _metar = other._metar;
231 double _positionTimeToLive;
232 double _requestTimer;
234 #if defined(ENABLE_THREADS)
235 class MetarLoadThread : public OpenThreads::Thread {
237 MetarLoadThread( long maxAge );
238 virtual ~MetarLoadThread( ) { stop(); }
239 void requestMetar( const MetarLoadRequest & metarRequest, bool background = true );
240 bool hasMetar() { return _responseQueue.size() > 0; }
241 MetarLoadResponse getMetar() { return _responseQueue.pop(); }
245 void fetch( const MetarLoadRequest & );
247 long _minRequestInterval;
249 SGBlockingQueue <MetarLoadRequest> _requestQueue;
250 SGBlockingQueue <MetarLoadResponse> _responseQueue;
253 MetarLoadThread * _metarLoadThread;
257 NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ) :
258 BasicRealWxController(rootNode),
259 _positionTimeToLive(0.0),
262 #if defined(ENABLE_THREADS)
263 _metarLoadThread = new MetarLoadThread(getMetarMaxAgeMin());
264 _metarLoadThread->start();
268 void NoaaMetarRealWxController::shutdown()
270 #if defined(ENABLE_THREADS)
271 if( _metarLoadThread ) {
272 delete _metarLoadThread;
273 _metarLoadThread = NULL;
275 #endif // ENABLE_THREADS
278 NoaaMetarRealWxController::~NoaaMetarRealWxController()
282 void NoaaMetarRealWxController::update( bool first, double dt )
284 _positionTimeToLive -= dt;
287 if( _positionTimeToLive <= 0.0 ) {
288 // check nearest airport
289 SG_LOG(SG_ALL, SG_INFO, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" );
290 _positionTimeToLive = 60.0;
292 SGGeod pos = SGGeod::fromDeg(_longitude_n->getDoubleValue(), _latitude_n->getDoubleValue());
294 FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() );
295 if( nearestAirport == NULL ) {
296 SG_LOG(SG_ALL,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM" );
300 SG_LOG(SG_ALL, SG_INFO,
301 "NoaaMetarRealWxController::update(): nearest airport with METAR is: " << nearestAirport->ident() );
303 // if it has changed, invalidate the associated METAR
304 if( _metarProperties[0]->getStationId() != nearestAirport->ident() ) {
305 SG_LOG(SG_ALL, SG_INFO,
306 "NoaaMetarRealWxController::update(): nearest airport with METAR has changed. Old: '" <<
307 _metarProperties[0]->getStationId() <<
308 "', new: '" << nearestAirport->ident() << "'" );
309 _metarProperties[0]->setStationId( nearestAirport->ident() );
310 _metarProperties[0]->setTimeToLive( 0.0 );
314 if( _requestTimer <= 0.0 ) {
315 _requestTimer = 10.0;
317 for( MetarPropertiesList::iterator it = _metarProperties.begin();
318 it != _metarProperties.end(); it++ ) {
320 if( (*it)->getTimeToLive() > 0.0 ) continue;
321 const std::string & stationId = (*it)->getStationId();
322 if( stationId.empty() ) continue;
324 SG_LOG(SG_ALL, SG_INFO,
325 "NoaaMetarRealWxController::update(): spawning load request for station-id '" << stationId << "'" );
327 MetarLoadRequest request( stationId );
328 // load the metar for the nearest airport in the foreground if the fdm is uninitialized
329 // to make sure a metar is received
330 // before the automatic runway selection code runs. All subsequent calls
331 // run in the background
332 bool background = fgGetBool("/sim/fdm-initialized", false ) || it != _metarProperties.begin();
333 _metarLoadThread->requestMetar( request, background );
337 // pick all the received responses from the result queue and update the associated
339 while( _metarLoadThread->hasMetar() ) {
340 MetarLoadResponse metar = _metarLoadThread->getMetar();
341 SG_LOG( SG_ALL, SG_INFO, "NoaaMetarRwalWxController::update() received METAR for " << metar._stationId << ": " << metar._metar );
342 for( MetarPropertiesList::iterator it = _metarProperties.begin();
343 it != _metarProperties.end(); it++ ) {
344 if( (*it)->getStationId() != metar._stationId )
346 (*it)->setTimeToLive(900);
347 (*it)->setMetar( metar._metar );
352 /* -------------------------------------------------------------------------------- */
354 #if defined(ENABLE_THREADS)
355 NoaaMetarRealWxController::MetarLoadThread::MetarLoadThread( long maxAge ) :
357 _minRequestInterval(2000),
362 void NoaaMetarRealWxController::MetarLoadThread::requestMetar( const MetarLoadRequest & metarRequest, bool background )
365 if( _requestQueue.size() > 10 ) {
366 SG_LOG(SG_ALL,SG_ALERT,
367 "NoaaMetarRealWxController::MetarLoadThread::requestMetar() more than 10 outstanding METAR requests, dropping "
368 << metarRequest._stationId );
372 _requestQueue.push( metarRequest );
374 fetch( metarRequest );
378 void NoaaMetarRealWxController::MetarLoadThread::stop()
380 // set stop flag and wake up the thread with an empty request
382 MetarLoadRequest request("");
383 requestMetar(request);
387 void NoaaMetarRealWxController::MetarLoadThread::run()
389 SGTimeStamp lastRun = SGTimeStamp::fromSec(0);
391 SGTimeStamp dt = SGTimeStamp::now() - lastRun;
393 long delayMs = _minRequestInterval - dt.getSeconds() * 1000;
394 while (( delayMs > 0 ) && !_stop)
396 // sleep no more than 3 seconds at a time, otherwise shutdown response is too slow
397 long sleepMs = (delayMs>3000) ? 3000 : delayMs;
398 microSleep( sleepMs * 1000 );
405 lastRun = SGTimeStamp::now();
407 const MetarLoadRequest request = _requestQueue.pop();
409 if (( request._stationId.size() == 0 ) || _stop)
416 void NoaaMetarRealWxController::MetarLoadThread::fetch( const MetarLoadRequest & request )
418 SGSharedPtr<FGMetar> result = NULL;
421 result = new FGMetar( request._stationId, request._proxyHost, request._proxyPort, request._proxyAuth );
422 _minRequestInterval = 2000;
423 } catch (const sg_io_exception& e) {
424 SG_LOG( SG_GENERAL, SG_WARN, "NoaaMetarRealWxController::fetchMetar(): can't get METAR for "
425 << request._stationId << ":" << e.getFormattedMessage().c_str() );
426 _minRequestInterval += _minRequestInterval/2;
427 if( _minRequestInterval > 30000 )
428 _minRequestInterval = 30000;
432 string reply = result->getData();
433 std::replace(reply.begin(), reply.end(), '\n', ' ');
434 string metar = simgear::strutils::strip( reply );
436 if( metar.empty() ) {
437 SG_LOG( SG_GENERAL, SG_WARN, "NoaaMetarRealWxController::fetchMetar(): dropping empty METAR for "
438 << request._stationId );
442 if( _maxAge && result->getAge_min() > _maxAge ) {
443 SG_LOG( SG_GENERAL, SG_ALERT, "NoaaMetarRealWxController::fetchMetar(): dropping outdated METAR "
448 MetarLoadResponse response( request._stationId, metar );
449 _responseQueue.push( response );
453 /* -------------------------------------------------------------------------------- */
455 RealWxController * RealWxController::createInstance( SGPropertyNode_ptr rootNode )
457 // string dataSource = rootNode->getStringValue("data-source", "noaa" );
458 // if( dataSource == "nwx" ) {
459 // return new NwxMetarRealWxController( rootNode );
461 return new NoaaMetarRealWxController( rootNode );
465 /* -------------------------------------------------------------------------------- */
467 } // namespace Environment