doc: Add warning about matching battery voltage.

[fw/altos] / doc / altusmetrum.xsl

diff --git a/doc/altusmetrum.xsl b/doc/altusmetrum.xsl
index 606c8b9945cb8985d9f4d69020b4ef6c58bb6f68..e7ab353bbd2ef171107f6f937048cc476845a657 100644 (file)
--- a/doc/altusmetrum.xsl
+++ b/doc/altusmetrum.xsl
@@ -22,7 +22,7 @@
       <surname>Towns</surname>
     </author>
     <copyright>
       <surname>Towns</surname>
     </author>
     <copyright>

-      <year>2011</year>
+      <year>2012</year>

       <holder>Bdale Garbee and Keith Packard</holder>
     </copyright>
     <legalnotice>
       <holder>Bdale Garbee and Keith Packard</holder>
     </copyright>
     <legalnotice>


@@ -35,6 +35,22 @@
       </para>
     </legalnotice>
     <revhistory>
       </para>
     </legalnotice>
     <revhistory>

+      <revision>
+       <revnumber>1.1.1</revnumber>
+       <date>16 September 2012</date>
+       <revremark>
+         Updated for software version 1.1.1 Version 1.1.1 fixes a few
+         bugs found in version 1.1.
+       </revremark>
+      </revision>
+      <revision>
+       <revnumber>1.1</revnumber>
+       <date>13 September 2012</date>
+       <revremark>
+         Updated for software version 1.1. Version 1.1 has new
+         features but is otherwise compatible with version 1.0.
+       </revremark>
+      </revision>

       <revision>
         <revnumber>1.0</revnumber>
         <date>24 August 2011</date>
       <revision>
         <revnumber>1.0</revnumber>
         <date>24 August 2011</date>


@@ -258,7 +274,21 @@ 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 
       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>
+      The battery connectors are a standard 2-pin JST connector and
+      match batteries sold by Spark Fun. These batteries are
+      single-cell Lithium Polymer batteries that nominally provide 3.7
+      volts.  Other vendors sell similar batteries for RC aircraft
+      using mating connectors, however the polarity for those is
+      generally reversed from the batteries used by Altus Metrum
+      products. In particular, the Tenergy batteries supplied for use
+      in Featherweight flight computers are not compatible with Altus
+      Metrum flight computers or battery chargers. <emphasis>Check
+      polarity and voltage before connecting any battery not purchased
+      from Altus Metrum or Spark Fun.</emphasis>

     </para>
     <para>
       By default, we use the unregulated output of the Li-Po battery directly
     </para>
     <para>
       By default, we use the unregulated output of the Li-Po battery directly


@@ -464,7 +494,7 @@ NAR #88757, TRA #12200
       <para>
         You can monitor the operation of the radio link by watching the 
         lights on the devices. The red LED will flash each time a packet
       <para>
         You can monitor the operation of the radio link by watching the 
         lights on the devices. The red LED will flash each time a packet

-        is tramsitted, while the green LED will light up on TeleDongle when 
+        is transmitted, while the green LED will light up on TeleDongle when 

         it is waiting to receive a packet from the altimeter.
       </para>
     </section>
         it is waiting to receive a packet from the altimeter.
       </para>
     </section>


@@ -586,7 +616,7 @@ NAR #88757, TRA #12200
       <section>
        <title>Maximum Flight Log</title>
        <para>
       <section>
        <title>Maximum Flight Log</title>
        <para>

-         TeleMetrum version 1.1 has 2MB of on-board flash storage,
+         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
          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


@@ -602,7 +632,7 @@ NAR #88757, TRA #12200
        </para>
        <para>
          All of the configuration data is also stored in the flash
        </para>
        <para>
          All of the configuration data is also stored in the flash

-         memory, which consumes 64kB on TeleMetrum v1.1 and 256B on
+         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>
          TeleMetrum v1.0. This configuration space is not available
          for storing flight log data.
        </para>


@@ -619,7 +649,7 @@ NAR #88757, TRA #12200
        </para>
        <para>
          The default size, 192kB, allows for 10 flights of storage on
        </para>
        <para>
          The default size, 192kB, allows for 10 flights of storage on

-         TeleMetrum v1.1 and 5 flights on TeleMetrum v1.0. This
+         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.
          ensures that you won't need to erase the memory before
          flying each time while still allowing more than sufficient
          storage for each flight.


@@ -863,14 +893,16 @@ NAR #88757, TRA #12200
          be below 10m/s when under the main parachute in a dual-deploy flight.
         </para>
         <para>
          be below 10m/s when under the main parachute in a dual-deploy flight.
         </para>
         <para>

-          For TeleMetrum altimeters, you can locate the rocket in the sky
-         using the elevation and
-          bearing information to figure out where to look. Elevation is
-          in degrees above the horizon. Bearing is reported in degrees
-          relative to true north. Range can help figure out how big the
-          rocket will appear. Note that all of these values are relative
-          to the pad location. If the elevation is near 90°, the rocket
-          is over the pad, not over you.
+          For TeleMetrum altimeters, you can locate the rocket in the
+          sky using the elevation and bearing information to figure
+          out where to look. Elevation is in degrees above the
+          horizon. Bearing is reported in degrees relative to true
+          north. Range can help figure out how big the rocket will
+          appear. Ground Distance shows how far it is to a point
+          directly under the rocket and can help figure out where the
+          rocket is likely to land. Note that all of these values are
+          relative to the pad location. If the elevation is near 90°,
+          the rocket is over the pad, not over you.

         </para>
         <para>
           Finally, the igniter voltages are reported in this tab as
         </para>
         <para>
           Finally, the igniter voltages are reported in this tab as


@@ -1290,6 +1322,16 @@ NAR #88757, TRA #12200
           your local radio regulations.
         </para>
       </section>
           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>
       <section>
        <title>Font Size</title>
        <para>


@@ -1319,6 +1361,73 @@ NAR #88757, TRA #12200
        </para>
       </section>
     </section>
        </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>
     <section>
       <title>Flash Image</title>
       <para>


@@ -1447,8 +1556,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
         <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>
          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>


@@ -1842,7 +1952,7 @@ NAR #88757, TRA #12200
         </listitem>
         <listitem>
           Select the image you want put on the TeleMetrum, which should have a
         </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>
        in the default directory, if not you may have to poke around
        your system to find it.
         </listitem>


@@ -2102,7 +2212,7 @@ NAR #88757, TRA #12200
        </listitem>
        <listitem>
          <para>
        </listitem>
        <listitem>
          <para>

-           RF interface for battery charging, configuration, and data recovery.
+           RF interface for configuration, and data recovery.

          </para>
        </listitem>
        <listitem>
          </para>
        </listitem>
        <listitem>


@@ -2480,6 +2590,8 @@ NAR #88757, TRA #12200
   <appendix
       xmlns:xi="http://www.w3.org/2001/XInclude">
     <title>Release Notes</title>
   <appendix
       xmlns:xi="http://www.w3.org/2001/XInclude">
     <title>Release Notes</title>

+    <xi:include        href="release-notes-1.1.1.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-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/*)"/>