doc: Add 1.3.2 release notes
[fw/altos] / doc / altusmetrum.xsl
index dfe89438f99398eebbcaf35b3c0a18e7f9641e8b..d96e8f4fb585afb3eab3c4fea566479925a93d12 100644 (file)
@@ -22,7 +22,7 @@
       <surname>Towns</surname>
     </author>
     <copyright>
-      <year>2013</year>
+      <year>2014</year>
       <holder>Bdale Garbee and Keith Packard</holder>
     </copyright>
     <legalnotice>
       </para>
     </legalnotice>
     <revhistory>
+      <revision>
+       <revnumber>1.3.2</revnumber>
+       <date>24 January 2014</date>
+       <revremark>
+         Bug fixes for TeleMega and AltosUI.
+       </revremark>
+      </revision>
+      <revision>
+       <revnumber>1.3.1</revnumber>
+       <date>21 January 2014</date>
+       <revremark>
+         Bug fixes for TeleMega and TeleMetrum v2.0 along with a few
+         small UI improvements.
+       </revremark>
+      </revision>
       <revision>
        <revnumber>1.3</revnumber>
        <date>12 November 2013</date>
@@ -835,17 +850,144 @@ NAR #88757, TRA #12200
         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
+       flashing, in the case of TeleMini v1) that accompanies each
+       mode. In the description of the beeping pattern, “dit” means a
+       short beep while "dah" means a long beep (three times as
+       long). “Brap” means a long dissonant tone.
+       <table frame='all'>
+         <title>AltOS Modes</title>
+         <?dbfo keep-together="always"?>
+         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
+           <colspec align='center' colwidth='*' colname='Mode Name'/>
+           <colspec align='center' colwidth='*' colname='Letter'/>
+           <colspec align='center' colwidth='*' colname='Beeps'/>
+           <colspec align='center' colwidth='*' colname='Description'/>
+           <thead>
+             <row>
+               <entry>Mode Name</entry>
+               <entry>Abbreviation</entry>
+               <entry>Beeps</entry>
+               <entry>Description</entry>
+             </row>
+           </thead>
+           <tbody>
+             <row>
+               <entry>Startup</entry>
+               <entry>S</entry>
+               <entry>dit dit dit</entry>
+               <entry>
+                 <para>
+                   Calibrating sensors, detecting orientation.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Idle</entry>
+               <entry>I</entry>
+               <entry>dit dit</entry>
+               <entry>
+                 <para>
+                   Ready to accept commands over USB or radio link.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Pad</entry>
+               <entry>P</entry>
+               <entry>dit dah dah dit</entry>
+               <entry>
+                 <para>
+                   Waiting for launch. Not listening for commands.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Boost</entry>
+               <entry>B</entry>
+               <entry>dah dit dit dit</entry>
+               <entry>
+                 <para>
+                   Accelerating upwards.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Fast</entry>
+               <entry>F</entry>
+               <entry>dit dit dah dit</entry>
+               <entry>
+                 <para>
+                   Decellerating, but moving faster than 200m/s.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Coast</entry>
+               <entry>C</entry>
+               <entry>dah dit dah dit</entry>
+               <entry>
+                 <para>
+                   Decellerating, moving slower than 200m/s
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Drogue</entry>
+               <entry>D</entry>
+               <entry>dah dit dit</entry>
+               <entry>
+                 <para>
+                   Descending after apogee. Above main height.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Main</entry>
+               <entry>M</entry>
+               <entry>dah dah</entry>
+               <entry>
+                 <para>
+                   Descending. Below main height.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Landed</entry>
+               <entry>L</entry>
+               <entry>dit dah dit dit</entry>
+               <entry>
+                 <para>
+                   Stable altitude for at least ten seconds.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Sensor error</entry>
+               <entry>X</entry>
+               <entry>dah dit dit dah</entry>
+               <entry>
+                 <para>
+                   Error detected during sensor calibration.
+                 </para>
+               </entry>
+             </row>
+           </tbody>
+         </tgroup>
+       </table>
+      </para>
       <para>
         In flight or “pad” mode, the altimeter engages the flight
-        state machine, goes into transmit-only mode to
-        send telemetry, and waits for launch to be detected.
-        Flight mode is indicated by an “di-dah-dah-dit” (“P” for pad)
-        on the beeper or lights, followed by beeps or flashes
-        indicating the state of the pyrotechnic igniter continuity.
-        One beep/flash indicates apogee continuity, two beeps/flashes
-        indicate main continuity, three beeps/flashes indicate both
-        apogee and main continuity, and one longer “brap” sound or
-        rapidly alternating lights indicates no continuity.  For a
+        state machine, goes into transmit-only mode to send telemetry,
+        and waits for launch to be detected.  Flight mode is indicated
+        by an “di-dah-dah-dit” (“P” for pad) on the beeper or lights,
+        followed by beeps or flashes indicating the state of the
+        pyrotechnic igniter continuity.  One beep/flash indicates
+        apogee continuity, two beeps/flashes indicate main continuity,
+        three beeps/flashes indicate both apogee and main continuity,
+        and one longer “brap” sound which is made by rapidly
+        alternating between two tones indicates no continuity.  For a
         dual deploy flight, make sure you're getting three beeps or
         flashes before launching!  For apogee-only or motor eject
         flights, do what makes sense.
@@ -862,6 +1004,93 @@ NAR #88757, TRA #12200
         data from the on-board storage chip after flight, and for
         ground testing pyro charges.
       </para>
+      <para>
+       In “Idle” and “Pad” modes, once the mode indication
+       beeps/flashes and continuity indication has been sent, if
+       there is no space available to log the flight in on-board
+       memory, the flight computer will emit a warbling tone (much
+       slower than the “no continuity tone”)
+      </para>
+      <para>
+       Here's a summary of all of the “pad” and “idle” mode indications.
+       <table frame='all'>
+         <title>Pad/Idle Indications</title>
+         <?dbfo keep-together="always"?>
+         <tgroup cols='3' align='center' colsep='1' rowsep='1'>
+           <colspec align='center' colwidth='*' colname='Name'/>
+           <colspec align='center' colwidth='*' colname='Beeps'/>
+           <colspec align='center' colwidth='*' colname='Description'/>
+           <thead>
+             <row>
+               <entry>Name</entry>
+               <entry>Beeps</entry>
+               <entry>Description</entry>
+             </row>
+           </thead>
+           <tbody>
+             <row>
+               <entry>Neither</entry>
+               <entry>brap</entry>
+               <entry>
+                 <para>
+                   No continuity detected on either apogee or main
+                   igniters.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Apogee</entry>
+               <entry>dit</entry>
+               <entry>
+                 <para>
+                   Continuity detected only on apogee igniter.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Main</entry>
+               <entry>dit dit</entry>
+               <entry>
+                 <para>
+                   Continuity detected only on main igniter.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Both</entry>
+               <entry>dit dit dit</entry>
+               <entry>
+                 <para>
+                   Continuity detected on both igniters.
+                 </para>
+               </entry>
+             </row>
+             <row>
+               <entry>Storage Full</entry>
+               <entry>warble</entry>
+               <entry>
+                 <para>
+                   On-board data logging storage is full. This will
+                   not prevent the flight computer from safely
+                   controlling the flight or transmitting telemetry
+                   signals, but no record of the flight will be
+                   stored in on-board flash.
+                 </para>
+               </entry>
+             </row>
+           </tbody>
+         </tgroup>
+       </table>
+      </para>
+      <para>
+       Once landed, the flight computer will signal that by emitting
+       the “Landed” sound described above, after which it will beep
+       out the apogee height (in meters). 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. The flight computer will continue to report landed mode
+       and beep out the maximum height until turned off.
+      </para>
       <para>
         One “neat trick” of particular value when TeleMetrum or TeleMega are used with 
         very large air-frames, is that you can power the board up while the 
@@ -1364,7 +1593,7 @@ NAR #88757, TRA #12200
     <informalfigure>
       <mediaobject>
        <imageobject>
-         <imagedata fileref="altosui.png" width="5.5in"/>
+         <imagedata fileref="altosui.png" width="4.6in"/>
        </imageobject>
       </mediaobject>
     </informalfigure>
@@ -1389,7 +1618,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="device-selection.png" width="3.5in"/>
+           <imagedata fileref="device-selection.png" width="3.1in"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -1573,10 +1802,10 @@ NAR #88757, TRA #12200
           rocket as it heads towards apogee.
         </para>
         <para>
-          The height, speed and acceleration are shown along with the
-          maximum values for each of them. This allows you to quickly
-          answer the most commonly asked questions you'll hear during
-          flight.
+          The height, speed, acceleration and tilt are shown along
+          with the maximum values for each of them. This allows you to
+          quickly answer the most commonly asked questions you'll hear
+          during flight.
         </para>
         <para>
           The current latitude and longitude reported by the GPS are
@@ -1801,7 +2030,7 @@ NAR #88757, TRA #12200
        <informalfigure>
          <mediaobject>
            <imageobject>
-             <imagedata fileref="graph.png" width="5.5in" scalefit="1"/>
+             <imagedata fileref="graph.png" width="6in" scalefit="1"/>
            </imageobject>
          </mediaobject>
        </informalfigure>
@@ -1823,7 +2052,7 @@ NAR #88757, TRA #12200
        <informalfigure>
          <mediaobject>
            <imageobject>
-             <imagedata fileref="graph-configure.png" width="5.5in" scalefit="1"/>
+             <imagedata fileref="graph-configure.png" width="6in" scalefit="1"/>
            </imageobject>
          </mediaobject>
        </informalfigure>
@@ -1838,7 +2067,7 @@ NAR #88757, TRA #12200
        <informalfigure>
          <mediaobject>
            <imageobject>
-             <imagedata fileref="graph-stats.png" width="5.5in" scalefit="1"/>
+             <imagedata fileref="graph-stats.png" width="6in" scalefit="1"/>
            </imageobject>
          </mediaobject>
        </informalfigure>
@@ -1851,7 +2080,7 @@ NAR #88757, TRA #12200
        <informalfigure>
          <mediaobject>
            <imageobject>
-             <imagedata fileref="graph-map.png" width="5.5in" scalefit="1"/>
+             <imagedata fileref="graph-map.png" width="6in" scalefit="1"/>
            </imageobject>
          </mediaobject>
        </informalfigure>
@@ -1908,7 +2137,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="configure-altimeter.png" width="3in" scalefit="1"/>
+           <imagedata fileref="configure-altimeter.png" width="3.6in" scalefit="1"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -2165,7 +2394,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="configure-altosui.png" width="2.5in" scalefit="1"/>
+           <imagedata fileref="configure-altosui.png" width="2.4in" scalefit="1"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -2275,7 +2504,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="configure-groundstation.png" width="3in" scalefit="1"/>
+           <imagedata fileref="configure-groundstation.png" width="3.1in" scalefit="1"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -2370,7 +2599,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="fire-igniter.png" width="1in" scalefit="1"/>
+           <imagedata fileref="fire-igniter.png" width="1.2in" scalefit="1"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -2384,8 +2613,8 @@ NAR #88757, TRA #12200
       <para>
        Selecting the 'Fire Igniter' button brings up the usual device
        selection dialog. Pick the desired device. This brings up another 
-       window which shows the current continuity test status for both 
-       apogee and main charges.
+       window which shows the current continuity test status for all
+       of the pyro channels.
       </para>
       <para>
        Next, select the desired igniter to fire. This will enable the
@@ -2404,7 +2633,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="scan-channels.png" width="2.75in" scalefit="1"/>
+           <imagedata fileref="scan-channels.png" width="3.2in" scalefit="1"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -2422,7 +2651,7 @@ NAR #88757, TRA #12200
       <informalfigure>
        <mediaobject>
          <imageobject>
-           <imagedata fileref="load-maps.png" width="5.5in" scalefit="1"/>
+           <imagedata fileref="load-maps.png" width="5.2in" scalefit="1"/>
          </imageobject>
        </mediaobject>
       </informalfigure>
@@ -3972,11 +4201,12 @@ NAR #88757, TRA #12200
           Then, divide 434.550 MHz by the
           measured frequency and multiply by the current radio cal value show
           in the 'c s' command.  For an unprogrammed board, the default value
-          is 1186611.  Take the resulting integer and program it using the 'c f'
+          is 1186611 for cc1111 based products and 7119667 for cc1120
+         based products.  Take the resulting integer and program it using the 'c f'
           command.  Testing with the 'C' command again should show a carrier
           within a few tens of Hertz of the intended frequency.
           As with all 'c' sub-commands, follow this with a 'c w' to write the
-          change to the parameter block in the on-board DataFlash chip.
+          change to the configuration memory.
         </para>
     <para>
       Note that the 'reboot' command, which is very useful on the altimeters,
@@ -4233,6 +4463,20 @@ NAR #88757, TRA #12200
   </appendix>
   <appendix>
     <title>Release Notes</title>
+    <simplesect>
+      <title>Version 1.3.2</title>
+      <xi:include
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         href="release-notes-1.3.2.xsl"
+         xpointer="xpointer(/article/*)"/>
+    </simplesect>
+    <simplesect>
+      <title>Version 1.3.1</title>
+      <xi:include
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         href="release-notes-1.3.1.xsl"
+         xpointer="xpointer(/article/*)"/>
+    </simplesect>
     <simplesect>
       <title>Version 1.3</title>
       <xi:include