src/FDM/ExternalNet.cxx

   1 // ExternalNet.hxx -- an net interface to an external flight dynamics model
   2 //
   3 // Written by Curtis Olson, started November 2001.
   4 //
   5 // Copyright (C) 2001  Curtis L. Olson  - curt@flightgear.org
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23 #include <simgear/debug/logstream.hxx>
  24 #include <simgear/io/lowlevel.hxx> // endian tests
  25
  26 #include <Main/fg_props.hxx>
  27
  28 #include "ExternalNet.hxx"
  29
  30
  31 // FreeBSD works better with this included last ... (?)
  32 #if defined(WIN32) && !defined(__CYGWIN__)
  33 #  include <windows.h>
  34 #else
  35 #  include <netinet/in.h>       // htonl() ntohl()
  36 #endif
  37
  38
  39 // The function htond is defined this way due to the way some
  40 // processors and OSes treat floating point values.  Some will raise
  41 // an exception whenever a "bad" floating point value is loaded into a
  42 // floating point register.  Solaris is notorious for this, but then
  43 // so is LynxOS on the PowerPC.  By translating the data in place,
  44 // there is no need to load a FP register with the "corruped" floating
  45 // point value.  By doing the BIG_ENDIAN test, I can optimize the
  46 // routine for big-endian processors so it can be as efficient as
  47 // possible
  48 static void htond (double &x)
  49 {
  50     if ( sgIsLittleEndian() ) {
  51         int    *Double_Overlay;
  52         int     Holding_Buffer;
  53
  54         Double_Overlay = (int *) &x;
  55         Holding_Buffer = Double_Overlay [0];
  56
  57         Double_Overlay [0] = htonl (Double_Overlay [1]);
  58         Double_Overlay [1] = htonl (Holding_Buffer);
  59     } else {
  60         return;
  61     }
  62 }
  63
  64
  65 static void global2raw( FGRawCtrls *raw ) {
  66     int i;
  67
  68     // fill in values
  69     SGPropertyNode * node = fgGetNode("/controls", true);
  70     raw->version = FG_RAW_CTRLS_VERSION;
  71     raw->aileron = node->getDoubleValue( "aileron" );
  72     raw->elevator = node->getDoubleValue( "elevator" );
  73     raw->elevator_trim = node->getDoubleValue( "elevator-trim" );
  74     raw->rudder = node->getDoubleValue( "rudder" );
  75     raw->flaps = node->getDoubleValue( "flaps" );
  76     for ( i = 0; i < FGRawCtrls::FG_MAX_ENGINES; ++i ) {
  77         raw->throttle[i] = node->getDoubleValue( "throttle", 0.0 );
  78         raw->mixture[i] = node->getDoubleValue( "mixture", 0.0 );
  79         raw->prop_advance[i] = node->getDoubleValue( "propeller-pitch", 0.0 );
  80         raw->magnetos[i] = node->getIntValue( "magnetos", 0 );
  81         if ( i == 0 ) {
  82           // cout << "Magnetos -> " << node->getIntValue( "magnetos", 0 );
  83         }
  84         raw->starter[i] = node->getBoolValue( "starter", false );
  85         if ( i == 0 ) {
  86           // cout << " Starter -> " << node->getIntValue( "stater", false )
  87           //      << endl;
  88         }
  89     }
  90     for ( i = 0; i < FGRawCtrls::FG_MAX_WHEELS; ++i ) {
  91         raw->brake[i] = node->getDoubleValue( "brakes", 0.0 );
  92     }
  93     raw->hground = fgGetDouble( "/environment/ground-elevation-m" );
  94     raw->magvar = fgGetDouble("/environment/magnetic-variation-deg");
  95     raw->speedup = fgGetInt("/sim/speed-up");
  96
  97     // convert to network byte order
  98     raw->version = htonl(raw->version);
  99     htond(raw->aileron);
 100     htond(raw->elevator);
 101     htond(raw->elevator_trim);
 102     htond(raw->rudder);
 103     htond(raw->flaps);
 104     for ( i = 0; i < FGRawCtrls::FG_MAX_ENGINES; ++i ) {
 105         htond(raw->throttle[i]);
 106         htond(raw->mixture[i]);
 107         htond(raw->prop_advance[i]);
 108         htonl(raw->magnetos[i]);
 109         htonl(raw->starter[i]);
 110     }
 111     for ( i = 0; i < FGRawCtrls::FG_MAX_WHEELS; ++i ) {
 112         htond(raw->brake[i]);
 113     }
 114     htond(raw->hground);
 115     htond(raw->magvar);
 116     raw->speedup = htonl(raw->speedup);
 117 }
 118
 119
 120 static void net2global( FGNetFDM *net ) {
 121     int i;
 122
 123     // Convert to the net buffer from network format
 124     net->version = ntohl(net->version);
 125
 126     htond(net->longitude);
 127     htond(net->latitude);
 128     htond(net->altitude);
 129     htond(net->phi);
 130     htond(net->theta);
 131     htond(net->psi);
 132
 133     htond(net->phidot);
 134     htond(net->thetadot);
 135     htond(net->psidot);
 136     htond(net->vcas);
 137     htond(net->climb_rate);
 138
 139     htond(net->A_X_pilot);
 140     htond(net->A_Y_pilot);
 141     htond(net->A_Z_pilot);
 142
 143     net->num_engines = htonl(net->num_engines);
 144     for ( i = 0; i < net->num_engines; ++i ) {
 145         htonl(net->eng_state[i]);
 146         htond(net->rpm[i]);
 147         htond(net->fuel_flow[i]);
 148         htond(net->EGT[i]);
 149         htond(net->oil_temp[i]);
 150         htond(net->oil_px[i]);
 151     }
 152
 153     net->num_tanks = htonl(net->num_tanks);
 154     for ( i = 0; i < net->num_tanks; ++i ) {
 155         htond(net->fuel_quantity[i]);
 156     }
 157
 158     net->num_wheels = htonl(net->num_wheels);
 159     // I don't need to convert the Wow flags, since they are one byte in size
 160     htond(net->flap_deflection);
 161
 162     net->cur_time = ntohl(net->cur_time);
 163     net->warp = ntohl(net->warp);
 164     htond(net->visibility);
 165
 166     if ( net->version == FG_NET_FDM_VERSION ) {
 167         // cout << "pos = " << net->longitude << " " << net->latitude << endl;
 168         // cout << "sea level rad = " << cur_fdm_state->get_Sea_level_radius()
 169         //      << endl;
 170         cur_fdm_state->_updateGeodeticPosition( net->latitude,
 171                                                 net->longitude,
 172                                                 net->altitude
 173                                                   * SG_METER_TO_FEET );
 174         cur_fdm_state->_set_Euler_Angles( net->phi,
 175                                           net->theta,
 176                                           net->psi );
 177         cur_fdm_state->_set_Euler_Rates( net->phidot,
 178                                          net->thetadot,
 179                                          net->psidot );
 180         cur_fdm_state->_set_V_calibrated_kts( net->vcas );
 181         cur_fdm_state->_set_Climb_Rate( net->climb_rate );
 182         cur_fdm_state->_set_Accels_Pilot_Body( net->A_X_pilot,
 183                                                net->A_Y_pilot,
 184                                                net->A_Z_pilot );
 185
 186         for ( i = 0; i < net->num_engines; ++i ) {
 187             SGPropertyNode *node = fgGetNode( "engines/engine", i, true );
 188
 189             // node->setBoolValue("running", t->isRunning());
 190             // node->setBoolValue("cranking", t->isCranking());
 191
 192             // cout << net->eng_state[i] << endl;
 193             if ( net->eng_state[i] == 0 ) {
 194                 node->setBoolValue( "cranking", false );
 195                 node->setBoolValue( "running", false );
 196             } else if ( net->eng_state[i] == 1 ) {
 197                 node->setBoolValue( "cranking", true );
 198                 node->setBoolValue( "running", false );
 199             } else if ( net->eng_state[i] == 2 ) {
 200                 node->setBoolValue( "cranking", false );
 201                 node->setBoolValue( "running", true );
 202             }
 203
 204             node->setDoubleValue( "rpm", net->rpm[i] );
 205             node->setDoubleValue( "fuel-flow-gph", net->fuel_flow[i] );
 206             node->setDoubleValue( "egt-degf", net->EGT[i] );
 207             node->setDoubleValue( "oil-temperature-degf", net->oil_temp[i] );
 208             node->setDoubleValue( "oil-pressure-psi", net->oil_px[i] );
 209         }
 210
 211         for (i = 0; i < net->num_tanks; ++i ) {
 212             SGPropertyNode * node
 213                 = fgGetNode("/consumables/fuel/tank", i, true);
 214             node->setDoubleValue("level-gal_us", net->fuel_quantity[i] );
 215         }
 216
 217         for (i = 0; i < net->num_wheels; ++i ) {
 218             SGPropertyNode * node
 219                 = fgGetNode("/gear/gear", i, true);
 220             node->setDoubleValue("wow", net->wow[i] );
 221         }
 222
 223         fgSetDouble("/surface-positions/flap-pos-norm", net->flap_deflection);
 224         SGPropertyNode * node = fgGetNode("/controls", true);
 225         fgSetDouble("/surface-positions/elevator-pos-norm",
 226                     node->getDoubleValue( "elevator" ));
 227         fgSetDouble("/surface-positions/rudder-pos-norm",
 228                     node->getDoubleValue( "rudder" ));
 229         fgSetDouble("/surface-positions/left-aileron-pos-norm",
 230                     node->getDoubleValue( "aileron" ));
 231         fgSetDouble("/surface-positions/right-aileron-pos-norm",
 232                     -node->getDoubleValue( "aileron" ));
 233
 234         /* these are ignored for now  ... */
 235         /*
 236         if ( net->cur_time ) {
 237             fgSetLong("/sim/time/cur-time-override", net->cur_time);
 238         }
 239
 240         globals->set_warp( net->warp );
 241         last_warp = net->warp;
 242         */
 243     } else {
 244         SG_LOG( SG_IO, SG_ALERT, "Error: version mismatch in net2global()" );
 245         SG_LOG( SG_IO, SG_ALERT,
 246                 "\tread " << net->version << " need " << FG_NET_FDM_VERSION );
 247         SG_LOG( SG_IO, SG_ALERT,
 248                 "\tsomeone needs to upgrade net_fdm.hxx and recompile." );
 249     }
 250 }
 251
 252
 253 FGExternalNet::FGExternalNet( double dt, string host, int dop, int dip, int cp )
 254 {
 255 //     set_delta_t( dt );
 256
 257     valid = true;
 258
 259     data_in_port = dip;
 260     data_out_port = dop;
 261     cmd_port = cp;
 262     fdm_host = host;
 263
 264     /////////////////////////////////////////////////////////
 265     // Setup client udp connection (sends data to remote fdm)
 266
 267     if ( ! data_client.open( false ) ) {
 268         SG_LOG( SG_FLIGHT, SG_ALERT, "Error opening client data channel" );
 269         valid = false;
 270     }
 271
 272     // fire and forget
 273     data_client.setBlocking( false );
 274
 275     if ( data_client.connect( fdm_host.c_str(), data_out_port ) == -1 ) {
 276         printf("error connecting to %s:%d\n", fdm_host.c_str(), data_out_port);
 277         valid = false;
 278     }
 279
 280     /////////////////////////////////////////////////////////
 281     // Setup server udp connection (for receiving data)
 282
 283     if ( ! data_server.open( false ) ) {
 284         SG_LOG( SG_FLIGHT, SG_ALERT, "Error opening client server channel" );
 285         valid = false;
 286     }
 287
 288     // we want to block for incoming data in order to syncronize frame
 289     // rates.
 290     data_server.setBlocking( false /* don't block while testing */ );
 291     // data_server.setBlocking( true /* don't block while testing */ );
 292
 293     // if we bind to fdm_host = "" then we accept messages from
 294     // anyone.
 295     if ( data_server.bind( fdm_host.c_str(), data_in_port ) == -1 ) {
 296         printf("error binding to port %d\n", data_in_port);
 297         valid = false;
 298     }
 299 }
 300
 301
 302 FGExternalNet::~FGExternalNet() {
 303     data_client.close();
 304     data_server.close();
 305 }
 306
 307
 308 // Initialize the ExternalNet flight model, dt is the time increment
 309 // for each subsequent iteration through the EOM
 310 void FGExternalNet::init() {
 311     // cout << "FGExternalNet::init()" << endl;
 312
 313     // Explicitly call the superclass's
 314     // init method first.
 315     common_init();
 316
 317     double lon = fgGetDouble( "/position/longitude-deg" );
 318     double lat = fgGetDouble( "/position/latitude-deg" );
 319     double ground = fgGetDouble( "/environment/ground-elevation-m" );
 320     double heading = fgGetDouble("/orientation/heading-deg");
 321
 322     char cmd[256];
 323
 324     sprintf( cmd, "/longitude-deg?value=%.8f", lon );
 325     new HTTPClient( fdm_host.c_str(), cmd_port, cmd );
 326 //     cout << "before loop()" << endl;
 327     netChannel::loop(0);
 328 //     cout << "here" << endl;
 329
 330     sprintf( cmd, "/latitude-deg?value=%.8f", lat );
 331     new HTTPClient( fdm_host.c_str(), cmd_port, cmd );
 332     netChannel::loop(0);
 333
 334     sprintf( cmd, "/ground-m?value=%.8f", ground );
 335     new HTTPClient( fdm_host.c_str(), cmd_port, cmd );
 336     netChannel::loop(0);
 337
 338     sprintf( cmd, "/heading-deg?value=%.8f", heading );
 339     new HTTPClient( fdm_host.c_str(), cmd_port, cmd );
 340     netChannel::loop(0);
 341
 342     sprintf( cmd, "/reset?value=ground" );
 343     new HTTPClient( fdm_host.c_str(), cmd_port, cmd );
 344     netChannel::loop(0);
 345 }
 346
 347
 348 // Run an iteration of the EOM.
 349 void FGExternalNet::update( double dt ) {
 350     int length;
 351     int result;
 352
 353     if (is_suspended())
 354       return;
 355
 356     // Send control positions to remote fdm
 357     length = sizeof(ctrls);
 358     global2raw( &ctrls );
 359     if ( data_client.send( (char *)(& ctrls), length, 0 ) != length ) {
 360         SG_LOG( SG_IO, SG_ALERT, "Error writing data." );
 361     }
 362
 363     // Read next set of FDM data (blocking enabled to maintain 'sync')
 364     length = sizeof(fdm);
 365     while ( (result = data_server.recv( (char *)(& fdm), length, 0)) >= 0 ) {
 366         SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 367         net2global( &fdm );
 368     }
 369 }