doc: Document the Apogee Lockout setting
[fw/altos] / doc / altusmetrum.xsl
index afc7eb891d4b1895a5e6e95779957fe88c4bdee9..39b3998a5154f35e35fa9042b56222b79340e736 100644 (file)
       <year>2014</year>
       <holder>Bdale Garbee and Keith Packard</holder>
     </copyright>
+    <mediaobject>
+      <imageobject>
+       <imagedata fileref="../themes/background.png" width="6.0in"/>
+      </imageobject>
+    </mediaobject>
     <legalnotice>
       <para>
         This document is released under the terms of the
@@ -1534,10 +1539,13 @@ NAR #88757, TRA #12200
         first five seconds of operation.
       </para>
       <para>
-        At power on, you will hear three beeps or see three flashes
-        (“S” in Morse code for start up) and then a pause while
-        the altimeter completes initialization and self test, and decides 
-       which mode to enter next.
+        At power on, the altimeter will beep out the battery voltage
+        to the nearest tenth of a volt.  Each digit is represented by
+        a sequence of short “dit” beeps, with a pause between
+        digits. A zero digit is represented with one long “dah”
+        beep. Then there will be a short pause while the altimeter
+        completes initialization and self test, and decides which mode
+        to enter next.
       </para>
       <para>
        Here's a short summary of all of the modes and the beeping (or
@@ -1565,7 +1573,7 @@ NAR #88757, TRA #12200
              <row>
                <entry>Startup</entry>
                <entry>S</entry>
-               <entry>dit dit dit</entry>
+               <entry>battery voltage in decivolts</entry>
                <entry>
                  <para>
                    Calibrating sensors, detecting orientation.
@@ -2004,22 +2012,112 @@ NAR #88757, TRA #12200
         time, and would of course appreciate customer feedback on
         performance in higher altitude flights!
       </para>
+    </section>
+    <section>
+      <title>APRS</title>
       <para>
        TeleMetrum v2.0 and TeleMega can send APRS if desired, and the
        interval between APRS packets can be configured. As each APRS
        packet takes a full second to transmit, we recommend an
        interval of at least 5 seconds to avoid consuming too much
-       battery power or radio channel bandwidth.
+       battery power or radio channel bandwidth. You can configure
+       the APRS interval using AltosUI; that process is described in
+       the Configure Altimeter section of the AltosUI chapter.
+      </para>
+      <para>
+       AltOS uses the APRS compressed position report data format,
+       which provides for higher position precision and shorter
+       packets than the original APRS format. It also includes
+       altitude data, which is invaluable when tracking rockets. We
+       haven't found a receiver which doesn't handle compressed
+       positions, but it's just possible that you have one, so if you
+       have an older device that can receive the raw packets but
+       isn't displaying position information, it's possible that this
+       is the cause.
+      </para>
+      <para>
+       The APRS packet format includes a comment field that can have
+       arbitrary text in it. AltOS uses this to send status
+       information about the flight computer. It sends four fields as
+       shown in the following table.
+      </para>
+      <table frame='all'>
+       <title>Altus Metrum APRS Comments</title>
+       <?dbfo keep-together="always"?>
+       <tgroup cols='3' align='center' colsep='1' rowsep='1'>
+         <colspec align='center' colwidth='*' colname='Field'/>
+         <colspec align='center' colwidth='*' colname='Example'/>
+         <colspec align='center' colwidth='4*' colname='Description'/>
+         <thead>
+           <row>
+             <entry align='center'>Field</entry>
+             <entry align='center'>Example</entry>
+             <entry align='center'>Description</entry>
+           </row>
+         </thead>
+         <tbody>
+           <row>
+             <entry>1</entry>
+             <entry>L</entry>
+             <entry>GPS Status U for unlocked, L for locked</entry>
+           </row>
+           <row>
+             <entry>2</entry>
+             <entry>6</entry>
+             <entry>Number of Satellites in View</entry>
+           </row>
+           <row>
+             <entry>3</entry>
+             <entry>B4.0</entry>
+             <entry>Altimeter Battery Voltage</entry>
+           </row>
+           <row>
+             <entry>4</entry>
+             <entry>A3.7</entry>
+             <entry>Apogee Igniter Voltage</entry>
+           </row>
+           <row>
+             <entry>5</entry>
+             <entry>M3.7</entry>
+             <entry>Main Igniter Voltage</entry>
+           </row>
+         </tbody>
+       </tgroup>
+      </table>
+      <para>
+       Here's an example of an APRS comment showing GPS lock with 6
+       satellites in view, a primary battery at 4.0V, and
+       apogee and main igniters both at 3.7V.
+       <screen>
+         L6 B4.0 A3.7 M3.7
+       </screen>
+      </para>
+      <para>
+       Make sure your primary battery is above 3.8V, any connected
+       igniters are above 3.5V and GPS is locked with at least 5 or 6
+       satellites in view before flying. If GPS is switching between
+       L and U regularly, then it doesn't have a good lock and you
+       should wait until it becomes stable.
+      </para>
+      <para>
+       If the GPS receiver loses lock, the APRS data transmitted will
+       contain the last position for which GPS lock was
+       available. You can tell that this has happened by noticing
+       that the GPS status character switches from 'L' to 'U'. Before
+       GPS has locked, APRS will transmit zero for latitude,
+       longitude and altitude.
       </para>
     </section>
     <section>
       <title>Configurable Parameters</title>
       <para>
         Configuring an Altus Metrum altimeter for flight is very
-        simple.  Even on our baro-only TeleMini and EasyMini boards, the use of a Kalman 
-        filter means there is no need to set a “mach delay”.  The few 
-        configurable parameters can all be set using AltosUI over USB or
-        or radio link via TeleDongle.
+        simple.  Even on our baro-only TeleMini and EasyMini boards,
+        the use of a Kalman filter means there is no need to set a
+        “mach delay”.  The few configurable parameters can all be set
+        using AltosUI over USB or or radio link via TeleDongle. Read
+       the Configure Altimeter section in the AltosUI chapter below
+       for more information.
       </para>
       <section>
         <title>Radio Frequency</title>
@@ -2035,6 +2133,35 @@ NAR #88757, TRA #12200
          frequency to successfully communicate with each other.
         </para>
       </section>
+      <section>
+       <title>Callsign</title>
+       <para>
+         This sets the callsign used for telemetry, APRS and the
+         packet link. For telemetry and APRS, this is used to
+         identify the device. For the packet link, the callsign must
+         match that configured in AltosUI or the link will not
+         work. This is to prevent accidental configuration of another
+         Altus Metrum flight computer operating on the same frequency nearby.
+       </para>
+      </section>
+      <section>
+       <title>Telemetry/RDF/APRS Enable</title>
+       <para>
+         You can completely disable the radio while in flight, if
+         necessary. This doesn't disable the packet link in idle
+         mode.
+       </para>
+      </section>
+      <section>
+       <title>APRS Interval</title>
+       <para>
+         This selects how often APRS packets are transmitted. Set
+         this to zero to disable APRS without also disabling the
+         regular telemetry and RDF transmissions. As APRS takes a
+         full second to transmit a single position report, we
+         recommend sending packets no more than once every 5 seconds.
+       </para>
+      </section>
       <section>
         <title>Apogee Delay</title>
         <para>
@@ -2056,6 +2183,20 @@ NAR #88757, TRA #12200
           way quite happily, including Keith's successful L3 cert.
         </para>
       </section>
+      <section>
+       <title>Apogee Lockout</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>Main Deployment Altitude</title>
         <para>
@@ -2944,9 +3085,10 @@ NAR #88757, TRA #12200
       <section>
        <title>APRS Interval</title>
        <para>
-         How often to transmit GPS information via APRS. This option
-         is available on TeleMetrum v2 and TeleMega
-         boards. TeleMetrum v1 boards cannot transmit APRS
+         How often to transmit GPS information via APRS (in
+         seconds). When set to zero, APRS transmission is
+         disabled. This option is available on TeleMetrum v2 and
+         TeleMega boards. TeleMetrum v1 boards cannot transmit APRS
          packets. Note that a single APRS packet takes nearly a full
          second to transmit, so enabling this option will prevent
          sending any other telemetry during that time.
@@ -5002,7 +5144,8 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject id="TeleMegaTemplate">
          <imageobject>
-           <imagedata format="SVG" fileref="telemega-outline.svg"/>
+           <imagedata format="SVG" fileref="telemega.svg"
+                      scalefit="0" scale="100" align="center" />
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -5016,7 +5159,8 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject id="TeleMetrumTemplate">
          <imageobject>
-           <imagedata format="SVG" fileref="telemetrum.svg"/>
+           <imagedata format="SVG" fileref="telemetrum.svg"
+                      scalefit="0" scale="100" align="center" />
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -5030,7 +5174,8 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject id="MiniTemplate">
          <imageobject>
-           <imagedata format="SVG" fileref="easymini-outline.svg"/>
+           <imagedata format="SVG" fileref="easymini.svg"
+                      scalefit="0" scale="100" align="center" />
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -5044,7 +5189,8 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject id="TeleMiniTemplate">
          <imageobject>
-           <imagedata format="SVG" fileref="telemini.svg"/>
+           <imagedata format="SVG" fileref="telemini.svg"
+                      scalefit="0" scale="100" align="center" />
          </imageobject>
        </mediaobject>
       </informalfigure>