1 // realwx_ctrl.cxx -- Process real weather data
3 // Written by David Megginson, started February 2002.
4 // Rewritten by Torsten Dreyer, August 2010, August 2011
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"
30 #include <boost/foreach.hpp>
31 #include <boost/algorithm/string/case_conv.hpp>
33 #include <simgear/structure/exception.hxx>
34 #include <simgear/misc/strutils.hxx>
35 #include <simgear/props/tiedpropertylist.hxx>
36 #include <simgear/io/HTTPMemoryRequest.hxx>
37 #include <simgear/timing/sg_time.hxx>
38 #include <simgear/structure/event_mgr.hxx>
39 #include <simgear/structure/commands.hxx>
41 #include "metarproperties.hxx"
42 #include "metarairportfilter.hxx"
43 #include "fgmetar.hxx"
44 #include <Network/HTTPClient.hxx>
45 #include <Main/fg_props.hxx>
47 namespace Environment {
50 /* -------------------------------------------------------------------------------- */
54 /* -------------------------------------------------------------------------------- */
56 class LiveMetarProperties : public MetarProperties {
58 LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge );
59 virtual ~LiveMetarProperties();
60 virtual void update( double dt );
62 virtual double getTimeToLive() const { return _timeToLive; }
63 virtual void resetTimeToLive()
64 { _timeToLive = 0.00; _pollingTimer = 0.0; }
66 // implementation of MetarDataHandler
67 virtual void handleMetarData( const std::string & data );
68 virtual void handleMetarFailure();
70 static const unsigned MAX_POLLING_INTERVAL_SECONDS = 10;
71 static const unsigned DEFAULT_TIME_TO_LIVE_SECONDS = 900;
76 MetarRequester * _metarRequester;
81 typedef SGSharedPtr<LiveMetarProperties> LiveMetarProperties_ptr;
83 class MetarRequester {
85 virtual void requestMetar( LiveMetarProperties_ptr metarDataHandler, const std::string & id ) = 0;
89 LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge ) :
90 MetarProperties( rootNode ),
93 _metarRequester(metarRequester),
97 _tiedProperties.Tie("time-to-live", &_timeToLive );
98 _tiedProperties.Tie("failure", &_failure);
101 LiveMetarProperties::~LiveMetarProperties()
103 _tiedProperties.Untie();
106 void LiveMetarProperties::update( double dt )
110 if( _timeToLive <= 0.0 ) {
113 std::string stationId = getStationId();
114 if( stationId.empty() ) return;
115 if( _pollingTimer > 0.0 ) return;
116 _metarRequester->requestMetar( this, stationId );
117 _pollingTimer = MAX_POLLING_INTERVAL_SECONDS;
121 void LiveMetarProperties::handleMetarData( const std::string & data )
123 SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "LiveMetarProperties::handleMetarData() received METAR for " << getStationId() << ": " << data );
124 _timeToLive = DEFAULT_TIME_TO_LIVE_SECONDS;
126 SGSharedPtr<FGMetar> m;
128 m = new FGMetar(data.c_str());
130 catch( sg_io_exception &) {
131 SG_LOG( SG_ENVIRONMENT, SG_WARN, "Can't parse metar: " << data );
136 if (_maxAge && (m->getAge_min() > _maxAge)) {
137 // METAR is older than max-age, ignore
138 SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "Ignoring outdated METAR for " << getStationId());
146 void LiveMetarProperties::handleMetarFailure()
151 /* -------------------------------------------------------------------------------- */
153 class BasicRealWxController : public RealWxController
156 BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester );
157 virtual ~BasicRealWxController ();
159 virtual void init ();
160 virtual void reinit ();
161 virtual void shutdown ();
164 * Create a metar-property binding at the specified property path,
165 * and initiate a request for the specified station-ID (which may be
166 * empty). If the property path is already mapped, the station ID
169 void addMetarAtPath(const string& propPath, const string& icao);
171 void removeMetarAtPath(const string& propPath);
173 typedef std::vector<LiveMetarProperties_ptr> MetarPropertiesList;
174 MetarPropertiesList::iterator findMetarAtPath(const string &propPath);
178 void update( double dt );
180 void checkNearbyMetar();
182 long getMetarMaxAgeMin() const { return _max_age_n == NULL ? 0 : _max_age_n->getLongValue(); }
184 SGPropertyNode_ptr _rootNode;
185 SGPropertyNode_ptr _ground_elevation_n;
186 SGPropertyNode_ptr _max_age_n;
190 simgear::TiedPropertyList _tiedProperties;
191 MetarPropertiesList _metarProperties;
192 MetarRequester* _requester;
196 static bool commandRequestMetar(const SGPropertyNode* arg)
198 SGSubsystemGroup* envMgr = (SGSubsystemGroup*) globals->get_subsystem("environment");
203 BasicRealWxController* self = (BasicRealWxController*) envMgr->get_subsystem("realwx");
208 string icao(arg->getStringValue("station"));
209 boost::to_upper(icao);
210 string path = arg->getStringValue("path");
211 self->addMetarAtPath(path, icao);
215 static bool commandClearMetar(const SGPropertyNode* arg)
217 SGSubsystemGroup* envMgr = (SGSubsystemGroup*) globals->get_subsystem("environment");
222 BasicRealWxController* self = (BasicRealWxController*) envMgr->get_subsystem("realwx");
227 string path = arg->getStringValue("path");
228 self->removeMetarAtPath(path);
232 /* -------------------------------------------------------------------------------- */
235 ~/enabled: bool Enables/Disables the realwx controller
236 ~/metar[1..n]: string Target property path for metar data
239 BasicRealWxController::BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester ) :
241 _ground_elevation_n( fgGetNode( "/position/ground-elev-m", true )),
242 _max_age_n( fgGetNode( "/environment/params/metar-max-age-min", false ) ),
245 _requester(metarRequester)
248 globals->get_commands()->addCommand("request-metar", commandRequestMetar);
249 globals->get_commands()->addCommand("clear-metar", commandClearMetar);
252 BasicRealWxController::~BasicRealWxController()
254 globals->get_commands()->removeCommand("request-metar");
255 globals->get_commands()->removeCommand("clear-metar");
258 void BasicRealWxController::init()
262 // at least instantiate MetarProperties for /environment/metar
263 SGPropertyNode_ptr metarNode = fgGetNode( _rootNode->getStringValue("metar", "/environment/metar"), true );
264 _metarProperties.push_back( new LiveMetarProperties(metarNode,
266 getMetarMaxAgeMin()));
268 BOOST_FOREACH( SGPropertyNode_ptr n, _rootNode->getChildren("metar") ) {
269 SGPropertyNode_ptr metarNode = fgGetNode( n->getStringValue(), true );
270 addMetarAtPath(metarNode->getPath(), "");
274 update(0); // fetch data ASAP
276 globals->get_event_mgr()->addTask("checkNearbyMetar", this,
277 &BasicRealWxController::checkNearbyMetar, 60 );
280 void BasicRealWxController::reinit()
284 update(0); // fetch data ASAP
287 void BasicRealWxController::shutdown()
289 globals->get_event_mgr()->removeTask("checkNearbyMetar");
292 void BasicRealWxController::bind()
294 _tiedProperties.setRoot( _rootNode );
295 _tiedProperties.Tie( "enabled", &_enabled );
298 void BasicRealWxController::unbind()
300 _tiedProperties.Untie();
303 void BasicRealWxController::update( double dt )
306 bool firstIteration = !_wasEnabled;
307 // clock tick for every METAR in stock
308 BOOST_FOREACH(LiveMetarProperties* p, _metarProperties) {
309 // first round? All received METARs are outdated
310 if( firstIteration ) p->resetTimeToLive();
320 void BasicRealWxController::addMetarAtPath(const string& propPath, const string& icao)
322 // check for duplicate entries
323 MetarPropertiesList::iterator it = findMetarAtPath(propPath);
324 if( it != _metarProperties.end() ) {
325 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Reusing metar properties at " << propPath << " for " << icao);
327 if ((*it)->getStationId() != icao) {
328 (*it)->setStationId(icao);
329 (*it)->resetTimeToLive();
334 SGPropertyNode_ptr metarNode = fgGetNode(propPath, true);
335 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Adding metar properties at " << propPath << " for " << icao);
336 LiveMetarProperties_ptr p(new LiveMetarProperties( metarNode, _requester, getMetarMaxAgeMin() ));
337 _metarProperties.push_back(p);
338 p->setStationId(icao);
341 void BasicRealWxController::removeMetarAtPath(const string &propPath)
343 MetarPropertiesList::iterator it = findMetarAtPath( propPath );
344 if( it != _metarProperties.end() ) {
345 SG_LOG(SG_ENVIRONMENT, SG_INFO, "removing metar properties at " << propPath);
346 _metarProperties.erase(it);
348 SG_LOG(SG_ENVIRONMENT, SG_WARN, "no metar properties at " << propPath);
352 BasicRealWxController::MetarPropertiesList::iterator BasicRealWxController::findMetarAtPath(const string &propPath)
354 // don not compare unprocessed property path
355 // /foo/bar[0]/baz equals /foo/bar/baz
356 SGPropertyNode_ptr n = fgGetNode(propPath,false);
357 if( false == n.valid() ) // trivial: node does not exist
358 return _metarProperties.end();
360 MetarPropertiesList::iterator it = _metarProperties.begin();
361 while( it != _metarProperties.end() &&
362 (*it)->get_root_node()->getPath() != n->getPath() )
368 void BasicRealWxController::checkNearbyMetar()
371 const SGGeod & pos = globals->get_aircraft_position();
373 // check nearest airport
374 SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" );
376 FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() );
377 if( nearestAirport == NULL ) {
378 SG_LOG(SG_ENVIRONMENT,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM" );
382 SG_LOG(SG_ENVIRONMENT, SG_DEBUG,
383 "NoaaMetarRealWxController::update(): nearest airport with METAR is: " << nearestAirport->ident() );
385 // if it has changed, invalidate the associated METAR
386 if( _metarProperties[0]->getStationId() != nearestAirport->ident() ) {
387 SG_LOG(SG_ENVIRONMENT, SG_INFO,
388 "NoaaMetarRealWxController::update(): nearest airport with METAR has changed. Old: '" <<
389 _metarProperties[0]->getStationId() <<
390 "', new: '" << nearestAirport->ident() << "'" );
391 _metarProperties[0]->setStationId( nearestAirport->ident() );
392 _metarProperties[0]->resetTimeToLive();
395 catch( sg_exception & ) {
401 /* -------------------------------------------------------------------------------- */
403 class NoaaMetarRealWxController : public BasicRealWxController, MetarRequester {
405 NoaaMetarRealWxController( SGPropertyNode_ptr rootNode );
407 // implementation of MetarRequester
408 virtual void requestMetar( LiveMetarProperties_ptr metarDataHandler, const std::string & id );
410 virtual ~NoaaMetarRealWxController()
417 NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ) :
418 BasicRealWxController(rootNode, this )
422 void NoaaMetarRealWxController::requestMetar
424 LiveMetarProperties_ptr metarDataHandler,
425 const std::string& id
428 static const std::string NOAA_BASE_URL =
429 "http://weather.noaa.gov/pub/data/observations/metar/stations/";
430 class NoaaMetarGetRequest:
431 public simgear::HTTP::MemoryRequest
434 NoaaMetarGetRequest( LiveMetarProperties_ptr metarDataHandler,
435 const std::string& stationId ):
436 MemoryRequest(NOAA_BASE_URL + stationId + ".TXT"),
437 _metarDataHandler(metarDataHandler)
439 std::ostringstream buf;
440 buf << globals->get_time_params()->get_cur_time();
441 requestHeader("X-TIME") = buf.str();
444 virtual void onDone()
446 if( responseCode() != 200 )
452 "metar download failed:" << url() << ": reason:" << responseReason()
457 _metarDataHandler->handleMetarData
459 simgear::strutils::simplify(responseBody())
463 virtual void onFail()
465 SG_LOG(SG_ENVIRONMENT, SG_INFO, "metar download failure");
466 _metarDataHandler->handleMetarFailure();
470 LiveMetarProperties_ptr _metarDataHandler;
473 string upperId = boost::to_upper_copy(id);
479 "NoaaMetarRealWxController::update(): "
480 "spawning load request for station-id '" << upperId << "'"
482 FGHTTPClient* http = static_cast<FGHTTPClient*>(globals->get_subsystem("http"));
484 http->makeRequest(new NoaaMetarGetRequest(metarDataHandler, upperId));
488 /* -------------------------------------------------------------------------------- */
490 RealWxController * RealWxController::createInstance( SGPropertyNode_ptr rootNode )
492 return new NoaaMetarRealWxController( rootNode );
495 RealWxController::~RealWxController()
499 /* -------------------------------------------------------------------------------- */
501 } // namespace Environment