doc: Document how to get TeleMini to 'emergency recovery' mode
[fw/altos] / doc / altusmetrum.xsl
index aa218c5cc598fffa26f33479ecc2cc8d2816a4d6..e696da7933f2f2ac4ffeacbdfe2fd9a228e339d3 100644 (file)
@@ -22,7 +22,7 @@
       <surname>Towns</surname>
     </author>
     <copyright>
-      <year>2012</year>
+      <year>2013</year>
       <holder>Bdale Garbee and Keith Packard</holder>
     </copyright>
     <legalnotice>
@@ -122,7 +122,7 @@ NAR #88757, TRA #12200
       support optional capabilities in the future.
     </para>
     <para>
-      The newest device is TeleMini, a dual deploy altimeter with
+      Our second device was TeleMini, a dual deploy altimeter with
       radio telemetry and radio direction finding. This device is only
       13mm by 38mm (½ inch by 1½ inches) and can fit easily in an 18mm 
       air-frame.
@@ -172,8 +172,9 @@ NAR #88757, TRA #12200
     <para>
       The TeleMini battery can be charged by disconnecting it from the
       TeleMini board and plugging it into a standalone battery charger 
-      board, and connecting that via a USB cable to a laptop or other USB
-      power source
+      such as the LipoCharger product included in TeleMini Starter Kits, 
+      and connecting that via a USB cable to a laptop or other USB
+      power source.  
     </para>
     <para>
       The other active device in the starter kit is the TeleDongle USB to
@@ -279,14 +280,16 @@ NAR #88757, TRA #12200
     </para>
     <para>
       The battery connectors are a standard 2-pin JST connector and
-      match batteries sold by Spark Fun. 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 before connecting any battery
-      not purchased from Altus Metrum or Spark Fun.</emphasis>
+      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
@@ -383,6 +386,36 @@ NAR #88757, TRA #12200
         tower with a screw-driver trying to turn on your avionics before 
         installing igniters!
       </para>
+      <para>
+       TeleMini is configured via the radio link. Of course, that
+       means you need to know the TeleMini radio configuration values
+       or you won't be able to communicate with it. For situations
+       when you don't have the radio configuration values, TeleMini
+       offers an 'emergency recovery' mode. In this mode, TeleMini is
+       configured as follows:
+       <itemizedlist>
+         <listitem>
+           Sets the radio frequency to 434.550MHz
+         </listitem>
+         <listitem>
+           Sets the radio calibration back to the factory value.
+         </listitem>
+         <listitem>
+           Sets the callsign to N0CALL
+         </listitem>
+         <listitem>
+           Does not go to 'pad' mode after five seconds.
+         </listitem>
+       </itemizedlist>
+      </para>
+      <para>
+       To get into 'emergency recovery' mode, first find the row of
+       four small holes opposite the switch wiring. Using a short
+       piece of small gauge wire, connect the outer two holes
+       together, then power TeleMini up. Once the red LED is lit,
+       disconnect the wire and the board should signal that it's in
+       'idle' mode after the initial five second startup period.
+      </para>
     </section>
     <section>
       <title>GPS </title>
@@ -492,7 +525,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
-        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>
@@ -767,6 +800,15 @@ NAR #88757, TRA #12200
             incorrect data from being reported.
           </para>
         </listitem>
+        <listitem>
+          <para>
+            The age of the displayed data, in seconds since the last 
+           successfully received telemetry packet.  In normal operation
+           this will stay in the low single digits.  If the number starts
+           counting up, then you are no longer receiving data over the radio
+           link from the flight computer.
+          </para>
+        </listitem>
       </itemizedlist>
       <para>
         Finally, the largest portion of the window contains a set of
@@ -1572,7 +1614,9 @@ NAR #88757, TRA #12200
         <title>On the Ground</title>
         <para>
           To receive the data stream from the rocket, you need an antenna and short
-          feed-line connected to one of our <ulink url="http://www.altusmetrum.org/TeleDongle/">TeleDongle</ulink> units.  The
+          feed-line connected to one of our <ulink url="http://www.altusmetrum.org/TeleDongle/">TeleDongle</ulink> units.  If possible, use an SMA to BNC 
+       adapter instead of feedline between the antenna feedpoint and 
+       TeleDongle, as this will give you the best performance.  The
           TeleDongle in turn plugs directly into the USB port on a notebook
           computer.  Because TeleDongle looks like a simple serial port, your computer
           does not require special device drivers... just plug it in.
@@ -1609,7 +1653,7 @@ NAR #88757, TRA #12200
           So, to recap, on the ground the hardware you'll need includes:
           <orderedlist inheritnum='inherit' numeration='arabic'>
             <listitem>
-              an antenna and feed-line
+              an antenna and feed-line or adapter
             </listitem>
             <listitem>
               a TeleDongle
@@ -1632,7 +1676,9 @@ NAR #88757, TRA #12200
             Arrow Antennas.
           </ulink>
           The 440-3 and 440-5 are both good choices for finding a
-          TeleMetrum- or TeleMini- equipped rocket when used with a suitable 70cm HT.
+          TeleMetrum- or TeleMini- equipped rocket when used with a suitable 
+         70cm HT.  TeleDongle and an SMA to BNC adapter fit perfectly
+         between the driven element and reflector of Arrow antennas.
         </para>
       </section>
       <section>
@@ -1658,22 +1704,36 @@ NAR #88757, TRA #12200
       <section>
         <title>Future Plans</title>
         <para>
-          In the future, we intend to offer "companion boards" for the rocket that will
-          plug in to TeleMetrum to collect additional data, provide more pyro channels,
-          and so forth.  
+          In the future, we intend to offer "companion boards" for the rocket 
+         that will plug in to TeleMetrum to collect additional data, provide 
+         more pyro channels, and so forth.  
+        </para>
+        <para>
+         Also under design is a new flight computer with more sensors, more
+         pyro channels, and a more powerful radio system designed for use
+         in multi-stage, complex, and extreme altitude projects.
+        </para>
+        <para>
+          We are also working on alternatives to TeleDongle.  One is a
+         a stand-alone, hand-held ground terminal that will allow monitoring 
+         the rocket's status, collecting data during flight, and logging data 
+         after flight without the need for a notebook computer on the
+          flight line.  Particularly since it is so difficult to read most 
+         notebook screens in direct sunlight, we think this will be a great 
+         thing to have.  We are also working on a TeleDongle variant with
+         Bluetooth that will work with Android phones and tablets.
         </para>
         <para>
-          We are also working on the design of a hand-held ground terminal that will
-          allow monitoring the rocket's status, collecting data during flight, and
-          logging data after flight without the need for a notebook computer on the
-          flight line.  Particularly since it is so difficult to read most notebook
-          screens in direct sunlight, we think this will be a great thing to have.
+          Because all of our work is open, both the hardware designs and the 
+         software, if you have some great idea for an addition to the current 
+         Altus Metrum family, feel free to dive in and help!  Or let us know 
+         what you'd like to see that we aren't already working on, and maybe 
+         we'll get excited about it too...
         </para>
         <para>
-          Because all of our work is open, both the hardware designs and the software,
-          if you have some great idea for an addition to the current Altus Metrum family,
-          feel free to dive in and help!  Or let us know what you'd like to see that
-          we aren't already working on, and maybe we'll get excited about it too...
+         Watch our 
+         <ulink url="http://altusmetrum.org/">web site</ulink> for more news 
+         and information as our family of products evolves!
         </para>
     </section>
   </chapter>
@@ -2480,6 +2540,37 @@ NAR #88757, TRA #12200
       once you enable the voice output!
     </para>
   </appendix>
+  <appendix>
+    <title>Drill Templates</title>
+    <para>
+      These images, when printed, provide precise templates for the
+      mounting holes in Altus Metrum flight computers
+    </para>
+    <section>
+      <title>TeleMetrum template</title>
+      <para>
+       TeleMetrum has overall dimensions of 1.000 x 2.750 inches, and the
+       mounting holes are sized for use with 4-40 or M3 screws.
+      </para>
+      <mediaobject id="TeleMetrumTemplate">
+       <imageobject>
+         <imagedata format="SVG" fileref="telemetrum.svg"/>
+       </imageobject>
+      </mediaobject>
+    </section>
+    <section>
+      <title>TeleMini template</title>
+      <para>
+       TeleMini has overall dimensions of 0.500 x 1.500 inches, and the
+       mounting holes are sized for use with 2-56 or M2 screws.
+      </para>
+      <mediaobject id="TeleMiniTemplate">
+       <imageobject>
+         <imagedata format="SVG" fileref="telemini.svg"/>
+       </imageobject>
+      </mediaobject>
+    </section>
+  </appendix>
   <appendix>
       <title>Calibration</title>
       <para>
@@ -2588,13 +2679,13 @@ NAR #88757, TRA #12200
   <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-0.8.xsl"  xpointer="xpointer(/article/*)"/>
-    <xi:include        href="release-notes-0.7.1.xsl"  xpointer="xpointer(/article/*)"/>
+    <simplesect><title>Version 1.1.1</title><xi:include        href="release-notes-1.1.1.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
+    <simplesect><title>Version 1.1</title><xi:include  href="release-notes-1.1.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
+    <simplesect><title>Version 1.0.1</title><xi:include        href="release-notes-1.0.1.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
+    <simplesect><title>Version 0.9.2</title><xi:include        href="release-notes-0.9.2.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
+    <simplesect><title>Version 0.9</title><xi:include  href="release-notes-0.9.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
+    <simplesect><title>Version 0.8</title><xi:include  href="release-notes-0.8.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
+    <simplesect><title>Version 0.7.1</title><xi:include        href="release-notes-0.7.1.xsl"  xpointer="xpointer(/article/*)"/></simplesect>
   </appendix>
 </book>