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 net_byte_order ) {
 102     int i;
 103     SGPropertyNode * node;
 104     SGPropertyNode * tempnode;
 105
 106     // fill in values
 107     node  = fgGetNode("/controls/flight", true);
 108     net->version = FG_NET_CTRLS_VERSION;
 109     net->aileron = node->getDoubleValue( "aileron" );
 110     net->elevator = node->getDoubleValue( "elevator" );
 111     net->elevator_trim = node->getDoubleValue( "elevator-trim" );
 112     net->rudder = node->getDoubleValue( "rudder" );
 113     net->flaps = node->getDoubleValue( "flaps" );
 114     node = fgGetNode("/controls", true);
 115     net->flaps_power
 116             = node->getDoubleValue( "/systems/electrical/outputs/flaps",
 117                                     1.0 ) >= 1.0;
 118     net->num_engines = FGNetCtrls::FG_MAX_ENGINES;
 119     for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
 120         node = fgGetNode("/controls/engines/engine", i );
 121         net->throttle[i] = node->getDoubleValue( "throttle", 0.0 );
 122         net->mixture[i] = node->getDoubleValue( "mixture", 0.0 );
 123         net->prop_advance[i] = node->getDoubleValue( "propeller-pitch", 0.0 );
 124         net->magnetos[i] = node->getIntValue( "magnetos", 0 );
 125         if ( i == 0 ) {
 126           // cout << "Magnetos -> " << node->getIntValue( "magnetos", 0 );
 127         }
 128         if ( i == 0 ) {
 129           // cout << "Starter -> " << node->getIntValue( "starter", false )
 130           //      << endl;
 131         }
 132         node = fgGetNode("/controls", true);
 133         net->fuel_pump_power[i]
 134             = node->getDoubleValue( "/systems/electrical/outputs/fuel-pump",
 135                                     1.0 ) >= 1.0;
 136
 137         net->starter_power[i]
 138             = node->getDoubleValue( "/systems/electrical/outputs/starter",
 139                                     1.0 ) >= 1.0;
 140     }
 141     net->num_tanks = FGNetCtrls::FG_MAX_TANKS;
 142     for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
 143         node = fgGetNode("/controls/fuel/tank", i);
 144         if ( node->getChild("fuel-selector") != 0 ) {
 145             net->fuel_selector[i]
 146                 = node->getChild("fuel-selector")->getBoolValue();
 147         } else {
 148             net->fuel_selector[i] = false;
 149         }
 150     }
 151     net->num_wheels = FGNetCtrls::FG_MAX_WHEELS;
 152     tempnode = fgGetNode("/controls/gear", true);
 153     for ( i = 0; i < FGNetCtrls::FG_MAX_WHEELS; ++i ) {
 154         node = fgGetNode("/controls/gear/wheel", i);
 155         if ( node->getChild("brake") != 0 ) {
 156             if ( tempnode->getChild("parking-brake")->getDoubleValue() > 0.0 ) {
 157                 net->brake[i] = 1.0;
 158            } else {
 159                 net->brake[i]
 160                     = node->getChild("brake")->getDoubleValue();
 161             }
 162         } else {
 163             net->brake[i] = 0.0;
 164         }
 165     }
 166
 167     node = fgGetNode("/controls/switches", true);
 168     net->master_bat = node->getChild("master-bat")->getBoolValue();
 169     net->master_alt = node->getChild("master-alt")->getBoolValue();
 170     net->master_avionics = node->getChild("master-avionics")->getBoolValue();
 171
 172     net->wind_speed_kt = fgGetDouble("/environment/wind-speed-kt");
 173     net->wind_dir_deg = fgGetDouble("/environment/wind-from-heading-deg");
 174
 175     // cur_fdm_state->get_ground_elev_ft() is what we want ... this
 176     // reports the altitude of the aircraft.
 177     // "/environment/ground-elevation-m" reports the ground elevation
 178     // of the current view point which could change substantially if
 179     // the user is switching views.
 180     net->hground = cur_fdm_state->get_ground_elev_ft() * SG_FEET_TO_METER;
 181     net->magvar = fgGetDouble("/environment/magnetic-variation-deg");
 182     net->speedup = fgGetInt("/sim/speed-up");
 183     net->freeze = 0;
 184     if ( fgGetBool("/sim/freeze/master") ) {
 185         net->freeze |= 0x01;
 186     }
 187     if ( fgGetBool("/sim/freeze/position") ) {
 188         net->freeze |= 0x02;
 189     }
 190     if ( fgGetBool("/sim/freeze/fuel") ) {
 191         net->freeze |= 0x04;
 192     }
 193
 194     if ( net_byte_order ) {
 195         // convert to network byte order
 196         net->version = htonl(net->version);
 197         htond(net->aileron);
 198         htond(net->elevator);
 199         htond(net->elevator_trim);
 200         htond(net->rudder);
 201         htond(net->flaps);
 202         net->flaps_power = htonl(net->flaps_power);
 203         for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
 204             htond(net->throttle[i]);
 205             htond(net->mixture[i]);
 206             net->fuel_pump_power[i] = htonl(net->fuel_pump_power[i]);
 207             htond(net->prop_advance[i]);
 208             net->magnetos[i] = htonl(net->magnetos[i]);
 209             net->starter_power[i] = htonl(net->starter_power[i]);
 210         }
 211         net->num_engines = htonl(net->num_engines);
 212         for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
 213             net->fuel_selector[i] = htonl(net->fuel_selector[i]);
 214         }
 215         net->num_tanks = htonl(net->num_tanks);
 216         for ( i = 0; i < FGNetCtrls::FG_MAX_WHEELS; ++i ) {
 217             htond(net->brake[i]);
 218         }
 219         net->num_wheels = htonl(net->num_wheels);
 220         net->gear_handle = htonl(net->gear_handle);
 221         net->master_bat = htonl(net->master_bat);
 222         net->master_alt = htonl(net->master_alt);
 223         net->master_avionics = htonl(net->master_avionics);
 224         htond(net->wind_speed_kt);
 225         htond(net->wind_dir_deg);
 226         htond(net->hground);
 227         htond(net->magvar);
 228         net->speedup = htonl(net->speedup);
 229         net->freeze = htonl(net->freeze);
 230     }
 231 }
 232
 233
 234 // Update the property tree from the FGNetCtrls structure.
 235 void FGNetCtrls2Props( FGNetCtrls *net, bool net_byte_order ) {
 236     int i;
 237
 238     SGPropertyNode * node;
 239
 240     if ( net_byte_order ) {
 241         // convert from network byte order
 242         net->version = htonl(net->version);
 243         htond(net->aileron);
 244         htond(net->elevator);
 245         htond(net->elevator_trim);
 246         htond(net->rudder);
 247         htond(net->flaps);
 248         net->flaps_power = htonl(net->flaps_power);
 249         net->num_engines = htonl(net->num_engines);
 250         for ( i = 0; i < net->num_engines; ++i ) {
 251             net->magnetos[i] = htonl(net->magnetos[i]);
 252             net->starter_power[i] = htonl(net->starter_power[i]);
 253             htond(net->throttle[i]);
 254             htond(net->mixture[i]);
 255             net->fuel_pump_power[i] = htonl(net->fuel_pump_power[i]);
 256             htond(net->prop_advance[i]);
 257         }
 258         net->num_tanks = htonl(net->num_tanks);
 259         for ( i = 0; i < net->num_tanks; ++i ) {
 260             net->fuel_selector[i] = htonl(net->fuel_selector[i]);
 261         }
 262         net->num_wheels = htonl(net->num_wheels);
 263         for ( i = 0; i < net->num_wheels; ++i ) {
 264             htond(net->brake[i]);
 265         }
 266         net->gear_handle = htonl(net->gear_handle);
 267         net->master_bat = htonl(net->master_bat);
 268         net->master_alt = htonl(net->master_alt);
 269         net->master_avionics = htonl(net->master_avionics);
 270         htond(net->wind_speed_kt);
 271         htond(net->wind_dir_deg);
 272         htond(net->hground);
 273         htond(net->magvar);
 274         net->speedup = htonl(net->speedup);
 275         net->freeze = htonl(net->freeze);
 276     }
 277
 278     if ( net->version != FG_NET_CTRLS_VERSION ) {
 279         SG_LOG( SG_IO, SG_ALERT,
 280                 "Version mismatch with raw controls packet format." );
 281         SG_LOG( SG_IO, SG_ALERT,
 282                 "FlightGear needs version = " << FG_NET_CTRLS_VERSION
 283                 << " but is receiving version = "  << net->version );
 284     }
 285     node = fgGetNode("/controls/flight", true);
 286     node->setDoubleValue( "aileron", net->aileron );
 287     node->setDoubleValue( "elevator", net->elevator );
 288     node->setDoubleValue( "elevator-trim", net->elevator_trim );
 289     node->setDoubleValue( "rudder", net->rudder );
 290     node->setDoubleValue( "flaps", net->flaps );
 291
 292     fgSetBool( "/systems/electrical/outputs/flaps", net->flaps_power );
 293
 294     for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
 295         node = fgGetNode("/controls/engines/engine", i);
 296         node->getChild( "throttle" )->setDoubleValue( net->throttle[i] );
 297         node->getChild( "mixture" )->setDoubleValue( net->mixture[i] );
 298         node->getChild( "propeller-pitch" )
 299             ->setDoubleValue( net->prop_advance[i] );
 300         node->getChild( "magnetos" )->setDoubleValue( net->magnetos[i] );
 301     }
 302
 303     fgSetBool( "/systems/electrical/outputs/fuel-pump",
 304                net->fuel_pump_power[0] );
 305     fgSetBool( "/systems/electrical/outputs/starter",
 306                net->starter_power[0] );
 307
 308     for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
 309         node = fgGetNode( "/controls/fuel/tank", i );
 310         node->getChild( "fuel-selector" )
 311             ->setBoolValue( net->fuel_selector[i] );
 312     }
 313     for ( i = 0; i < FGNetCtrls::FG_MAX_WHEELS; ++i ) {
 314         node = fgGetNode( "/controls/gear/wheel", i );
 315         node->getChild( "brake" )->setDoubleValue( net->brake[i] );
 316     }
 317
 318     node = fgGetNode( "/controls/gear", true );
 319     node->setBoolValue( "gear-down", net->gear_handle );
 320
 321     node = fgGetNode( "/controls/switches", true );
 322     node->setBoolValue( "master-bat", net->master_bat );
 323     node->setBoolValue( "master-alt", net->master_alt );
 324     node->setBoolValue( "master-avionics", net->master_avionics );
 325
 326     node = fgGetNode( "/environment", true );
 327     node->setBoolValue( "wind-speed-kt", net->wind_speed_kt );
 328     node->setBoolValue( "wind-from-heading-deg", net->wind_dir_deg );
 329     node->setBoolValue( "magnetic-variation-deg", net->magvar );
 330
 331     // ground elevation ???
 332
 333     fgSetInt( "/sim/speed-up", net->speedup );
 334
 335     node = fgGetNode( "/sim/freeze", true );
 336     node->setBoolValue( "master", net->freeze & 0x01 );
 337     node->setBoolValue( "position", net->freeze & 0x02 );
 338     node->setBoolValue( "fuel", net->freeze & 0x04 );
 339 }
 340
 341
 342 // process work for this port
 343 bool FGNativeCtrls::process() {
 344     SGIOChannel *io = get_io_channel();
 345     int length = sizeof(FGNetCtrls);
 346
 347     if ( get_direction() == SG_IO_OUT ) {
 348         // cout << "size of cur_fdm_state = " << length << endl;
 349
 350         FGProps2NetCtrls( &net_ctrls );
 351
 352         if ( ! io->write( (char *)(& net_ctrls), length ) ) {
 353             SG_LOG( SG_IO, SG_ALERT, "Error writing data." );
 354             return false;
 355         }
 356     } else if ( get_direction() == SG_IO_IN ) {
 357         if ( io->get_type() == sgFileType ) {
 358             if ( io->read( (char *)(& net_ctrls), length ) == length ) {
 359                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 360                 FGNetCtrls2Props( &net_ctrls );
 361             }
 362         } else {
 363             while ( io->read( (char *)(& net_ctrls), length ) == length ) {
 364                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 365                 FGNetCtrls2Props( &net_ctrls );
 366             }
 367         }
 368     }
 369
 370     return true;
 371 }
 372
 373
 374 // close the channel
 375 bool FGNativeCtrls::close() {
 376     SGIOChannel *io = get_io_channel();
 377
 378     set_enabled( false );
 379
 380     if ( ! io->close() ) {
 381         return false;
 382     }
 383
 384     return true;
 385 }