doc: Document imperial units and groundstation configuration
[fw/altos] / doc / altusmetrum.xsl
index 66c2b339feb24013633c2b0a0fb614d11e80d923..5dd93fdff287382690068444a336a15bc456d1c3 100644 (file)
@@ -258,7 +258,8 @@ NAR #88757, TRA #12200
       A typical TeleMetrum or TeleMini installation involves attaching 
       only a suitable Lithium Polymer battery, a single pole switch for 
       power on/off, and two pairs of wires connecting e-matches for the 
-      apogee and main ejection charges.
+      apogee and main ejection charges.  All Altus Metrum products are 
+      designed for use with single-cell batteries with 3.7 volts nominal.
     </para>
     <para>
       By default, we use the unregulated output of the Li-Po battery directly
@@ -536,7 +537,7 @@ NAR #88757, TRA #12200
         or radio link via TeleDongle.
       </para>
       <section>
-        <title>Radio Frequencies</title>
+        <title>Radio Frequency</title>
         <para>
          Altus Metrum boards support radio frequencies in the 70cm
          band. By default, the configuration interface provides a
@@ -583,6 +584,90 @@ NAR #88757, TRA #12200
           simultaneously.
         </para>
       </section>
+      <section>
+       <title>Maximum Flight Log</title>
+       <para>
+         TeleMetrum version 1.1 and 1.2 have 2MB of on-board flash storage,
+         enough to hold over 40 minutes of data at full data rate
+         (100 samples/second). TeleMetrum 1.0 has 1MB of on-board
+         storage. As data are stored at a reduced rate during descent
+         (10 samples/second), there's plenty of space to store many
+         flights worth of data.
+       </para>
+       <para>
+         The on-board flash is partitioned into separate flight logs,
+         each of a fixed maximum size. Increase the maximum size of
+         each log and you reduce the number of flights that can be
+         stored. Decrease the size and TeleMetrum can store more
+         flights.
+       </para>
+       <para>
+         All of the configuration data is also stored in the flash
+         memory, which consumes 64kB on TeleMetrum v1.1/v1.2 and 256B on
+         TeleMetrum v1.0. This configuration space is not available
+         for storing flight log data.
+       </para>
+       <para>
+         To compute the amount of space needed for a single flight,
+         you can multiply the expected ascent time (in seconds) by
+         800, multiply the expected descent time (in seconds) by 80
+         and add the two together. That will slightly under-estimate
+         the storage (in bytes) needed for the flight. For instance,
+         a flight spending 20 seconds in ascent and 150 seconds in
+         descent will take about (20 * 800) + (150 * 80) = 28000
+         bytes of storage. You could store dozens of these flights in
+         the on-board flash.
+       </para>
+       <para>
+         The default size, 192kB, allows for 10 flights of storage on
+         TeleMetrum v1.1/v1.2 and 5 flights on TeleMetrum v1.0. This
+         ensures that you won't need to erase the memory before
+         flying each time while still allowing more than sufficient
+         storage for each flight.
+       </para>
+       <para>
+         As TeleMini does not contain an accelerometer, it stores
+         data at 10 samples per second during ascent and one sample
+         per second during descent. Each sample is a two byte reading
+         from the barometer. These are stored in 5kB of
+         on-chip flash memory which can hold 256 seconds at the
+         ascent rate or 2560 seconds at the descent rate. Because of
+         the limited storage, TeleMini cannot hold data for more than
+         one flight, and so must be erased after each flight or it
+         will not capture data for subsequent flights.
+       </para>
+      </section>
+      <section>
+       <title>Ignite Mode</title>
+       <para>
+         Instead of firing one charge at apogee and another charge at
+         a fixed height above the ground, you can configure the
+         altimeter to fire both at apogee or both during
+         descent. This was added to support an airframe that has two
+         TeleMetrum computers, one in the fin can and one in the
+         nose.
+       </para>
+       <para>
+         Providing the ability to use both igniters for apogee or
+         main allows some level of redundancy without needing two
+         flight computers.  In Redundant Apogee or Redundant Main
+         mode, the two charges will be fired two seconds apart.
+       </para>
+      </section>
+      <section>
+       <title>Pad Orientation</title>
+       <para>
+         TeleMetrum measures acceleration along the axis of the
+         board. Which way the board is oriented affects the sign of
+         the acceleration value. Instead of trying to guess which way
+         the board is mounted in the air frame, TeleMetrum must be
+         explicitly configured for either Antenna Up or Antenna
+         Down. The default, Antenna Up, expects the end of the
+         TeleMetrum board connected to the 70cm antenna to be nearest
+         the nose of the rocket, with the end containing the screw
+         terminals nearest the tail.
+       </para>
+      </section>
     </section>
 
   </chapter>
@@ -1093,31 +1178,6 @@ NAR #88757, TRA #12200
           size. A smaller value will allow more flights to be stored,
           a larger value will record data from longer flights.
        </para>
-       <para>
-         During ascent, TeleMetrum records barometer and
-         accelerometer values 100 times per second, other analog
-         information (voltages and temperature) 6 times per second
-         and GPS data once per second. During descent, the non-GPS
-         data is recorded 1/10th as often. Each barometer +
-         accelerometer record takes 8 bytes.
-       </para>
-       <para>
-         The default, 192kB, will store over 200 seconds of data at
-         the ascent rate, or over 2000 seconds of data at the descent
-         rate. That's plenty for most flights. This leaves enough
-         storage for five flights in 1MB systems, or 10 flights in 2MB 
-         systems.
-       </para>
-       <para>
-         The configuration block takes the last available block of
-         memory, on v1.0 boards that's just 256 bytes. However, the
-         flash part on the v1.1 boards uses 64kB for each block.
-        </para>
-       <para>
-          TeleMini has 5kB of on-board storage, which is plenty for a
-          single flight. Make sure you download and delete the data
-          before subsequent flights, or TeleMini will not log any data.
-       </para>
       </section>
       <section>
         <title>Ignite Mode</title>
@@ -1231,6 +1291,16 @@ NAR #88757, TRA #12200
           your local radio regulations.
         </para>
       </section>
+      <section>
+       <title>Imperial Units</title>
+       <para>
+         This switches between metric units (meters) and imperial
+         units (feet and miles). This affects the display of values
+         use during flight monitoring, data graphing and all of the
+         voice announcements. It does not change the units used when
+         exporting to CSV files, those are always produced in metric units.
+       </para>
+      </section>
       <section>
        <title>Font Size</title>
        <para>
@@ -1260,6 +1330,73 @@ NAR #88757, TRA #12200
        </para>
       </section>
     </section>
+    <section>
+      <title>Configure Groundstation</title>
+      <para>
+        Select this button and then select a TeleDongle Device from the list provided.
+      </para>
+      <para>
+        The first few lines of the dialog provide information about the
+        connected device, including the product name,
+        software version and hardware serial number. Below that are the
+        individual configuration entries.
+      </para>
+      <para>
+       Note that the TeleDongle itself doesn't save any configuration
+       data, the settings here are recorded on the local machine in
+       the Java preferences database. Moving the TeleDongle to
+       another machine, or using a different user account on the same
+       machine will cause settings made here to have no effect.
+      </para>
+      <para>
+        At the bottom of the dialog, there are three buttons:
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para>
+            Save. This writes any changes to the
+            local Java preferences file. If you don't
+            press this button, any changes you make will be lost.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Reset. This resets the dialog to the most recently saved values,
+            erasing any changes you have made.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Close. This closes the dialog. Any unsaved changes will be
+            lost.
+          </para>
+        </listitem>
+      </itemizedlist>
+      <para>
+        The rest of the dialog contains the parameters to be configured.
+      </para>
+      <section>
+        <title>Frequency</title>
+        <para>
+          This configures the frequency to use for both telemetry and
+          packet command mode. Set this before starting any operation
+          involving packet command mode so that it will use the right
+          frequency. Telemetry monitoring mode also provides a menu to
+          change the frequency, and that menu also sets the same Java
+          preference value used here.
+        </para>
+      </section>
+      <section>
+        <title>Radio Calibration</title>
+        <para>
+          The radios in every Altus Metrum device are calibrated at the
+          factory to ensure that they transmit and receive on the
+          specified frequency.  To change a TeleDongle's calibration, 
+         you must reprogram the unit completely, so this entry simply
+         shows the current value and doesn't allow any changes.
+        </para>
+      </section>
+    </section>
     <section>
       <title>Flash Image</title>
       <para>
@@ -1388,8 +1525,9 @@ NAR #88757, TRA #12200
         <para>
           In the rocket itself, you just need a <ulink url="http://www.altusmetrum.org/TeleMetrum/">TeleMetrum</ulink> or
          <ulink url="http://www.altusmetrum.org/TeleMini/">TeleMini</ulink> board and
-          a Li-Po rechargeable battery.  An 860mAh battery weighs less than a 9V
-          alkaline battery, and will run a TeleMetrum for hours.
+          a single-cell, 3.7 volt nominal Li-Po rechargeable battery.  An 
+         850mAh battery weighs less than a 9V alkaline battery, and will 
+         run a TeleMetrum for hours.
          A 110mAh battery weighs less than a triple A battery and will run a TeleMetrum for
          a few hours, or a TeleMini for much (much) longer.
         </para>
@@ -1783,7 +1921,7 @@ NAR #88757, TRA #12200
         </listitem>
         <listitem>
           Select the image you want put on the TeleMetrum, which should have a
-          name in the form telemetrum-v1.1-1.0.0.ihx.  It should be visible
+          name in the form telemetrum-v1.2-1.0.0.ihx.  It should be visible
        in the default directory, if not you may have to poke around
        your system to find it.
         </listitem>
@@ -2421,7 +2559,8 @@ NAR #88757, TRA #12200
   <appendix
       xmlns:xi="http://www.w3.org/2001/XInclude">
     <title>Release Notes</title>
-    <xi:include        href="release-notes-1.0.xsl"  xpointer="xpointer(/article/*)"/>
+    <xi:include        href="release-notes-1.1.xsl"  xpointer="xpointer(/article/*)"/>
+    <xi:include        href="release-notes-1.0.1.xsl"  xpointer="xpointer(/article/*)"/>
     <xi:include        href="release-notes-0.9.2.xsl"  xpointer="xpointer(/article/*)"/>
     <xi:include        href="release-notes-0.9.xsl"  xpointer="xpointer(/article/*)"/>
     <xi:include        href="release-notes-0.8.xsl"  xpointer="xpointer(/article/*)"/>