src/Network/native_ctrls.cxx

   1 // native_ctrls.cxx -- FGFS "Native" controls I/O class
   2 //
   3 // Written by Curtis Olson, started July 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
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/debug/logstream.hxx>
  29 #include <simgear/io/iochannel.hxx>
  30 #include <simgear/io/lowlevel.hxx> // endian tests
  31
  32 #include <FDM/flight.hxx>
  33 #include <Main/fg_props.hxx>
  34 #include <Scenery/scenery.hxx>  // ground elevation
  35
  36 #include "native_ctrls.hxx"
  37
  38 // FreeBSD works better with this included last ... (?)
  39 #if defined(WIN32) && !defined(__CYGWIN__)
  40 #  include <windows.h>
  41 #else
  42 #  include <netinet/in.h>       // htonl() ntohl()
  43 #endif
  44
  45
  46 FGNativeCtrls::FGNativeCtrls() {
  47 }
  48
  49 FGNativeCtrls::~FGNativeCtrls() {
  50 }
  51
  52
  53 // open hailing frequencies
  54 bool FGNativeCtrls::open() {
  55     if ( is_enabled() ) {
  56         SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel "
  57                 << "is already in use, ignoring" );
  58         return false;
  59     }
  60
  61     SGIOChannel *io = get_io_channel();
  62
  63     if ( ! io->open( get_direction() ) ) {
  64         SG_LOG( SG_IO, SG_ALERT, "Error opening channel communication layer." );
  65         return false;
  66     }
  67
  68     set_enabled( true );
  69
  70     return true;
  71 }
  72
  73
  74 // The function htond is defined this way due to the way some
  75 // processors and OSes treat floating point values.  Some will raise
  76 // an exception whenever a "bad" floating point value is loaded into a
  77 // floating point register.  Solaris is notorious for this, but then
  78 // so is LynxOS on the PowerPC.  By translating the data in place,
  79 // there is no need to load a FP register with the "corruped" floating
  80 // point value.  By doing the BIG_ENDIAN test, I can optimize the
  81 // routine for big-endian processors so it can be as efficient as
  82 // possible
  83 static void htond (double &x)
  84 {
  85     if ( sgIsLittleEndian() ) {
  86         int    *Double_Overlay;
  87         int     Holding_Buffer;
  88
  89         Double_Overlay = (int *) &x;
  90         Holding_Buffer = Double_Overlay [0];
  91
  92         Double_Overlay [0] = htonl (Double_Overlay [1]);
  93         Double_Overlay [1] = htonl (Holding_Buffer);
  94     } else {
  95         return;
  96     }
  97 }
  98
  99
 100 // Populate the FGNetCtrls structure from the property tree.
 101 void FGProps2NetCtrls( FGNetCtrls *net, bool honor_freezes,
 102                        bool net_byte_order )
 103 {
 104     int i;
 105     SGPropertyNode *node;
 106     SGPropertyNode *starter;
 107     SGPropertyNode *fuelpump;
 108     SGPropertyNode *tempnode;
 109
 110     // fill in values
 111     node  = fgGetNode("/controls/flight", true);
 112     net->version = FG_NET_CTRLS_VERSION;
 113     net->aileron = node->getDoubleValue( "aileron" );
 114     net->elevator = node->getDoubleValue( "elevator" );
 115     net->elevator_trim = node->getDoubleValue( "elevator-trim" );
 116     net->rudder = node->getDoubleValue( "rudder" );
 117     net->flaps = node->getDoubleValue( "flaps" );
 118     net->flaps_power
 119         = fgGetDouble( "/systems/electrical/outputs/flaps", 1.0 ) >= 1.0;
 120     net->flap_motor_ok = node->getBoolValue( "flaps-serviceable" );
 121
 122     net->num_engines = FGNetCtrls::FG_MAX_ENGINES;
 123     for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
 124         // Controls
 125         node = fgGetNode("/controls/engines/engine", i );
 126         starter = fgGetNode("/systems/electrical/outputs/starter", i );
 127         fuelpump = fgGetNode("/systems/electrical/outputs/fuel-pump", i );
 128
 129         tempnode = node->getChild("master-bat");
 130         if ( tempnode != NULL ) {
 131             net->master_bat[i] = tempnode->getBoolValue();
 132         }
 133         tempnode = node->getChild("master-alt");
 134         if ( tempnode != NULL ) {
 135             net->master_alt[i] = tempnode->getBoolValue();
 136         }
 137
 138         net->throttle[i] = node->getDoubleValue( "throttle", 0.0 );
 139         net->mixture[i] = node->getDoubleValue( "mixture", 0.0 );
 140         net->prop_advance[i] = node->getDoubleValue( "propeller-pitch", 0.0 );
 141         net->condition[i] = node->getDoubleValue( "condition", 0.0 );
 142         net->magnetos[i] = node->getIntValue( "magnetos", 0 );
 143         if ( i == 0 ) {
 144           // cout << "Magnetos -> " << node->getIntValue( "magnetos", 0 );
 145         }
 146         if ( i == 0 ) {
 147           // cout << "Starter -> " << node->getIntValue( "starter", false )
 148           //      << endl;
 149         }
 150
 151         if ( fuelpump != NULL ) {
 152             net->fuel_pump_power[i] = ( fuelpump->getDoubleValue() >= 1.0 );
 153         } else {
 154             net->fuel_pump_power[i] = 0.0;
 155         }
 156
 157         if ( starter != NULL ) {
 158             net->starter_power[i] = ( starter->getDoubleValue() >= 1.0 );
 159         } else {
 160             net->starter_power[i] = 0.0;
 161         }
 162
 163         // Faults
 164         SGPropertyNode *faults = node->getChild( "faults", 0, true );
 165         net->engine_ok[i] = faults->getBoolValue( "serviceable", true );
 166         net->mag_left_ok[i]
 167           = faults->getBoolValue( "left-magneto-serviceable", true );
 168         net->mag_right_ok[i]
 169           = faults->getBoolValue( "right-magneto-serviceable", true);
 170         net->spark_plugs_ok[i]
 171           = faults->getBoolValue( "spark-plugs-serviceable", true );
 172         net->oil_press_status[i]
 173           = faults->getIntValue( "oil-pressure-status", 0 );
 174         net->fuel_pump_ok[i]
 175           = faults->getBoolValue( "fuel-pump-serviceable", true );
 176     }
 177     net->num_tanks = FGNetCtrls::FG_MAX_TANKS;
 178     for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
 179         node = fgGetNode("/controls/fuel/tank", i);
 180         if ( node->getChild("fuel_selector") != 0 ) {
 181             net->fuel_selector[i]
 182                 = node->getChild("fuel_selector")->getBoolValue();
 183         } else {
 184             net->fuel_selector[i] = false;
 185         }
 186     }
 187     node = fgGetNode("/controls/gear", true);
 188     net->brake_left = node->getChild("brake-left")->getDoubleValue();
 189     net->brake_right = node->getChild("brake-right")->getDoubleValue();
 190     net->copilot_brake_left
 191         = node->getChild("copilot-brake-left")->getDoubleValue();
 192     net->copilot_brake_right
 193         = node->getChild("copilot-brake-right")->getDoubleValue();
 194     net->brake_parking = node->getChild("brake-parking")->getDoubleValue();
 195
 196     net->gear_handle = fgGetBool( "controls/gear/gear-down" );
 197
 198     tempnode = node->getChild("master-avionics");
 199     if ( tempnode != NULL ) {
 200         net->master_avionics = tempnode->getBoolValue();
 201     }
 202
 203     net->wind_speed_kt = fgGetDouble("/environment/wind-speed-kt");
 204     net->wind_dir_deg = fgGetDouble("/environment/wind-from-heading-deg");
 205     net->turbulence_norm =
 206         fgGetDouble("/environment/turbulence/magnitude-norm");
 207
 208     net->temp_c = fgGetDouble("/environment/temperature-degc");
 209     net->press_inhg = fgGetDouble("/environment/pressure-sea-level-inhg");
 210
 211     // cur_fdm_state->get_ground_elev_ft() is what we want ... this
 212     // reports the altitude of the aircraft.
 213     // "/environment/ground-elevation-m" reports the ground elevation
 214     // of the current view point which could change substantially if
 215     // the user is switching views.
 216     net->hground = cur_fdm_state->get_ground_elev_ft() * SG_FEET_TO_METER;
 217     net->magvar = fgGetDouble("/environment/magnetic-variation-deg");
 218
 219     net->icing = fgGetDouble("/hazards/icing/wing");
 220
 221     net->speedup = fgGetInt("/sim/speed-up");
 222     net->freeze = 0;
 223     if ( honor_freezes ) {
 224         if ( fgGetBool("/sim/freeze/master") ) {
 225             net->freeze |= 0x01;
 226         }
 227         if ( fgGetBool("/sim/freeze/position") ) {
 228             net->freeze |= 0x02;
 229         }
 230         if ( fgGetBool("/sim/freeze/fuel") ) {
 231             net->freeze |= 0x04;
 232         }
 233     }
 234
 235     if ( net_byte_order ) {
 236         // convert to network byte order
 237         net->version = htonl(net->version);
 238         htond(net->aileron);
 239         htond(net->elevator);
 240         htond(net->elevator_trim);
 241         htond(net->rudder);
 242         htond(net->flaps);
 243         net->flaps_power = htonl(net->flaps_power);
 244         net->flap_motor_ok = htonl(net->flap_motor_ok);
 245         for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
 246             net->master_bat[i] = htonl(net->master_bat[i]);
 247             net->master_alt[i] = htonl(net->master_alt[i]);
 248             net->magnetos[i] = htonl(net->magnetos[i]);
 249             net->starter_power[i] = htonl(net->starter_power[i]);
 250             htond(net->throttle[i]);
 251             htond(net->mixture[i]);
 252             net->fuel_pump_power[i] = htonl(net->fuel_pump_power[i]);
 253             htond(net->prop_advance[i]);
 254             htond(net->condition[i]);
 255             net->engine_ok[i] = htonl(net->engine_ok[i]);
 256             net->mag_left_ok[i] = htonl(net->mag_left_ok[i]);
 257             net->mag_right_ok[i] = htonl(net->mag_right_ok[i]);
 258             net->spark_plugs_ok[i] = htonl(net->spark_plugs_ok[i]);
 259             net->oil_press_status[i] = htonl(net->oil_press_status[i]);
 260             net->fuel_pump_ok[i] = htonl(net->fuel_pump_ok[i]);
 261         }
 262         net->num_engines = htonl(net->num_engines);
 263         for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
 264             net->fuel_selector[i] = htonl(net->fuel_selector[i]);
 265         }
 266         net->num_tanks = htonl(net->num_tanks);
 267         htond(net->brake_left);
 268         htond(net->brake_right);
 269         htond(net->copilot_brake_left);
 270         htond(net->copilot_brake_right);
 271         htond(net->brake_parking);
 272         net->gear_handle = htonl(net->gear_handle);
 273         net->master_avionics = htonl(net->master_avionics);
 274         htond(net->wind_speed_kt);
 275         htond(net->wind_dir_deg);
 276         htond(net->turbulence_norm);
 277         htond(net->temp_c);
 278         htond(net->press_inhg);
 279         htond(net->hground);
 280         htond(net->magvar);
 281         net->icing = htonl(net->icing);
 282         net->speedup = htonl(net->speedup);
 283         net->freeze = htonl(net->freeze);
 284     }
 285 }
 286
 287
 288 // Update the property tree from the FGNetCtrls structure.
 289 void FGNetCtrls2Props( FGNetCtrls *net, bool honor_freezes,
 290                        bool net_byte_order )
 291 {
 292     int i;
 293
 294     SGPropertyNode * node;
 295
 296     if ( net_byte_order ) {
 297         // convert from network byte order
 298         net->version = htonl(net->version);
 299         htond(net->aileron);
 300         htond(net->elevator);
 301         htond(net->elevator_trim);
 302         htond(net->rudder);
 303         htond(net->flaps);
 304         net->flaps_power = htonl(net->flaps_power);
 305         net->flap_motor_ok = htonl(net->flap_motor_ok);
 306         net->num_engines = htonl(net->num_engines);
 307         for ( i = 0; i < net->num_engines; ++i ) {
 308             net->master_bat[i] = htonl(net->master_bat[i]);
 309             net->master_alt[i] = htonl(net->master_alt[i]);
 310             net->magnetos[i] = htonl(net->magnetos[i]);
 311             net->starter_power[i] = htonl(net->starter_power[i]);
 312             htond(net->throttle[i]);
 313             htond(net->mixture[i]);
 314             net->fuel_pump_power[i] = htonl(net->fuel_pump_power[i]);
 315             htond(net->prop_advance[i]);
 316             htond(net->condition[i]);
 317             net->engine_ok[i] = htonl(net->engine_ok[i]);
 318             net->mag_left_ok[i] = htonl(net->mag_left_ok[i]);
 319             net->mag_right_ok[i] = htonl(net->mag_right_ok[i]);
 320             net->spark_plugs_ok[i] = htonl(net->spark_plugs_ok[i]);
 321             net->oil_press_status[i] = htonl(net->oil_press_status[i]);
 322             net->fuel_pump_ok[i] = htonl(net->fuel_pump_ok[i]);
 323         }
 324         net->num_tanks = htonl(net->num_tanks);
 325         for ( i = 0; i < net->num_tanks; ++i ) {
 326             net->fuel_selector[i] = htonl(net->fuel_selector[i]);
 327         }
 328         htond(net->brake_left);
 329         htond(net->brake_right);
 330         htond(net->copilot_brake_left);
 331         htond(net->copilot_brake_right);
 332         htond(net->brake_parking);
 333         net->gear_handle = htonl(net->gear_handle);
 334         net->master_avionics = htonl(net->master_avionics);
 335         htond(net->wind_speed_kt);
 336         htond(net->wind_dir_deg);
 337         htond(net->turbulence_norm);
 338         htond(net->temp_c);
 339         htond(net->press_inhg);
 340         htond(net->hground);
 341         htond(net->magvar);
 342         net->icing = htonl(net->icing);
 343         net->speedup = htonl(net->speedup);
 344         net->freeze = htonl(net->freeze);
 345     }
 346
 347     if ( net->version != FG_NET_CTRLS_VERSION ) {
 348         SG_LOG( SG_IO, SG_ALERT,
 349                 "Version mismatch with raw controls packet format." );
 350         SG_LOG( SG_IO, SG_ALERT,
 351                 "FlightGear needs version = " << FG_NET_CTRLS_VERSION
 352                 << " but is receiving version = "  << net->version );
 353     }
 354     node = fgGetNode("/controls/flight", true);
 355     node->setDoubleValue( "aileron", net->aileron );
 356     node->setDoubleValue( "elevator", net->elevator );
 357     node->setDoubleValue( "elevator-trim", net->elevator_trim );
 358     node->setDoubleValue( "rudder", net->rudder );
 359     node->setDoubleValue( "flaps", net->flaps );
 360     fgSetBool( "/systems/electrical/outputs/flaps", net->flaps_power );
 361     node->setBoolValue( "flaps-serviceable", net->flap_motor_ok );
 362
 363     for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
 364         // Controls
 365         node = fgGetNode("/controls/engines/engine", i);
 366         node->getChild( "throttle" )->setDoubleValue( net->throttle[i] );
 367         node->getChild( "mixture" )->setDoubleValue( net->mixture[i] );
 368         node->getChild( "propeller-pitch" )
 369             ->setDoubleValue( net->prop_advance[i] );
 370         node->getChild( "condition" )
 371             ->setDoubleValue( net->condition[i] );
 372         node->getChild( "magnetos" )->setDoubleValue( net->magnetos[i] );
 373
 374         // Faults
 375         SGPropertyNode *faults = node->getNode( "faults", true );
 376         faults->setBoolValue( "serviceable", net->engine_ok[i] );
 377         faults->setBoolValue( "left-magneto-serviceable",
 378                               net->mag_left_ok[i] );
 379         faults->setBoolValue( "right-magneto-serviceable",
 380                               net->mag_right_ok[i]);
 381         faults->setBoolValue( "spark-plugs-serviceable",
 382                               net->spark_plugs_ok[i] );
 383         faults->setIntValue( "oil-pressure-status", net->oil_press_status[i] );
 384         faults->setBoolValue( "fuel-pump-serviceable", net->fuel_pump_ok[i] );
 385     }
 386
 387     fgSetBool( "/systems/electrical/outputs/fuel-pump",
 388                net->fuel_pump_power[0] );
 389     fgSetBool( "/systems/electrical/outputs/starter",
 390                net->starter_power[0] );
 391
 392     for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
 393         node = fgGetNode( "/controls/fuel/tank", i );
 394         node->getChild( "fuel_selector" )
 395             ->setBoolValue( net->fuel_selector[i] );
 396     }
 397     node = fgGetNode( "/controls/gear" );
 398     if ( node != NULL ) {
 399         node->getChild( "brake-left" )->setDoubleValue( net->brake_left );
 400         node->getChild( "brake-right" )->setDoubleValue( net->brake_right );
 401         node->getChild( "copilot-brake-left" )
 402             ->setDoubleValue( net->copilot_brake_left );
 403         node->getChild( "copilot-brake-right" )
 404             ->setDoubleValue( net->copilot_brake_right );
 405         node->getChild( "brake-parking" )->setDoubleValue( net->brake_parking );
 406     }
 407
 408     node = fgGetNode( "/controls/gear", true );
 409     node->setBoolValue( "gear-down", net->gear_handle );
 410
 411     node = fgGetNode( "/controls/switches", true );
 412     node->setBoolValue( "master-bat", net->master_bat );
 413     node->setBoolValue( "master-alt", net->master_alt );
 414     node->setBoolValue( "master-avionics", net->master_avionics );
 415
 416     node = fgGetNode( "/environment", true );
 417     node->setDoubleValue( "wind-speed-kt", net->wind_speed_kt );
 418     node->setDoubleValue( "wind-from-heading-deg", net->wind_dir_deg );
 419     node->setDoubleValue( "turbulence/magnitude-norm", net->turbulence_norm );
 420     node->setBoolValue( "magnetic-variation-deg", net->magvar );
 421
 422     node->setDoubleValue( "/environment/temperature-degc",
 423                           net->temp_c );
 424     node->setDoubleValue( "/environment/pressure-sea-level-inhg",
 425                           net->press_inhg );
 426
 427     // ground elevation ???
 428
 429     fgSetDouble("/hazards/icing/wing", net->icing);
 430
 431     fgSetInt( "/sim/speed-up", net->speedup );
 432
 433     if ( honor_freezes ) {
 434         node = fgGetNode( "/sim/freeze", true );
 435         node->setBoolValue( "master", net->freeze & 0x01 );
 436         node->setBoolValue( "position", net->freeze & 0x02 );
 437         node->setBoolValue( "fuel", net->freeze & 0x04 );
 438     }
 439 }
 440
 441
 442 // process work for this port
 443 bool FGNativeCtrls::process() {
 444     SGIOChannel *io = get_io_channel();
 445     int length = sizeof(FGNetCtrls);
 446
 447     if ( get_direction() == SG_IO_OUT ) {
 448         // cout << "size of cur_fdm_state = " << length << endl;
 449
 450         FGProps2NetCtrls( &net_ctrls, true, true );
 451
 452         if ( ! io->write( (char *)(& net_ctrls), length ) ) {
 453             SG_LOG( SG_IO, SG_ALERT, "Error writing data." );
 454             return false;
 455         }
 456     } else if ( get_direction() == SG_IO_IN ) {
 457         if ( io->get_type() == sgFileType ) {
 458             if ( io->read( (char *)(& net_ctrls), length ) == length ) {
 459                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 460                 FGNetCtrls2Props( &net_ctrls, true, true );
 461             }
 462         } else {
 463             while ( io->read( (char *)(& net_ctrls), length ) == length ) {
 464                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 465                 FGNetCtrls2Props( &net_ctrls, true, true );
 466             }
 467         }
 468     }
 469
 470     return true;
 471 }
 472
 473
 474 // close the channel
 475 bool FGNativeCtrls::close() {
 476     SGIOChannel *io = get_io_channel();
 477
 478     set_enabled( false );
 479
 480     if ( ! io->close() ) {
 481         return false;
 482     }
 483
 484     return true;
 485 }