src/doxy/tuneSwitching.h

   1 /** @page tuneSwitching Tune Switching
   2  *
   3  * This feature is similar to one known as "table switching" that you may
   4  * have used before on other systems except that instead of just switching
   5  * the tables, the entire tune is switched. The only exceptions to this are
   6  * physical constants that there is only one available copy of.
   7  *
   8  * @todo TODO insert discussion about various uses of tune switching here.
   9  *
  10  * The primary copy of all switchable items is enabled by default and is
  11  * normally what you want to adjust while tuning the engine. It is also what is
  12  * in use when the tune switching mechanism is enabled and not engaged. The
  13  * secondary copy of a given switchable item is enabled when the tune switching
  14  * mechanism is enabled and engaged. If tune switching is not enabled then the
  15  * secondary copy is never used.
  16  *
  17  * @b Warning:
  18  *
  19  * Although this boils down to paranoia, some precautions are best taken when
  20  * tuning your vehicle with FreeEMS. Because there are always two copies of all
  21  * settings and the code has the ability to switch between them you you should
  22  * always configure the secondary copy explicitly.
  23  *
  24  * If you are not using the tune switching feature it is wise to configure all
  25  * values in the secondary set to be exactly the same as what is in the primary
  26  * set. This way if you have tune switching     turned on by accident and the input
  27  * pin is floating you will not get erratic engine behaviour.
  28  *
  29  * @b Developers:
  30  *
  31  * When adding things to the set of switchable data please ensure you insert
  32  * appropriate default values in both the primary and secondary copies.
  33  */
  34
  35 /**     @file tuneSwitching.h
  36  * @ingroup doxygenDocFiles
  37  * @brief Doxygen Tune Switching page definition
  38  */