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 /* -------------------------------------------------------------------------------- */
52 class MetarDataHandler {
54 virtual void handleMetarData( const std::string & data ) = 0;
55 virtual void handleMetarFailure() = 0;
58 class MetarRequester {
60 virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id ) = 0;
63 /* -------------------------------------------------------------------------------- */
65 class LiveMetarProperties : public MetarProperties, MetarDataHandler {
67 LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge );
68 virtual ~LiveMetarProperties();
69 virtual void update( double dt );
71 virtual double getTimeToLive() const { return _timeToLive; }
72 virtual void resetTimeToLive()
73 { _timeToLive = 0.00; _pollingTimer = 0.0; }
75 // implementation of MetarDataHandler
76 virtual void handleMetarData( const std::string & data );
77 virtual void handleMetarFailure();
79 static const unsigned MAX_POLLING_INTERVAL_SECONDS = 10;
80 static const unsigned DEFAULT_TIME_TO_LIVE_SECONDS = 900;
85 MetarRequester * _metarRequester;
90 typedef SGSharedPtr<LiveMetarProperties> LiveMetarProperties_ptr;
92 LiveMetarProperties::LiveMetarProperties( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester, int maxAge ) :
93 MetarProperties( rootNode ),
96 _metarRequester(metarRequester),
100 _tiedProperties.Tie("time-to-live", &_timeToLive );
101 _tiedProperties.Tie("failure", &_failure);
104 LiveMetarProperties::~LiveMetarProperties()
106 _tiedProperties.Untie();
109 void LiveMetarProperties::update( double dt )
113 if( _timeToLive <= 0.0 ) {
115 std::string stationId = getStationId();
116 if( stationId.empty() ) return;
117 if( _pollingTimer > 0.0 ) return;
118 _metarRequester->requestMetar( this, stationId );
119 _pollingTimer = MAX_POLLING_INTERVAL_SECONDS;
123 void LiveMetarProperties::handleMetarData( const std::string & data )
125 SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "LiveMetarProperties::handleMetarData() received METAR for " << getStationId() << ": " << data );
126 _timeToLive = DEFAULT_TIME_TO_LIVE_SECONDS;
128 SGSharedPtr<FGMetar> m;
130 m = new FGMetar(data.c_str());
132 catch( sg_io_exception ) {
133 SG_LOG( SG_ENVIRONMENT, SG_WARN, "Can't parse metar: " << data );
138 if (_maxAge && (m->getAge_min() > _maxAge)) {
139 // METAR is older than max-age, ignore
140 SG_LOG( SG_ENVIRONMENT, SG_DEBUG, "Ignoring outdated METAR for " << getStationId());
148 void LiveMetarProperties::handleMetarFailure()
153 /* -------------------------------------------------------------------------------- */
155 class BasicRealWxController : public RealWxController
158 BasicRealWxController( SGPropertyNode_ptr rootNode, MetarRequester * metarRequester );
159 virtual ~BasicRealWxController ();
161 virtual void init ();
162 virtual void reinit ();
163 virtual void shutdown ();
166 * Create a metar-property binding at the specified property path,
167 * and initiate a request for the specified station-ID (which may be
168 * empty). If the property path is already mapped, the station ID
171 void addMetarAtPath(const string& propPath, const string& icao);
173 void removeMetarAtPath(const string& propPath);
177 void update( double dt );
179 void checkNearbyMetar();
181 long getMetarMaxAgeMin() const { return _max_age_n == NULL ? 0 : _max_age_n->getLongValue(); }
183 SGPropertyNode_ptr _rootNode;
184 SGPropertyNode_ptr _ground_elevation_n;
185 SGPropertyNode_ptr _max_age_n;
189 simgear::TiedPropertyList _tiedProperties;
190 typedef std::vector<LiveMetarProperties_ptr> MetarPropertiesList;
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 BOOST_FOREACH( LiveMetarProperties_ptr p, _metarProperties ) {
324 if( p->get_root_node()->getPath() == propPath ) {
326 if (p->getStationId() != icao) {
327 p->setStationId(icao);
328 p->resetTimeToLive();
333 } // of exitsing metar properties iteration
335 SGPropertyNode_ptr metarNode = fgGetNode(propPath, true);
336 SG_LOG( SG_ENVIRONMENT, SG_INFO, "Adding metar properties at " << propPath );
337 LiveMetarProperties_ptr p(new LiveMetarProperties( metarNode, _requester, getMetarMaxAgeMin() ));
338 _metarProperties.push_back(p);
339 p->setStationId(icao);
342 void BasicRealWxController::removeMetarAtPath(const string &propPath)
344 MetarPropertiesList::iterator it = _metarProperties.begin();
345 for (; it != _metarProperties.end(); ++it) {
346 LiveMetarProperties_ptr p(*it);
347 if( p->get_root_node()->getPath() == propPath ) {
348 _metarProperties.erase(it);
349 // final ref will drop, and delete the MetarProperties, when we return
354 SG_LOG(SG_ENVIRONMENT, SG_WARN, "no metar properties at " << propPath);
357 void BasicRealWxController::checkNearbyMetar()
360 const SGGeod & pos = globals->get_aircraft_position();
362 // check nearest airport
363 SG_LOG(SG_ENVIRONMENT, SG_DEBUG, "NoaaMetarRealWxController::update(): (re) checking nearby airport with METAR" );
365 FGAirport * nearestAirport = FGAirport::findClosest(pos, 10000.0, MetarAirportFilter::instance() );
366 if( nearestAirport == NULL ) {
367 SG_LOG(SG_ENVIRONMENT,SG_WARN,"RealWxController::update can't find airport with METAR within 10000NM" );
371 SG_LOG(SG_ENVIRONMENT, SG_DEBUG,
372 "NoaaMetarRealWxController::update(): nearest airport with METAR is: " << nearestAirport->ident() );
374 // if it has changed, invalidate the associated METAR
375 if( _metarProperties[0]->getStationId() != nearestAirport->ident() ) {
376 SG_LOG(SG_ENVIRONMENT, SG_INFO,
377 "NoaaMetarRealWxController::update(): nearest airport with METAR has changed. Old: '" <<
378 _metarProperties[0]->getStationId() <<
379 "', new: '" << nearestAirport->ident() << "'" );
380 _metarProperties[0]->setStationId( nearestAirport->ident() );
381 _metarProperties[0]->resetTimeToLive();
384 catch( sg_exception & ) {
390 /* -------------------------------------------------------------------------------- */
392 class NoaaMetarRealWxController : public BasicRealWxController, MetarRequester {
394 NoaaMetarRealWxController( SGPropertyNode_ptr rootNode );
396 // implementation of MetarRequester
397 virtual void requestMetar( MetarDataHandler * metarDataHandler, const std::string & id );
399 virtual ~NoaaMetarRealWxController()
406 NoaaMetarRealWxController::NoaaMetarRealWxController( SGPropertyNode_ptr rootNode ) :
407 BasicRealWxController(rootNode, this )
411 void NoaaMetarRealWxController::requestMetar
413 MetarDataHandler* metarDataHandler,
414 const std::string& id
417 static const std::string NOAA_BASE_URL =
418 "http://weather.noaa.gov/pub/data/observations/metar/stations/";
419 class NoaaMetarGetRequest:
420 public simgear::HTTP::MemoryRequest
423 NoaaMetarGetRequest( MetarDataHandler* metarDataHandler,
424 const std::string& stationId ):
425 MemoryRequest(NOAA_BASE_URL + stationId + ".TXT"),
426 _metarDataHandler(metarDataHandler)
428 std::ostringstream buf;
429 buf << globals->get_time_params()->get_cur_time();
430 requestHeader("X-TIME") = buf.str();
433 virtual void onDone()
435 if( responseCode() != 200 )
441 "metar download failed:" << url() << ": reason:" << responseReason()
446 _metarDataHandler->handleMetarData
448 simgear::strutils::simplify(responseBody())
452 virtual void onFail()
454 SG_LOG(SG_ENVIRONMENT, SG_INFO, "metar download failure");
455 _metarDataHandler->handleMetarFailure();
459 MetarDataHandler * _metarDataHandler;
462 string upperId = boost::to_upper_copy(id);
468 "NoaaMetarRealWxController::update(): "
469 "spawning load request for station-id '" << upperId << "'"
471 FGHTTPClient* http = static_cast<FGHTTPClient*>(globals->get_subsystem("http"));
473 http->makeRequest(new NoaaMetarGetRequest(metarDataHandler, upperId));
477 /* -------------------------------------------------------------------------------- */
479 RealWxController * RealWxController::createInstance( SGPropertyNode_ptr rootNode )
481 return new NoaaMetarRealWxController( rootNode );
484 RealWxController::~RealWxController()
488 /* -------------------------------------------------------------------------------- */
490 } // namespace Environment