src/Instrumentation/attitude_indicator.cxx

   1 // attitude_indicator.cxx - a vacuum-powered attitude indicator.
   2 // Written by David Megginson, started 2002.
   3 //
   4 // This file is in the Public Domain and comes with no warranty.
   5
   6 // TODO:
   7 // - better spin-up
   8
   9 #include <math.h>       // fabs()
  10
  11 #include "attitude_indicator.hxx"
  12 #include <Main/fg_props.hxx>
  13 #include <Main/util.hxx>
  14
  15
  16 AttitudeIndicator::AttitudeIndicator ( SGPropertyNode *node )
  17     :
  18     name("attitude-indicator"),
  19     num(0),
  20     vacuum_system("/systems/vacuum")
  21 {
  22     int i;
  23     for ( i = 0; i < node->nChildren(); ++i ) {
  24         SGPropertyNode *child = node->getChild(i);
  25         string cname = child->getName();
  26         string cval = child->getStringValue();
  27         if ( cname == "name" ) {
  28             name = cval;
  29         } else if ( cname == "number" ) {
  30             num = (int) child->getDoubleValue();
  31         } else if ( cname == "vacuum-system" ) {
  32             vacuum_system = cval;
  33         } else {
  34             SG_LOG( SG_INSTR, SG_WARN, "Error in attitude-indicator config logic" );
  35             if ( name.length() ) {
  36                 SG_LOG( SG_INSTR, SG_WARN, "Section = " << name );
  37             }
  38         }
  39     }
  40 }
  41
  42 AttitudeIndicator::AttitudeIndicator ()
  43 {
  44 }
  45
  46 AttitudeIndicator::~AttitudeIndicator ()
  47 {
  48 }
  49
  50 void
  51 AttitudeIndicator::init ()
  52 {
  53     string branch;
  54     branch = "/instrumentation/" + name;
  55     vacuum_system += "/suction-inhg";
  56
  57     SGPropertyNode *node = fgGetNode(branch.c_str(), num, true );
  58
  59     _pitch_in_node = fgGetNode("/orientation/pitch-deg", true);
  60     _roll_in_node = fgGetNode("/orientation/roll-deg", true);
  61     _suction_node = fgGetNode(vacuum_system.c_str(), true);
  62     SGPropertyNode *cnode = node->getChild("config", 0, true);
  63     _tumble_flag_node = cnode->getChild("tumble-flag", 0, true);
  64     _caged_node = node->getChild("caged-flag", 0, true);
  65     _tumble_node = node->getChild("tumble-norm", 0, true);
  66     _pitch_int_node = node->getChild("internal-pitch-deg", 0, true);
  67     _roll_int_node = node->getChild("internal-roll-deg", 0, true);
  68     _pitch_out_node = node->getChild("indicated-pitch-deg", 0, true);
  69     _roll_out_node = node->getChild("indicated-roll-deg", 0, true);
  70 }
  71
  72 void
  73 AttitudeIndicator::bind ()
  74 {
  75     string branch;
  76     branch = "/instrumentation/" + name + "/serviceable";
  77
  78     fgTie(branch.c_str(),
  79           &_gyro, &Gyro::is_serviceable, &Gyro::set_serviceable);
  80     branch = "/instrumentation/" + name + "/spin";
  81     fgTie(branch.c_str(),
  82           &_gyro, &Gyro::get_spin_norm, &Gyro::set_spin_norm);
  83 }
  84
  85 void
  86 AttitudeIndicator::unbind ()
  87 {
  88     string branch;
  89     branch = "/instrumentation/" + name + "/serviceable";
  90
  91     fgUntie(branch.c_str());
  92     branch = "/instrumentation/" + name + "/spin";
  93     fgUntie(branch.c_str());
  94 }
  95
  96 void
  97 AttitudeIndicator::update (double dt)
  98 {
  99                                 // If it's caged, it doesn't indicate
 100     if (_caged_node->getBoolValue()) {
 101         _roll_int_node->setDoubleValue(0.0);
 102         _pitch_int_node->setDoubleValue(0.0);
 103         return;
 104     }
 105
 106                                 // Get the spin from the gyro
 107     _gyro.set_power_norm(_suction_node->getDoubleValue()/5.0);
 108     _gyro.update(dt);
 109     double spin = _gyro.get_spin_norm();
 110
 111                                 // Calculate the responsiveness
 112     double responsiveness = spin * spin * spin * spin * spin * spin;
 113
 114                                 // Get the indicated roll and pitch
 115     double roll = _roll_in_node->getDoubleValue();
 116     double pitch = _pitch_in_node->getDoubleValue();
 117
 118                                 // Calculate the tumble for the
 119                                 // next pass.
 120     if (_tumble_flag_node->getBoolValue()) {
 121         double tumble = _tumble_node->getDoubleValue();
 122         if (fabs(roll) > 45.0) {
 123             double target = (fabs(roll) - 45.0) / 45.0;
 124             target *= target;   // exponential past +-45 degrees
 125             if (roll < 0)
 126                 target = -target;
 127
 128             if (fabs(target) > fabs(tumble))
 129                 tumble = target;
 130
 131             if (tumble > 1.0)
 132                 tumble = 1.0;
 133             else if (tumble < -1.0)
 134                 tumble = -1.0;
 135         }
 136                                     // Reerect in 5 minutes
 137         double step = dt/300.0;
 138         if (tumble < -step)
 139             tumble += step;
 140         else if (tumble > step)
 141             tumble -= step;
 142
 143         roll += tumble * 45;
 144         _tumble_node->setDoubleValue(tumble);
 145     }
 146
 147     roll = fgGetLowPass(_roll_int_node->getDoubleValue(), roll,
 148                         responsiveness);
 149     pitch = fgGetLowPass(_pitch_int_node->getDoubleValue(), pitch,
 150                          responsiveness);
 151
 152                                 // Assign the new values
 153     _roll_int_node->setDoubleValue(roll);
 154     _pitch_int_node->setDoubleValue(pitch);
 155
 156     // add in a gyro underspin "error" if gyro is spinning too slowly
 157     const double spin_thresh = 0.8;
 158     const double max_roll_error = 40.0;
 159     const double max_pitch_error = 12.0;
 160     double roll_error;
 161     double pitch_error;
 162     if ( spin <= spin_thresh ) {
 163         double roll_error_factor = (spin_thresh - spin) / spin_thresh;
 164         double pitch_error_factor = (spin_thresh - spin) / spin_thresh;
 165         roll_error = roll_error_factor * roll_error_factor * max_roll_error;
 166         pitch_error = pitch_error_factor * pitch_error_factor * max_pitch_error;
 167     } else {
 168         roll_error = 0.0;
 169         pitch_error = 0.0;
 170     }
 171
 172     _roll_out_node->setDoubleValue(roll + roll_error);
 173     _pitch_out_node->setDoubleValue(pitch + pitch_error);
 174 }
 175
 176 // end of attitude_indicator.cxx