update copyright year assertion in MicroPeak manual, remember during releases
[fw/altos] / doc / micropeak.xsl
index aa1adaef9f57a2bc64d34033c301abe3662dd3a5..dafe36820650fa73f87da3691e7af758d74d2621 100644 (file)
@@ -3,16 +3,21 @@
   "/usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">
 <book>
   <title>MicroPeak Owner's Manual</title>
-  <subtitle>A peak-recording altimeter for hobby rocketry</subtitle>
+  <subtitle>A recording altimeter for hobby rocketry</subtitle>
   <bookinfo>
     <author>
       <firstname>Keith</firstname>
       <surname>Packard</surname>
     </author>
     <copyright>
-      <year>2012</year>
+      <year>2014</year>
       <holder>Bdale Garbee and Keith Packard</holder>
     </copyright>
+    <mediaobject>
+      <imageobject>
+       <imagedata fileref="micropeak-dime.jpg" width="6in"/>
+      </imageobject>
+    </mediaobject>
     <legalnotice>
       <para>
         This document is released under the terms of the
          Add comments about EEPROM storage format and programming jig.
        </revremark>
       </revision>
+      <revision>
+       <revnumber>1.2</revnumber>
+       <date>20 January 2013</date>
+       <revremark>
+         Add documentation for the MicroPeak USB adapter board. Note
+         the switch to a Kalman filter for peak altitude
+         determination.
+       </revremark>
+      </revision>
+      <revision>
+       <revnumber>1.3.2</revnumber>
+       <date>12 February 2014</date>
+       <revremark>
+         Add a "Download" button to the main window, which makes it
+         quicker to access the download function. Update the data
+         download documentation to reflect the new MicroPeak USB
+         adapter design. Monitor data during download to let you see
+         if the USB connection is working at all by showing the
+         characters received from the MicroPeak USB adapter.
+       </revremark>
+      </revision>
     </revhistory>
   </bookinfo>
-  <acknowledgements>
+  <dedication>
+    <title>Acknowledgements</title>
     <para>
       Thanks to John Lyngdal for suggesting that we build something like this.
     </para>
@@ -61,7 +88,7 @@ Keith Packard, KD7SQG
 NAR #88757, TRA #12200
       </literallayout>
     </para>
-  </acknowledgements>
+  </dedication>
   <chapter>
     <title>Quick Start Guide</title>
     <para>
@@ -77,6 +104,13 @@ NAR #88757, TRA #12200
          holder with the positive (+) terminal facing away from the
          circuit board.
        </para>
+       <informalfigure>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="micropeak-back.jpg" width="4.5in"/>
+           </imageobject>
+         </mediaobject>
+       </informalfigure>
       </listitem>
       <listitem>
        <para>
@@ -105,20 +139,20 @@ NAR #88757, TRA #12200
        <para>
          Finish preparing the rocket for flight. After the
          previous flight data have been reported, MicroPeak waits for
-         30 seconds before starting to check for launch. This gives
+         one minute before starting to check for launch. This gives
          you time to finish assembling the rocket. As those
          activities might cause pressure changes inside the airframe,
          MicroPeak might accidentally detect boost. If you need to do
-         anything to the airframe after the 30 second window passes,
+         anything to the airframe after the one minute window passes,
          make sure to be careful not to disturb the altimeter. The
-         LED will remain dark during the 30 second delay, but after
+         LED will remain dark during the one minute delay, but after
          that, it will start blinking once every 3 seconds.
        </para>
       </listitem>
       <listitem>
        <para>
-         Fly the rocket. Once the rocket passes about 10m in height
-         (32 feet), the micro-controller will record the ground
+         Fly the rocket. Once the rocket passes about 30m in height
+         (100 feet), the micro-controller will record the ground
          pressure and track the pressure seen during the flight. In
          this mode, the LED flickers rapidly. When the rocket lands,
          and the pressure stabilizes, the micro-controller will record
@@ -175,6 +209,303 @@ NAR #88757, TRA #12200
       charge gasses.
     </para>
   </chapter>
+  <chapter>
+    <title>The MicroPeak USB adapter</title>
+    <informalfigure>
+      <mediaobject>
+       <imageobject>
+         <imagedata fileref="MicroPeakUSB-2.0.jpg" width="4.5in"/>
+       </imageobject>
+      </mediaobject>
+    </informalfigure>
+    <para>
+      MicroPeak stores barometric pressure information for the first
+      48 seconds of the flight in on-board non-volatile memory. The
+      contents of this memory can be downloaded to a computer using
+      the MicroPeak USB adapter.
+    </para>
+    <section>
+      <title>Installing the MicroPeak software</title>
+      <para>
+       The MicroPeak application runs on Linux, Mac OS X and
+       Windows. You can download the latest version from
+       <ulink url="http://altusmetrum.org/AltOS"/>.
+      </para>
+      <para>
+       On Mac OS X and Windows, the FTDI USB device driver needs to
+       be installed. A compatible version of this driver is included
+       with the MicroPeak application, but you may want to download a
+       newer version from <ulink
+       url="http://www.ftdichip.com/FTDrivers.htm"/>.
+      </para>
+    </section>
+    <section>
+      <title>Downloading Micro Peak data</title>
+      <itemizedlist>
+       <listitem>
+         <para>
+           Plug the MicroPeak USB adapter in to your computer.
+         </para>
+       </listitem>
+       <listitem>
+         <?dbfo keep-together="always"?>
+         <para>
+           Start the MicroPeak application.
+         </para>
+         <informalfigure>
+           <mediaobject>
+             <imageobject>
+               <imagedata fileref="micropeak-nofont.svg" width="0.5in"/>
+             </imageobject>
+           </mediaobject>
+         </informalfigure>
+       </listitem>
+       <listitem>
+         <?dbfo keep-together="always"?>
+         <para>
+            Click on the Download button at the top of the window.
+         </para>
+         <informalfigure>
+           <mediaobject>
+             <imageobject>
+               <imagedata fileref="micropeak-app.png" width="4.5in"/>
+             </imageobject>
+           </mediaobject>
+         </informalfigure>
+       </listitem>
+       <listitem>
+         <?dbfo keep-together="always"?>
+         <para>
+           Select from the listed devices. There will probably be
+           only one.
+         </para>
+         <informalfigure>
+           <mediaobject>
+             <imageobject>
+               <imagedata fileref="micropeak-device-dialog.png" width="2.3in"/>
+             </imageobject>
+           </mediaobject>
+         </informalfigure>
+       </listitem>
+       <listitem>
+         <para>
+           The application will now wait until it receives valid data
+           from the MicroPeak USB adapter.
+         </para>
+         <informalfigure>
+           <mediaobject>
+             <imageobject>
+               <imagedata fileref="micropeak-download.png" width="2in"/>
+             </imageobject>
+           </mediaobject>
+         </informalfigure>
+         <para>
+           The MicroPeak USB adapter has a small phototransistor
+           under the hole in the center of the box.
+           Locate this, turn on the MicroPeak and place the orange LED on the MicroPeak
+           directly inside the hole, resting the MicroPeak itself on
+           the box. You should see the blue LED on the MicroPeak USB
+           adapter blinking in time with the orange LED on the
+           MicroPeak board itself.
+         </para>
+         <informalfigure>
+           <mediaobject>
+             <imageobject>
+               <imagedata fileref="MicroPeakUSB-2.0-inuse.jpg" width="4.5in"/>
+             </imageobject>
+           </mediaobject>
+         </informalfigure>
+       </listitem>
+       <listitem>
+         <?dbfo keep-together="always"?>
+         <para>
+           After the maximum flight height is reported, MicroPeak will
+           pause for a few seconds, blink the LED four times rapidly
+           and then send the data in one long blur on the LED. The
+           MicroPeak application should receive the data. When it does,
+           it will present the data in a graph and offer to save the
+           data to a file. If not, you can power cycle the MicroPeak
+           board and try again.
+         </para>
+         <informalfigure>
+           <mediaobject>
+             <imageobject>
+               <imagedata fileref="micropeak-save-dialog.png" width="2.3in"/>
+             </imageobject>
+           </mediaobject>
+         </informalfigure>
+       </listitem>
+       <listitem>
+         <?dbfo keep-together="always"?>
+         <para>
+           Once the data are saved, a graph will be displayed with
+           height, speed and acceleration values computed from the
+           recorded barometric pressure data. See the next section
+           for more details on that.
+         </para>
+       </listitem>
+      </itemizedlist>
+    </section>
+    <section>
+      <title>Analyzing MicroPeak Data</title>
+      <para>
+       The MicroPeak application can present flight data in the form
+       of a graph, a collection of computed statistics or in tabular
+       form.
+      </para>
+      <para>
+       MicroPeak collects raw barometric pressure data which is
+       then used to compute the remaining data. Altitude is computed
+       through a standard atmospheric model. Absolute error in this
+       data will be affected by local atmospheric
+       conditions. Fortunately, these errors tend to mostly cancel
+       out, so the error in the height computation is much smaller
+       than the error in altitude would be.
+      </para>
+      <para>
+       Speed and acceleration are computed by first smoothing the
+       height data with a Gaussian window averaging filter. For speed
+       data, this average uses seven samples. For acceleration data,
+       eleven samples are used. These were chosen to provide
+       reasonably smooth speed and acceleration data, which would
+       otherwise be swamped with noise.
+      </para>
+      <para>
+       The File menu has operations to open existing flight logs,
+       Download new data from MicroPeak, Save a copy of the flight
+       log to a new file, Export the tabular data (as seen in the Raw
+       Data tab) to a file, change the application Preferences, Close
+       the current window or close all windows and Exit the
+       application.
+      </para>
+      <section>
+       <title>MicroPeak Graphs</title>
+       <para>
+         Under the Graph tab, the height, speed and acceleration values
+         are displayed together. You can zoom in on the graph by
+         clicking and dragging to sweep out an area of
+         interest. Right-click on the plot to bring up a menu that will
+         let you save, copy or print the graph.
+       </para>
+       <informalfigure>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="micropeak-graph.png" width="4.5in"/>
+           </imageobject>
+         </mediaobject>
+       </informalfigure>
+      </section>
+      <section>
+       <title>MicroPeak Flight Statistics</title>
+       <para>
+         The Statistics tab presents overall data from the flight. Note
+         that the Maximum height value is taken from the minumum
+         pressure captured in flight, and may be different from the
+         apparant apogee value as the on-board data are sampled twice
+         as fast as the recorded values, or because the true apogee
+         occurred after the on-board memory was full. Each value is
+         presented in several units as appropriate.
+       </para>
+       <informalfigure>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="micropeak-statistics.png" width="4.5in"/>
+           </imageobject>
+         </mediaobject>
+       </informalfigure>
+      </section>
+      <section>
+       <title>Raw Data</title>
+       <para>
+         A table consisting of the both the raw barometric pressure
+         data and values computed from that for each recorded time.
+       </para>
+       <informalfigure>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="micropeak-raw-data.png" width="4.5in"/>
+           </imageobject>
+         </mediaobject>
+       </informalfigure>
+      </section>
+      <section>
+       <title>Configuring the Graph</title>
+       <para>
+         This selects which graph elements to show, and lets you
+         switch between metric and imperial units
+       </para>
+       <informalfigure>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="micropeak-graph-configure.png" width="4.5in"/>
+           </imageobject>
+         </mediaobject>
+       </informalfigure>
+      </section>
+    </section>
+    <section>
+      <title>Setting MicroPeak Preferences</title>
+      <informalfigure>
+       <mediaobject>
+         <imageobject>
+           <imagedata fileref="micropeak-preferences.png" width="1.8in"/>
+         </imageobject>
+       </mediaobject>
+      </informalfigure>
+      <para>
+       The MicroPeak application has a few user settings which are
+       configured through the Preferences dialog, which can be
+       accessed from the File menu.
+      <itemizedlist>
+       <listitem>
+         <para>
+           The Log Directory is where flight data will be saved to
+           and loaded from by default. Of course, you can always
+           navigate to other directories in the file chooser windows,
+           this setting is just the starting point.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           If you prefer to see your graph data in feet and
+           miles per hour instead of meters and meters per second,
+           you can select Imperial Units.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           To see what data is actually arriving over the serial
+           port, start the MicroPeak application from a command
+           prompt and select the Serial Debug option. This can be
+           useful in debugging serial communication problems, but
+           most people need never choose this.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           You can adjust the size of the text in the Statistics tab
+           by changing the Font size preference. There are three
+           settings, with luck one will both fit on your screen and
+           provide readable values.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           The Look &amp; feel menu shows a list of available
+           application appearance choices. By default, the MicroPeak
+           application tries to blend in with other applications, but
+           you may choose some other appearance if you like.
+         </para>
+       </listitem>
+      </itemizedlist>
+      </para>
+      <para>
+       Note that MicroPeak shares a subset of the AltosUI
+       preferences, so if you use both of these applications, change
+       in one application will affect the other.
+      </para>
+    </section>
+  </chapter>
   <chapter>
     <title>Technical Information</title>
     <section>
@@ -192,9 +523,11 @@ NAR #88757, TRA #12200
       </para>
       <para>
        Ground pressure is computed from an average of 16 samples,
-       taken while the altimeter is at rest. Flight pressure is
-       computed from an exponential IIR filter designed to smooth out
-       transients caused by mechanical stress on the barometer.
+       taken while the altimeter is at rest. The flight pressure used to
+       report maximum height is computed from a Kalman filter
+       designed to smooth out any minor noise in the sensor
+       values. The flight pressure recorded to non-volatile storage
+       is unfiltered, coming directly from the pressure sensor.
       </para>
     </section>
     <section>
@@ -216,7 +549,7 @@ NAR #88757, TRA #12200
     <section>
       <title>Lithium Battery</title>
       <para>
-       The CR1025 battery used by MicroPeak holes 30mAh of power,
+       The CR1025 battery used by MicroPeak holds 30mAh of power,
        which is sufficient to run for over 40 hours. Because
        MicroPeak powers down on landing, run time includes only time
        sitting on the launch pad or during flight.
@@ -241,14 +574,14 @@ NAR #88757, TRA #12200
       <para>
        MicroPeak contains a fixed atmospheric model which is used to
        convert barometric pressure into altitude. The model was
-       converted into a 469-element piece wise linear approximation
+       converted into a 469-element piece-wise linear approximation
        which is then used to compute the altitude of the ground and
        apogee. The difference between these represents the maximum
        height of the flight.
       </para>
       <para>
        The model assumes a particular set of atmospheric conditions,
-       which while a reasonable average cannot represent the changing
+       which, while a reasonable average, cannot represent the changing
        nature of the real atmosphere. Fortunately, for flights
        reasonably close to the ground, the effect of this global
        inaccuracy are largely canceled out when the computed ground
@@ -256,6 +589,11 @@ NAR #88757, TRA #12200
        the resulting height is more accurate than either the ground
        or apogee altitudes.
       </para>
+      <para>
+       Because the raw pressure data is recorded to non-volatile
+       storage, you can use that, along with a more sophisticated
+       atmospheric model, to compute your own altitude values.
+      </para>
     </section>
     <section>
       <title>Mechanical Considerations</title>
@@ -292,8 +630,9 @@ NAR #88757, TRA #12200
       <para>
        In addition to the data used to present the height of the last
        flight, MicroPeak also stores barometric information sampled
-       at regular intervals during the flight. This information can
-       be extracted from MicroPeak through any AVR programming
+       at regular intervals during the flight. This is the
+       information captured with the MicroPeak USB adapter. It can
+       also be read from MicroPeak through any AVR programming
        tool.
       </para>
       <table frame='all'>