LM Simulator Help
=================

The program "LM Simulator" is an add-on to Ron Burkey's "yaAGC" (Apollo Guidance Computer Simulation / 
http://www.ibiblio.org/apollo/index.html).
It evolved from a simple BIT-Monitor to that what it is today, a very simple Lunar Module System Simulator.
The program has been written in an interpreter language called TCL/TK which is available on nearly all LINUX 
distributions. To cover the Windows world a stand-alone application will be provided.


The following System Simulations are already implemented:
=========================================================
- IMU (Inertial Measurement Unit)
- FDAI (Flight Director Attitude Indicator) inluding:
     + Yaw, Pitch and Roll Rate Indicators
     + Error Needles to display data under the subsequent modes:
         1.) DSKY: V61E -> DISPLAY DAP FOLLOWING ATTITUDE ERRORS
         2.) DSKY: V62E -> DISPLAY TOTAL ATTITUDE ERRORS WITH RESPECT TO NOUN 22
         3.) DSKY: V60E -> DISPLAY VEHICLE ATTITUDE RATES ON FDAI ERROR NEEDLES
- All Crew Switches connected to the AGC
- All binary AGC system inputs by providing check-buttons to change their status (e.g. Overtemperature)
- All binary AGC outputs by interpreting the different BIT combinations and presenting the status in a readable form
- A physical model to simulate the LM behavior in space.
     + The Calculation of the Moment of Inertia bases on the same hyperbola equation as used by the AGC state estimator
- The four quad RCS thruster system in conjunction with the above mentioned physical model
- Descent and Ascent Engine (Veryfied by Tsiolkovsky's Rocket Equation)
- Stage Separation
- A Bit-Monitor to trace the AGC inputs and outputs


LM Simulator connects via TCP/IP-Interface directly to "yaAGC". To use a joystick (RHC/ACA), which is strongly 
recommended, Ron Burkey's program "yaACA" has to be started.


Architecture Overview:
======================

-----------------              ---------------              -----------
|               |    TCP/IP    |             |    TCP/IP    |         |
| LM Simulator  | <----------> |    yaAGC    | <----------> |  yaACA  |
|               |              |             |              |         |
-----------------              ---------------              -----------


Configuration:
==============
If you start LM Simulator without any parameter (wish lm_simulator.tcl) then it assumes a config file 
within the same directory called "lm_simulator.ini". If that config file is not available then 
LM Simulator starts with internally defined standard values based on the LM-7 mission.

Command Line Configuration:
---------------------------
--port=PortNum          Changes the port number (by default, 19801) used to connect to yaAGC.  
                        This can also be changed in the configuration file.

--cfg=IniFilename       This option changes the name or directory of the configuration-file used.
                        By default, the file is "lm_simulator.ini", located in the installation directory.


Program-Menu Structure:
=======================
The program is divided into several sub-windows which can be called through the "Systems" menu.

Menu:                                Function:
-----------------------------------------------------------------------------------------------
Edit -> Clear Message Window         Clears the Log Window
Edit -> Exit                         Leaves the Program

Systems -> DSKY Lite                 Display/Keyboard interface to the AGC
Systems -> AGC Outputs               Monitoring and Correlating of the AGC Binary Outputs     
Systems -> AGC LM System Input       Simulation of all binary AGC input values
Systems -> AGC Crew Inputs           Crew Switches connected to the AGC
Systems -> FDAI / IMU                Flight Director Attitude Indicator which shows the
                                     LM attitude in relation to the Inertial Measurement Unit
Systems -> Simulation Monitor &      Monitor simulation parameter like thrust and amount of
           Control                   propellant and control the Descent and Ascent Engine 
                                     as well as the stage separation.

Info -> Help                         The on-hand document
Info -> Tutorial                     Explanation of some procedures like IMU initialization
Info -> Verbs & Nouns                A list of the available verbs & nouns to use the AGC
Info -> Alarm Codes                  List AGC alarm codes
Info -> About                        Author, Version etc.
Info -> License                      The license model of LM Simulator

