src/Network/opengc.cxx

   1 // opengc.cxx - Network interface program to send data to display processor over LAN
   2 //
   3 // Created by:  J. Wojnaroski  -- castle@mminternet.com
   4 // Date:                21 Nov 2001
   5 //
   6 // Extended from original network code developed by C. Olson
   7 //
   8 //  Modified 12/02/01 - Update engine structure for multi-engine models
   9 //                        - Added data preamble to id msg types
  10 //
  11 //  Modified 01/23/02 - Converted portions of the Engine and Gear accesssors to properties
  12 //                          - Removed data from navigation functions. OpenGC provides own nav functions
  13 //
  14 //  Modified 03/05/03 - Modified to reduce need to search property tree for each node per frame
  15 //
  16 // This program is free software; you can redistribute it and/or
  17 // modify it under the terms of the GNU General Public License as
  18 // published by the Free Software Foundation; either version 2 of the
  19 // License, or (at your option) any later version.
  20 //
  21 // This program is distributed in the hope that it will be useful, but
  22 // WITHOUT ANY WARRANTY; without even the implied warranty of
  23 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24 // General Public License for more details.
  25 //
  26 // You should have received a copy of the GNU General Public License
  27 // along with this program; if not, write to the Free Software
  28 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  29 //
  30
  31 #ifdef HAVE_CONFIG_H
  32 #  include <config.h>
  33 #endif
  34
  35 #include <simgear/debug/logstream.hxx>
  36 #include <simgear/io/iochannel.hxx>
  37
  38 #include <vector>
  39
  40 #include "opengc.hxx"
  41 #include <FDM/flight.hxx>
  42 #include <Main/globals.hxx>
  43 #include <Main/fg_props.hxx>
  44
  45 using std::vector;
  46
  47 FGOpenGC::FGOpenGC() :
  48         press_node(fgGetNode("/environment/pressure-inhg[0]", true)),
  49         temp_node(fgGetNode("/environment/temperature-degc[0]", true)),
  50         wind_dir_node(fgGetNode("/environment/wind-from-heading-deg[0]", true)),
  51         wind_speed_node(fgGetNode("/environment/wind-speed-kt[0]", true)),
  52         magvar_node(fgGetNode("/environment/magnetic-variation-deg[0]", true)),
  53         p_latitude(fgGetNode("/position/latitude-deg", true)),
  54         p_longitude(fgGetNode("/position/longitude-deg", true)),
  55         p_elev_node(fgGetNode("/position/altitude-ft", true)),
  56         p_altitude_agl(fgGetNode("/position/altitude-agl-ft", true)),
  57         p_pitch(fgGetNode("/orientation/pitch-deg[0]", true)),
  58         p_bank(fgGetNode("/orientation/roll-deg[0]", true)),
  59         p_heading(fgGetNode("/orientation/heading-magnetic-deg[0]", true)),
  60         p_yaw(fgGetNode("/fdm/jsbsim/aero/beta-rad[0]", true)),
  61         p_yaw_rate(fgGetNode("/fdm/jsbsim/aero/betadot-rad_sec[0]", true)),
  62         vel_kcas(fgGetNode("/velocities/airspeed-kt[0]", true)),
  63         p_vvi(fgGetNode("/velocities/vertical-speed-fps[0]", true )),
  64         p_mach(fgGetNode("/velocities/mach[0]", true )),
  65         p_left_aileron(fgGetNode("surface-positions/left-aileron-pos-norm", true)),
  66         p_right_aileron(fgGetNode("surface-positions/right-aileron-pos-norm", true)),
  67         p_elevator(fgGetNode("surface-positions/elevator-pos-norm", true)),
  68         p_elevator_trim(fgGetNode("surface-positions/elevator_trim-pos-norm", true)),
  69         p_rudder(fgGetNode("surface-positions/rudder-pos-norm", true)),
  70         p_flaps(fgGetNode("surface-positions/flap-pos-norm", true)),
  71         p_flaps_cmd(fgGetNode("/controls/flight/flaps", true)),
  72         p_park_brake(fgGetNode("/controls/gear/brake-parking", true)),
  73         egt0_node(fgGetNode("/engines/engine/EGT_degC[0]", true)),
  74         egt1_node(fgGetNode("/engines/engine[1]/EGT_degC[0]", true)),
  75         egt2_node(fgGetNode("/engines/engine[2]/EGT_degC[0]", true)),
  76         egt3_node(fgGetNode("/engines/engine[3]/EGT_degC[0]", true)),
  77         epr0_node(fgGetNode("/engines/engine/EPR[0]", true)),
  78         epr1_node(fgGetNode("/engines/engine[1]/EPR[0]", true)),
  79         epr2_node(fgGetNode("/engines/engine[2]/EPR[0]", true)),
  80         epr3_node(fgGetNode("/engines/engine[3]/EPR[0]", true)),
  81         n10_node(fgGetNode("/engines/engine/N1[0]", true)),
  82         n11_node(fgGetNode("/engines/engine[1]/N1[0]", true)),
  83         n12_node(fgGetNode("/engines/engine[2]/N1[0]", true)),
  84         n13_node(fgGetNode("/engines/engine[3]/N1[0]", true)),
  85         n20_node(fgGetNode("/engines/engine/N2[0]", true)),
  86         n21_node(fgGetNode("/engines/engine[1]/N2[0]", true)),
  87         n22_node(fgGetNode("/engines/engine[2]/N2[0]", true)),
  88         n23_node(fgGetNode("/engines/engine[3]/N2[0]", true)),
  89         oil_temp0(fgGetNode("engines/engine/oil-temp-degF[0]", true)),
  90         oil_temp1(fgGetNode("engines/engine[1]/oil-temp-degF[0]", true)),
  91         oil_temp2(fgGetNode("engines/engine[2]/oil-temp-degF[0]", true)),
  92         oil_temp3(fgGetNode("engines/engine[3]/oil-temp-degF[0]", true)),
  93         tank0_node(fgGetNode("/consumables/fuel/tank/level-lb[0]", true)),
  94         tank1_node(fgGetNode("/consumables/fuel/tank[1]/level-lb[0]", true)),
  95         tank2_node(fgGetNode("/consumables/fuel/tank[2]/level-lb[0]", true)),
  96         tank3_node(fgGetNode("/consumables/fuel/tank[3]/level-lb[0]", true)),
  97         tank4_node(fgGetNode("/consumables/fuel/tank[4]/level-lb[0]", true)),
  98         tank5_node(fgGetNode("/consumables/fuel/tank[5]/level-lb[0]", true)),
  99         tank6_node(fgGetNode("/consumables/fuel/tank[6]/level-lb[0]", true)),
 100         tank7_node(fgGetNode("/consumables/fuel/tank[7]/level-lb[0]", true)),
 101         p_alphadot(fgGetNode("/fdm/jsbsim/aero/alphadot-rad_sec[0]", true)),
 102         p_betadot(fgGetNode("/fdm/jsbsim/aero/betadot-rad_sec[0]", true))
 103 {
 104 }
 105
 106 FGOpenGC::~FGOpenGC() {
 107 }
 108
 109 // open hailing frequencies
 110 bool FGOpenGC::open() {
 111     if ( is_enabled() ) {
 112         SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel "
 113                 << "is already in use, ignoring" );
 114         return false;
 115     }
 116
 117     SGIOChannel *io = get_io_channel();
 118
 119     if ( ! io->open( get_direction() ) ) {
 120         SG_LOG( SG_IO, SG_ALERT, "Error opening channel communication layer." );
 121         return false;
 122     }
 123
 124     set_enabled( true );
 125
 126     return true;
 127 }
 128
 129 //static void collect_data( const FGInterface *fdm, ogcFGData *data ) {
 130 void FGOpenGC::collect_data( const FGInterface *fdm, ogcFGData *data ) {
 131
 132     data->version_id = OGC_VERSION;
 133
 134     data->longitude = p_longitude->getDoubleValue();
 135     data->latitude = p_latitude->getDoubleValue();
 136     data->elevation = p_elev_node->getDoubleValue();
 137     data->magvar = magvar_node->getDoubleValue();
 138
 139     data->pitch = p_pitch->getDoubleValue();
 140     data->bank = p_bank->getDoubleValue();
 141     data->heading = p_heading->getDoubleValue();
 142     //data->altitude = p_altitude->getDoubleValue();
 143     data->altitude_agl = p_altitude_agl->getDoubleValue();
 144
 145     data->vvi = p_vvi->getDoubleValue();
 146     data->mach = p_mach->getDoubleValue();
 147     data->groundspeed = cur_fdm_state->get_V_ground_speed();
 148     data->v_keas = cur_fdm_state->get_V_equiv_kts();
 149     data->v_kcas = vel_kcas->getDoubleValue();
 150
 151
 152     data->phi_dot = cur_fdm_state->get_Phi_dot();
 153     data->theta_dot = cur_fdm_state->get_Theta_dot();
 154     data->psi_dot = cur_fdm_state->get_Psi_dot();
 155
 156     data->alpha = cur_fdm_state->get_Alpha();
 157     data->beta = p_yaw->getDoubleValue();
 158     data->alpha_dot = p_alphadot->getDoubleValue();
 159     data->beta_dot = p_yaw_rate->getDoubleValue();
 160
 161   //data->rudder_trim = p_Controls->get_rudder_trim();
 162     data->parking_brake = p_park_brake->getDoubleValue();
 163
 164     data->left_aileron = p_left_aileron->getDoubleValue();
 165     data->right_aileron = p_right_aileron->getDoubleValue();
 166     data->elevator = p_elevator->getDoubleValue();
 167     data->elevator_trim = p_elevator_trim->getDoubleValue();
 168     data->rudder = p_rudder->getDoubleValue();
 169     data->flaps = p_flaps->getDoubleValue();
 170     data->flaps_cmd = p_flaps_cmd->getDoubleValue();
 171
 172     data->gear_nose = fgGetDouble("gear/gear[0]/position-norm[0]");
 173     data->gear_left = fgGetDouble("gear/gear[1]/position-norm[0]");
 174     data->gear_right = fgGetDouble("gear/gear[2]/position-norm[0]");
 175           data->gear_left_rear = fgGetDouble("gear/gear[3]/position-norm[0]");
 176           data->gear_right_rear = fgGetDouble("gear/gear[4]/position-norm[0]");
 177           data->parking_brake = p_park_brake->getDoubleValue();
 178           data->wow_main = fgGetBool("gear/gear[1]/wow[0]") && fgGetBool("gear/gear[2]/wow[0]");
 179           data->wow_nose = fgGetBool("gear/gear[0]/wow[0]");
 180           //cout << "Nose " << data->wow_nose << " Main " << wow_main << endl;
 181
 182     //data->rpm[0] = fgGetDouble("/engines/engine[0]/rpm");
 183     //data->rpm[1] = fgGetDouble("/engines/engine[1]/rpm");
 184
 185     data->epr[0] = epr0_node->getDoubleValue();
 186     data->epr[1] = epr1_node->getDoubleValue();
 187     data->epr[2] = epr2_node->getDoubleValue();
 188     data->epr[3] = epr3_node->getDoubleValue();
 189
 190     data->egt[0] = egt0_node->getDoubleValue();
 191     data->egt[1] = egt1_node->getDoubleValue();
 192     data->egt[2] = egt2_node->getDoubleValue();
 193     data->egt[3] = egt3_node->getDoubleValue();
 194
 195     data->n2_turbine[0] = n20_node->getDoubleValue();
 196     data->n2_turbine[1] = n21_node->getDoubleValue();
 197     data->n2_turbine[2] = n22_node->getDoubleValue();
 198     data->n2_turbine[3] = n23_node->getDoubleValue();
 199
 200     data->n1_turbine[0] = n10_node->getDoubleValue();
 201     data->n1_turbine[1] = n11_node->getDoubleValue();
 202     data->n1_turbine[2] = n12_node->getDoubleValue();
 203     data->n1_turbine[3] = n13_node->getDoubleValue();
 204
 205 // This is really lbs/hr (pph), converted in FGSimTurbine
 206     data->fuel_flow[0] = fgGetDouble("/engines/engine[0]/fuel-flow-gph");
 207     data->fuel_flow[1] = fgGetDouble("/engines/engine[1]/fuel-flow-gph");
 208     data->fuel_flow[2] = fgGetDouble("/engines/engine[2]/fuel-flow-gph");
 209     data->fuel_flow[3] = fgGetDouble("/engines/engine[3]/fuel-flow-gph");
 210
 211     data->oil_pressure[0] = fgGetDouble("/engines/engine[0]/oil-pressure-psi");
 212     data->oil_pressure[1] = fgGetDouble("/engines/engine[1]/oil-pressure-psi");
 213     data->oil_pressure[2] = fgGetDouble("/engines/engine[2]/oil-pressure-psi");
 214     data->oil_pressure[3] = fgGetDouble("/engines/engine[3]/oil-pressure-psi");
 215
 216     //data->oil_temp[0] = fgGetDouble("/engines/engine[0]/oil-temperature-degf");
 217     //data->oil_temp[1] = fgGetDouble("/engines/engine[1]/oil-temperature-degf");
 218     //data->oil_temp[2] = fgGetDouble("/engines/engine[2]/oil-temperature-degf");
 219     //data->oil_temp[3] = fgGetDouble("/engines/engine[3]/oil-temperature-degf");
 220
 221     data->oil_temp[0] = oil_temp0->getDoubleValue();
 222     data->oil_temp[1] = oil_temp1->getDoubleValue();
 223     data->oil_temp[2] = oil_temp2->getDoubleValue();
 224     data->oil_temp[3] = oil_temp3->getDoubleValue();
 225
 226                 data->hyd_pressure[0] = fgGetDouble("/engines/engine[0]/hyd-pressure-psi");
 227                 data->hyd_pressure[1] = fgGetDouble("/engines/engine[1]/hyd-pressure-psi");
 228                 data->hyd_pressure[2] = fgGetDouble("/engines/engine[2]/hyd-pressure-psi");
 229                 data->hyd_pressure[3] = fgGetDouble("/engines/engine[3]/hyd-pressure-psi");
 230                 // just a temp thing until htdraulic model built
 231 //              data->hyd_pressure[0] = 2750.0;
 232 //              data->hyd_pressure[1] = 2755.0;
 233 //              data->hyd_pressure[2] = 2747.0;
 234 //              data->hyd_pressure[3] = 2851.0;
 235
 236
 237     //data->man_pressure[0] = fgGetDouble("/engines/engine[0]/mp-osi");
 238     //data->man_pressure[1] = fgGetDouble("/engines/engine[1]/mp-osi");
 239
 240     data->fuel_tank[0] = tank0_node->getDoubleValue() * 0.001;
 241     data->fuel_tank[1] = tank1_node->getDoubleValue() * 0.001;
 242     data->fuel_tank[2] = tank2_node->getDoubleValue() * 0.001;
 243     data->fuel_tank[3] = tank3_node->getDoubleValue() * 0.001;
 244     data->fuel_tank[4] = tank4_node->getDoubleValue() * 0.001;
 245     data->fuel_tank[5] = tank5_node->getDoubleValue() * 0.001; // 747 stab tank
 246     data->fuel_tank[6] = tank6_node->getDoubleValue() * 0.001; // 747 res2 tank
 247     data->fuel_tank[7] = tank7_node->getDoubleValue() * 0.001; // 747 res3 tank
 248     double total_fuel = 0.0;
 249     for ( int t= 0; t<8; t++ ) total_fuel += data->fuel_tank[t];
 250     data->fuel_tank[8] = total_fuel;
 251     //data->fuel_tank[8] = 386000.0; // total fuel load
 252                 //cout << endl << "Send " << data->fuel_tank[0] << endl;
 253 /*********
 254                 data->boost_pumps[0] = boost1_node->getBoolValue();
 255                 data->boost_pumps[1] = boost2_node->getBoolValue();
 256                 data->boost_pumps[2] = boost3_node->getBoolValue();
 257                 data->boost_pumps[3] = boost4_node->getBoolValue();
 258                 data->boost_pumps[4] = boost5_node->getBoolValue();
 259                 data->boost_pumps[5] = boost6_node->getBoolValue();
 260                 data->boost_pumps[6] = boost7_node->getBoolValue();
 261                 data->boost_pumps[7] = boost8_node->getBoolValue();
 262
 263                 data->over_ride_pumps[0] = ovride0_node->getBoolValue();
 264                 data->over_ride_pumps[1] = ovride1_node->getBoolValue();
 265                 data->over_ride_pumps[2] = ovride2_node->getBoolValue();
 266                 data->over_ride_pumps[3] = ovride3_node->getBoolValue();
 267                 data->over_ride_pumps[4] = ovride4_node->getBoolValue();
 268                 data->over_ride_pumps[5] = ovride5_node->getBoolValue();
 269
 270                 data->x_feed_valve[0] = x_feed0_node->getBoolValue();
 271                 data->x_feed_valve[1] = x_feed1_node->getBoolValue();
 272                 data->x_feed_valve[2] = x_feed2_node->getBoolValue();
 273                 data->x_feed_valve[3] = x_feed3_node->getBoolValue();
 274                 **********/
 275     data->total_temperature = cur_fdm_state->get_Total_temperature();
 276     data->total_pressure = cur_fdm_state->get_Total_pressure();
 277     data->dynamic_pressure = cur_fdm_state->get_Dynamic_pressure();
 278
 279     data->static_pressure = press_node->getDoubleValue();
 280     data->static_temperature = temp_node->getDoubleValue();
 281     data->wind = wind_speed_node->getDoubleValue();
 282     data->wind_dir =  wind_dir_node->getDoubleValue();
 283     data->sea_level_pressure = fgGetDouble("/environment/sea-level-pressure-inhg");
 284 }
 285
 286 static void distribute_data( const ogcFGData *data, FGInterface *chunk ) {
 287     // just a place holder until the CDU is developed
 288
 289 }
 290
 291 // process work for this port
 292 bool FGOpenGC::process() {
 293     SGIOChannel *io = get_io_channel();
 294     int length = sizeof(buf);
 295
 296     if ( get_direction() == SG_IO_OUT ) {
 297         collect_data( cur_fdm_state, &buf );
 298         //collect_data( &buf );
 299         if ( ! io->write( (char *)(& buf), length ) ) {
 300             SG_LOG( SG_IO, SG_ALERT, "Error writing data." );
 301             return false;
 302         }
 303     } else if ( get_direction() == SG_IO_IN ) {
 304         if ( io->get_type() == sgFileType ) {
 305             if ( io->read( (char *)(& buf), length ) == length ) {
 306                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 307                 distribute_data( &buf, cur_fdm_state );
 308             }
 309         } else {
 310             while ( io->read( (char *)(& buf), length ) == length ) {
 311                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 312                 distribute_data( &buf, cur_fdm_state );
 313             }
 314         }
 315     }
 316
 317     return true;
 318 }
 319
 320
 321 // close the channel
 322 bool FGOpenGC::close() {
 323     SGIOChannel *io = get_io_channel();
 324
 325     set_enabled( false );
 326
 327     if ( ! io->close() ) {
 328         return false;
 329     }
 330
 331     return true;
 332 }
 333