doc: Update altusmetrum docs and screen shots for 1.4
authorKeith Packard <keithp@keithp.com>
Thu, 12 Jun 2014 06:28:36 +0000 (23:28 -0700)
committerKeith Packard <keithp@keithp.com>
Thu, 12 Jun 2014 06:28:36 +0000 (23:28 -0700)
Signed-off-by: Keith Packard <keithp@keithp.com>
12 files changed:
doc/altusmetrum.xsl
doc/ascent.png
doc/configure-altimeter.png
doc/configure-pyro.png
doc/descent.png
doc/graph-configure.png
doc/graph-map.png
doc/ignitor.png [new file with mode: 0644]
doc/landed.png
doc/launch-pad.png
doc/load-maps.png
doc/site-map.png

index f91ac191f72a5897fd14d500226b17c4c6b41bcf..de54114730594e0915953cb4110aff8e41754cde 100644 (file)
@@ -2772,10 +2772,19 @@ NAR #88757, TRA #12200
           dark blue for main, and black for landed.
         </para>
         <para>
-          The map's scale is approximately 3m (10ft) per pixel. The map
+          The map's default scale is approximately 3m (10ft) per pixel. The map
           can be dragged using the left mouse button. The map will attempt
           to keep the rocket roughly centered while data is being received.
         </para>
+       <para>
+         You can adjust the style of map and the zoom level with
+         buttons on the right side of the map window. You can draw a
+         line on the map by moving the mouse over the map with a
+         button other than the left one pressed, or by pressing the
+         left button while also holding down the shift key. The
+         length of the line in real-world units will be shown at the
+         start of the line.
+       </para>
         <para>
           Images are fetched automatically via the Google Maps Static API,
           and cached on disk for reuse. If map images cannot be downloaded,
@@ -2787,6 +2796,24 @@ NAR #88757, TRA #12200
          before you leave home; check out the 'Preload Maps' section below.
        </para>
       </section>
+      <section>
+        <title>Ignitor</title>
+       <informalfigure>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="ignitor.png" width="5.5in"/>
+           </imageobject>
+         </mediaobject>
+       </informalfigure>
+        <para>
+          TeleMega includes four additional programmable pyro
+          channels. The Ignitor tab shows whether each of them has
+          continuity. If an ignitor has a low resistance, then the
+          voltage measured here will be close to the pyro battery
+          voltage. A value greater than 3.2V is required for a 'GO'
+          status.
+       </para>
+      </section>
     </section>
     <section>
       <title>Save Flight Data</title>
@@ -3053,7 +3080,21 @@ NAR #88757, TRA #12200
         </para>
       </section>
       <section>
-        <title>Radio Frequency</title>
+        <title>Apogee Lockoug</title>
+        <para>
+         Apogee lockout is the number of seconds after boost where
+         the flight computer will not fire the apogee charge, even if
+         the rocket appears to be at apogee. This is often called
+         'Mach Delay', as it is intended to prevent a flight computer
+         from unintentionally firing apogee charges due to the pressure
+         spike that occurrs across a mach transition. Altus Metrum
+         flight computers include a Kalman filter which is not fooled
+         by this sharp pressure increase, and so this setting should
+         be left at the default value of zero to disable it.
+        </para>
+      </section>
+      <section>
+        <title>Frequency</title>
         <para>
           This configures which of the frequencies to use for both
           telemetry and packet command mode. Note that if you set this
@@ -3111,12 +3152,11 @@ NAR #88757, TRA #12200
        </para>
       </section>
       <section>
-        <title>Ignite Mode</title>
+        <title>Ignitor Firing Mode</title>
        <para>
-         TeleMetrum and TeleMini provide two igniter channels as they
-         were originally designed as dual-deploy flight
-         computers. This configuration parameter allows the two
-         channels to be used in different configurations.
+         This configuration parameter allows the two standard ignitor
+         channels (Apogee and Main) to be used in different
+         configurations.
        </para>
           <variablelist>
            <varlistentry>
@@ -3186,6 +3226,16 @@ NAR #88757, TRA #12200
          </varlistentry>
        </variablelist>
       </section>
+      <section>
+        <title>Beeper Frequency</title>
+       <para>
+         The beeper on all Altus Metrum flight computers works best
+         at 4000Hz, however if you have more than one flight computer
+         in a single airframe, having all of them sound at the same
+         frequency can be confusing. This parameter lets you adjust
+         the base beeper frequency value.
+       </para>
+      </section>
       <section>
        <title>Configure Pyro Channels</title>
        <informalfigure>
@@ -3211,6 +3261,11 @@ NAR #88757, TRA #12200
          configuration values, so you can use different values for
          the same condition with different channels.
        </para>
+       <para>
+         At the bottom of the window, the 'Pyro Firing Time'
+         configuration sets the length of time (in seconds) which
+         each of these pyro channels will fire for.
+       </para>
        <para>
          Once you have selected the appropriate configuration for all
          of the necessary pyro channels, you can save the pyro
@@ -3498,9 +3553,62 @@ NAR #88757, TRA #12200
        and name of the site. The contents of this list are actually
        downloaded from our server at run-time, so as new sites are sent 
        in, they'll get automatically added to this list.
+       If the launch site isn't in the list, you can manually enter the lat/lon values
       </para>
       <para>
-       If the launch site isn't in the list, you can manually enter the lat/lon values
+       There are four different kinds of maps you can view; you can
+       select which to download by selecting as many as you like from
+       the available types:
+       <variablelist>
+         <varlistentry>
+           <term>Hybrid</term>
+           <listitem>
+             <para>
+               A combination of satellite imagery and road data. This
+               is the default view.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term>Satellite</term>
+           <listitem>
+             <para>
+               Just the satellite imagery without any annotation.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term>Roadmap</term>
+           <listitem>
+             <para>
+               Roads, political boundaries and a few geographic features.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term>Terrain</term>
+           <listitem>
+             <para>
+               Contour intervals and shading that show hills and
+               valleys.
+             </para>
+           </listitem>
+         </varlistentry>
+       </variablelist>
+      </para>
+      <para>
+       You can specify the range of zoom levels to download; smaller
+       numbers show more area with less resolution. The default
+       level, 0, shows about 3m/pixel. One zoom level change
+       doubles or halves that number.
+      </para>
+      <para>
+       The Tile Radius value sets how large an area around the center
+       point to download. Each tile is 512x512 pixels, and the
+       'radius' value specifies how many tiles away from the center
+       will be downloaded. Specify a radius of 0 and you get only the
+       center tile. A radius of 1 loads a 3x3 grid, centered on the
+       specified location.
       </para>
       <para>
        Clicking the 'Load Map' button will fetch images from Google
index d486d19ca12b3c4ffca6a7ec49b7964b6ca56a0f..2d62f06e51aaafc68ac291dbc54f5a3557c23d79 100644 (file)
Binary files a/doc/ascent.png and b/doc/ascent.png differ
index afb1932566512259d4036692fdd6976ec628f265..514db3eda660b98f93502aa021a311265384f4bb 100644 (file)
Binary files a/doc/configure-altimeter.png and b/doc/configure-altimeter.png differ
index 1c6ae066db5ac7cb7646fb62b804cf8f5b5e5753..599d45b589cb4a1618ea107031a59900e4bac55c 100644 (file)
Binary files a/doc/configure-pyro.png and b/doc/configure-pyro.png differ
index 4ac4b9624635753801724c4e03757ebcd0a498e8..5a7baadd7bb6d80982c4fb9307d308736be0f8ad 100644 (file)
Binary files a/doc/descent.png and b/doc/descent.png differ
index d3374ba84d9b0c81eb5b0c1226fcfe869c89a615..ed0d51124693a83a434ff43534cec68c569a8052 100644 (file)
Binary files a/doc/graph-configure.png and b/doc/graph-configure.png differ
index fd0fb1344b116d5e0734297b5a34db9e8a30010f..bcea5ff845c147c987458d27fa33168ab7fd7112 100644 (file)
Binary files a/doc/graph-map.png and b/doc/graph-map.png differ
diff --git a/doc/ignitor.png b/doc/ignitor.png
new file mode 100644 (file)
index 0000000..d1f5aeb
Binary files /dev/null and b/doc/ignitor.png differ
index 777d2445abb16aa45c4fd73a046059a37df2aa71..a58cfbf431807b6eacb7f838996fbdc86cfb5af6 100644 (file)
Binary files a/doc/landed.png and b/doc/landed.png differ
index a7a05c08acaaea467f5bedb9c90077fe55b51d9b..f2c41e6b2d50b64fe39ecbc8fd525b11fb721dd2 100644 (file)
Binary files a/doc/launch-pad.png and b/doc/launch-pad.png differ
index dc7ea64c087fcadb095f0ed086cfa973bd753218..ae98c9a59a9c084c92b60b75e9763ae1c5f49600 100644 (file)
Binary files a/doc/load-maps.png and b/doc/load-maps.png differ
index 755e73619234966c048d2ac788f134a5cf9a592c..ebac1dfbbc9e22de1de2e4fcd41a39bece03d9a9 100644 (file)
Binary files a/doc/site-map.png and b/doc/site-map.png differ