update documentation to reflect reality that modifying a board or separate
[fw/altos] / doc / altusmetrum.xsl
1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3   "/usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">
4 <book>
5   <title>The Altus Metrum System</title>
6   <subtitle>An Owner's Manual for TeleMetrum and TeleDongle Devices</subtitle>
7   <bookinfo>
8     <author>
9       <firstname>Bdale</firstname>
10       <surname>Garbee</surname>
11     </author>
12     <author>
13       <firstname>Keith</firstname>
14       <surname>Packard</surname>
15     </author>
16     <author>
17       <firstname>Bob</firstname>
18       <surname>Finch</surname>
19     </author>
20     <author>
21       <firstname>Anthony</firstname>
22       <surname>Towns</surname>
23     </author>
24     <copyright>
25       <year>2010</year>
26       <holder>Bdale Garbee and Keith Packard</holder>
27     </copyright>
28     <legalnotice>
29       <para>
30         This document is released under the terms of the
31         <ulink url="http://creativecommons.org/licenses/by-sa/3.0/">
32           Creative Commons ShareAlike 3.0
33         </ulink>
34         license.
35       </para>
36     </legalnotice>
37     <revhistory>
38       <revision>
39         <revnumber>0.8</revnumber>
40         <date>24 November 2010</date>
41         <revremark>Updated for software version 0.8 </revremark>
42       </revision>
43     </revhistory>
44   </bookinfo>
45   <acknowledgements>
46     <para>
47       Thanks to Bob Finch, W9YA, NAR 12965, TRA 12350 for writing "The
48       Mere-Mortals Quick Start/Usage Guide to the Altus Metrum Starter
49       Kit" which has turned into the Getting Started chapter in this
50       book. Bob was one of our first customers for a production
51       TeleMetrum, and the enthusiasm that led to his contribution of
52       this section is immensely gratifying and highy appreciated!
53     </para>
54     <para>
55       And thanks to Anthony (AJ) Towns for contributing the
56       AltosUI graphing and site map code and documentation. Free
57       software means that our customers and friends can become our
58       collaborators, and we certainly appreciate this level of
59       contribution.
60     </para>
61     <para>
62       Have fun using these products, and we hope to meet all of you
63       out on the rocket flight line somewhere.
64       <literallayout>
65 Bdale Garbee, KB0G
66 NAR #87103, TRA #12201
67
68 Keith Packard, KD7SQG
69 NAR #88757, TRA #12200
70       </literallayout>
71     </para>
72   </acknowledgements>
73   <chapter>
74     <title>Introduction and Overview</title>
75     <para>
76       Welcome to the Altus Metrum community!  Our circuits and software reflect
77       our passion for both hobby rocketry and Free Software.  We hope their
78       capabilities and performance will delight you in every way, but by
79       releasing all of our hardware and software designs under open licenses,
80       we also hope to empower you to take as active a role in our collective
81       future as you wish!
82     </para>
83     <para>
84       The focal point of our community is TeleMetrum, a dual deploy altimeter
85       with fully integrated GPS and radio telemetry as standard features, and
86       a "companion interface" that will support optional capabilities in the
87       future.
88     </para>
89     <para>
90       Complementing TeleMetrum is TeleDongle, a USB to RF interface for
91       communicating with TeleMetrum.  Combined with your choice of antenna and
92       notebook computer, TeleDongle and our associated user interface software
93       form a complete ground station capable of logging and displaying in-flight
94       telemetry, aiding rocket recovery, then processing and archiving flight
95       data for analysis and review.
96     </para>
97     <para>
98       More products will be added to the Altus Metrum family over time, and
99       we currently envision that this will be a single, comprehensive manual
100       for the entire product family.
101     </para>
102   </chapter>
103   <chapter>
104     <title>Getting Started</title>
105     <para>
106       The first thing to do after you check the inventory of parts in your
107       "starter kit" is to charge the battery by plugging it into the
108       corresponding socket of the TeleMetrum and then using the USB A to
109       mini B
110       cable to plug the Telemetrum into your computer's USB socket. The
111       TeleMetrum circuitry will charge the battery whenever it is plugged
112       in, because the TeleMetrum's on-off switch does NOT control the
113       charging circuitry.  When the GPS chip is initially searching for
114       satellites, TeleMetrum will consume more current than it can pull
115       from the usb port, so the battery must be attached in order to get
116       satellite lock.  Once GPS is locked, the current consumption goes back
117       down enough to enable charging while
118       running. So it's a good idea to fully charge the battery as your
119       first item of business so there is no issue getting and maintaining
120       satellite lock.  The yellow charge indicator led will go out when the
121       battery is nearly full and the charger goes to trickle charge. It
122       can take several hours to fully recharge a deeply discharged battery.
123     </para>
124     <para>
125       The other active device in the starter kit is the TeleDongle USB to
126       RF interface.  If you plug it in to your Mac or Linux computer it should
127       "just work", showing up as a serial port device.  Windows systems need
128       driver information that is part of the AltOS download to know that the
129       existing USB modem driver will work.  If you are using Linux and are
130       having problems, try moving to a fresher kernel (2.6.33 or newer), as
131       the USB serial driver had ugly bugs in some earlier versions.
132     </para>
133     <para>
134       Next you should obtain and install the AltOS utilities.  These include
135       the AltosUI ground station program, current firmware images for
136       TeleMetrum and TeleDongle, and a number of standalone utilities that
137       are rarely needed.  Pre-built binary packages are available for Debian
138       Linux, Microsoft Windows, and recent MacOSX versions.  Full sourcecode
139       and build instructions for some other Linux variants are also available.
140       The latest version may always be downloaded from
141       <ulink url="http://altusmetrum.org/AltOS"/>.
142     </para>
143     <para>
144       Both Telemetrum and TeleDongle can be directly communicated
145       with using USB ports. The first thing you should try after getting
146       both units plugged into to your computer's usb port(s) is to run
147       'ao-list' from a terminal-window to see what port-device-name each
148       device has been assigned by the operating system.
149       You will need this information to access the devices via their
150       respective on-board firmware and data using other command line
151       programs in the AltOS software suite.
152     </para>
153     <para>
154       To access the device's firmware for configuration you need a terminal
155       program such as you would use to talk to a modem.  The software
156       authors prefer using the program 'cu' which comes from the UUCP package
157       on most Unix-like systems such as Linux.  An example command line for
158       cu might be 'cu -l /dev/ttyACM0', substituting the correct number
159       indicated from running the
160       ao-list program.  Another reasonable terminal program for Linux is
161       'cutecom'.  The default 'escape'
162       character used by CU (i.e. the character you use to
163       issue commands to cu itself instead of sending the command as input
164       to the connected device) is a '~'. You will need this for use in
165       only two different ways during normal operations. First is to exit
166       the program by sending a '~.' which is called a 'escape-disconnect'
167       and allows you to close-out from 'cu'. The
168       second use will be outlined later.
169     </para>
170     <para>
171       Both TeleMetrum and TeleDongle share the concept of a two level
172       command set in their firmware.
173       The first layer has several single letter commands. Once
174       you are using 'cu' (or 'cutecom') sending (typing) a '?'
175       returns a full list of these
176       commands. The second level are configuration sub-commands accessed
177       using the 'c' command, for
178       instance typing 'c?' will give you this second level of commands
179       (all of which require the
180       letter 'c' to access).  Please note that most configuration options
181       are stored only in DataFlash memory, and only TeleMetrum has this
182       memory to save the various values entered like the channel number
183       and your callsign when powered off.  TeleDongle requires that you
184       set these each time you plug it in, which ao-view can help with.
185     </para>
186     <para>
187       Try setting these config ('c' or second level menu) values.  A good
188       place to start is by setting your call sign.  By default, the boards
189       use 'N0CALL' which is cute, but not exactly legal!
190       Spend a few minutes getting comfortable with the units, their
191       firmware, and 'cu' (or possibly 'cutecom').
192       For instance, try to send
193       (type) a 'c r 2' and verify the channel change by sending a 'c s'.
194       Verify you can connect and disconnect from the units while in your
195       terminal program by sending the escape-disconnect mentioned above.
196     </para>
197     <para>
198       Note that the 'reboot' command, which is very useful on TeleMetrum,
199       will likely just cause problems with the dongle.  The *correct* way
200       to reset the dongle is just to unplug and re-plug it.
201     </para>
202     <para>
203       A fun thing to do at the launch site and something you can do while
204       learning how to use these units is to play with the rf-link access
205       of the TeleMetrum from the TeleDongle.  Be aware that you *must* create
206       some physical separation between the devices, otherwise the link will
207       not function due to signal overload in the receivers in each device.
208     </para>
209     <para>
210       Now might be a good time to take a break and read the rest of this
211       manual, particularly about the two "modes" that the TeleMetrum
212       can be placed in and how the position of the TeleMetrum when booting
213       up will determine whether the unit is in "pad" or "idle" mode.
214     </para>
215     <para>
216       You can access a TeleMetrum in idle mode from the Teledongle's USB
217       connection using the rf link
218       by issuing a 'p' command to the TeleDongle. Practice connecting and
219       disconnecting ('~~' while using 'cu') from the TeleMetrum.  If
220       you cannot escape out of the "p" command, (by using a '~~' when in
221       CU) then it is likely that your kernel has issues.  Try a newer version.
222     </para>
223     <para>
224       Using this rf link allows you to configure the TeleMetrum, test
225       fire e-matches and igniters from the flight line, check pyro-match
226       continuity and so forth. You can leave the unit turned on while it
227       is in 'idle mode' and then place the
228       rocket vertically on the launch pad, walk away and then issue a
229       reboot command.  The TeleMetrum will reboot and start sending data
230       having changed to the "pad" mode. If the TeleDongle is not receiving
231       this data, you can disconnect 'cu' from the Teledongle using the
232       procedures mentioned above and THEN connect to the TeleDongle from
233       inside 'ao-view'. If this doesn't work, disconnect from the
234       TeleDongle, unplug it, and try again after plugging it back in.
235     </para>
236     <para>
237       Eventually the GPS will find enough satellites, lock in on them,
238       and 'ao-view' will both auditorially announce and visually indicate
239       that GPS is ready.
240       Now you can launch knowing that you have a good data path and
241       good satellite lock for flight data and recovery.  Remember
242       you MUST tell ao-view to connect to the TeleDongle explicitly in
243       order for ao-view to be able to receive data.
244     </para>
245     <para>
246       Both RDF (radio direction finding) tones from the TeleMetrum and
247       GPS trekking data are available and together are very useful in
248       locating the rocket once it has landed. (The last good GPS data
249       received before touch-down will be on the data screen of 'ao-view'.)
250     </para>
251     <para>
252       Once you have recovered the rocket you can download the eeprom
253       contents using either 'ao-dumplog' (or possibly 'ao-eeprom'), over
254       either a USB cable or over the radio link using TeleDongle.
255       And by following the man page for 'ao-postflight' you can create
256       various data output reports, graphs, and even kml data to see the
257       flight trajectory in google-earth. (Moving the viewing angle making
258       sure to connect the yellow lines while in google-earth is the proper
259       technique.)
260     </para>
261     <para>
262       As for ao-view.... some things are in the menu but don't do anything
263       very useful.  The developers have stopped working on ao-view to focus
264       on a new, cross-platform ground station program.  So ao-view may or
265       may not be updated in the future.  Mostly you just use
266       the Log and Device menus.  It has a wonderful display of the incoming
267       flight data and I am sure you will enjoy what it has to say to you
268       once you enable the voice output!
269     </para>
270     <section>
271       <title>FAQ</title>
272       <para>
273         The altimeter (TeleMetrum) seems to shut off when disconnected from the
274         computer.  Make sure the battery is adequately charged.  Remember the
275         unit will pull more power than the USB port can deliver before the
276         GPS enters "locked" mode.  The battery charges best when TeleMetrum
277         is turned off.
278       </para>
279       <para>
280         It's impossible to stop the TeleDongle when it's in "p" mode, I have
281         to unplug the USB cable?  Make sure you have tried to "escape out" of
282         this mode.  If this doesn't work the reboot procedure for the
283         TeleDongle *is* to simply unplug it. 'cu' however will retain it's
284         outgoing buffer IF your "escape out" ('~~') does not work.
285         At this point using either 'ao-view' (or possibly
286         'cutemon') instead of 'cu' will 'clear' the issue and allow renewed
287         communication.
288       </para>
289       <para>
290         The amber LED (on the TeleMetrum/altimeter) lights up when both
291         battery and USB are connected. Does this mean it's charging?
292         Yes, the yellow LED indicates the charging at the 'regular' rate.
293         If the led is out but the unit is still plugged into a USB port,
294         then the battery is being charged at a 'trickle' rate.
295       </para>
296       <para>
297         There are no "dit-dah-dah-dit" sound like the manual mentions?
298         That's the "pad" mode.  Weak batteries might be the problem.
299         It is also possible that the unit is horizontal and the output
300         is instead a "dit-dit" meaning 'idle'.
301       </para>
302       <para>
303         It's unclear how to use 'ao-view' and other programs when 'cu'
304         is running. You cannot have more than one program connected to
305         the TeleDongle at one time without apparent data loss as the
306         incoming data will not make it to both programs intact.
307         Disconnect whatever programs aren't currently being used.
308       </para>
309       <para>
310         How do I save flight data?
311         Live telemetry is written to file(s) whenever 'ao-view' is connected
312         to the TeleDongle.  The file area defaults to ~/altos
313         but is easily changed using the menus in 'ao-view'. The files that
314         are written end in '.telem'. The after-flight
315         data-dumped files will end in .eeprom and represent continuous data
316         unlike the rf-linked .telem files that are subject to the
317         turnarounds/data-packaging time slots in the half-duplex rf data path.
318         See the above instructions on what and how to save the eeprom stored
319         data after physically retrieving your TeleMetrum.  Make sure to save
320         the on-board data after each flight, as the current firmware will
321         over-write any previous flight data during a new flight.
322       </para>
323     </section>
324   </chapter>
325   <chapter>
326     <title>Specifications</title>
327     <itemizedlist>
328       <listitem>
329         <para>
330           Recording altimeter for model rocketry.
331         </para>
332       </listitem>
333       <listitem>
334         <para>
335           Supports dual deployment (can fire 2 ejection charges).
336         </para>
337       </listitem>
338       <listitem>
339         <para>
340           70cm ham-band transceiver for telemetry downlink.
341         </para>
342       </listitem>
343       <listitem>
344         <para>
345           Barometric pressure sensor good to 45k feet MSL.
346         </para>
347       </listitem>
348       <listitem>
349         <para>
350           1-axis high-g accelerometer for motor characterization, capable of
351           +/- 50g using default part.
352         </para>
353       </listitem>
354       <listitem>
355         <para>
356           On-board, integrated GPS receiver with 5hz update rate capability.
357         </para>
358       </listitem>
359       <listitem>
360         <para>
361           On-board 1 megabyte non-volatile memory for flight data storage.
362         </para>
363       </listitem>
364       <listitem>
365         <para>
366           USB interface for battery charging, configuration, and data recovery.
367         </para>
368       </listitem>
369       <listitem>
370         <para>
371           Fully integrated support for LiPo rechargeable batteries.
372         </para>
373       </listitem>
374       <listitem>
375         <para>
376           Uses LiPo to fire e-matches, can be modiied to support 
377           optional separate pyro battery if needed.
378         </para>
379       </listitem>
380       <listitem>
381         <para>
382           2.75 x 1 inch board designed to fit inside 29mm airframe coupler tube.
383         </para>
384       </listitem>
385     </itemizedlist>
386   </chapter>
387   <chapter>
388     <title>Handling Precautions</title>
389     <para>
390       TeleMetrum is a sophisticated electronic device.  When handled gently and
391       properly installed in an airframe, it will deliver impressive results.
392       However, like all electronic devices, there are some precautions you
393       must take.
394     </para>
395     <para>
396       The Lithium Polymer rechargeable batteries used with TeleMetrum have an
397       extraordinary power density.  This is great because we can fly with
398       much less battery mass than if we used alkaline batteries or previous
399       generation rechargeable batteries... but if they are punctured
400       or their leads are allowed to short, they can and will release their
401       energy very rapidly!
402       Thus we recommend that you take some care when handling our batteries
403       and consider giving them some extra protection in your airframe.  We
404       often wrap them in suitable scraps of closed-cell packing foam before
405       strapping them down, for example.
406     </para>
407     <para>
408       The TeleMetrum barometric sensor is sensitive to sunlight.  In normal
409       mounting situations, it and all of the other surface mount components
410       are "down" towards whatever the underlying mounting surface is, so
411       this is not normally a problem.  Please consider this, though, when
412       designing an installation, for example, in a 29mm airframe with a
413       see-through plastic payload bay.
414     </para>
415     <para>
416       The TeleMetrum barometric sensor sampling port must be able to
417       "breathe",
418       both by not being covered by foam or tape or other materials that might
419       directly block the hole on the top of the sensor, but also by having a
420       suitable static vent to outside air.
421     </para>
422     <para>
423       As with all other rocketry electronics, TeleMetrum must be protected
424       from exposure to corrosive motor exhaust and ejection charge gasses.
425     </para>
426   </chapter>
427   <chapter>
428     <title>Hardware Overview</title>
429     <para>
430       TeleMetrum is a 1 inch by 2.75 inch circuit board.  It was designed to
431       fit inside coupler for 29mm airframe tubing, but using it in a tube that
432       small in diameter may require some creativity in mounting and wiring
433       to succeed!  The default 1/4
434       wave UHF wire antenna attached to the center of the nose-cone end of
435       the board is about 7 inches long, and wiring for a power switch and
436       the e-matches for apogee and main ejection charges depart from the
437       fin can end of the board.  Given all this, an ideal "simple" avionics
438       bay for TeleMetrum should have at least 10 inches of interior length.
439     </para>
440     <para>
441       A typical TeleMetrum installation using the on-board GPS antenna and
442       default wire UHF antenna involves attaching only a suitable
443       Lithium Polymer battery, a single pole switch for power on/off, and
444       two pairs of wires connecting e-matches for the apogee and main ejection
445       charges.
446     </para>
447     <para>
448       By default, we use the unregulated output of the LiPo battery directly
449       to fire ejection charges.  This works marvelously with standard
450       low-current e-matches like the J-Tek from MJG Technologies, and with
451       Quest Q2G2 igniters.  However, if you
452       want or need to use a separate pyro battery, the board can be factory
453       modified to do so.  This involves cutting two traces and adding a jumper
454       in a densely populated part of the board on TeleMetrum v1.0 and v1.1,
455       along with installation of a pyro battery connector at location B2.
456     </para>
457     <para>
458       We offer two choices of pyro and power switch connector, or you can
459       choose neither and solder wires directly to the board.  All three choices
460       are reasonable depending on the constraints of your airframe.  Our
461       favorite option when there is sufficient room above the board is to use
462       the Tyco pin header with polarization and locking.  If you choose this
463       option, you crimp individual wires for the power switch and e-matches
464       into a mating connector, and installing and removing the TeleMetrum
465       board from an airframe is as easy as plugging or unplugging two
466       connectors.  If the airframe will not support this much height or if
467       you want to be able to directly attach e-match leads to the board, we
468       offer a screw terminal block.  This is very similar to what most other
469       altimeter vendors provide and so may be the most familiar option.
470       You'll need a very small straight blade screwdriver to connect
471       and disconnect the board in this case, such as you might find in a
472       jeweler's screwdriver set.  Finally, you can forego both options and
473       solder wires directly to the board, which may be the best choice for
474       minimum diameter and/or minimum mass designs.
475     </para>
476     <para>
477       For most airframes, the integrated GPS antenna and wire UHF antenna are
478       a great combination.  However, if you are installing in a carbon-fiber
479       electronics bay which is opaque to RF signals, you may need to use
480       off-board external antennas instead.  In this case, you can order
481       TeleMetrum with an SMA connector for the UHF antenna connection, and
482       you can unplug the integrated GPS antenna and select an appropriate
483       off-board GPS antenna with cable terminating in a U.FL connector.
484     </para>
485   </chapter>
486   <chapter>
487     <title>System Operation</title>
488     <section>
489       <title>Firmware Modes </title>
490       <para>
491         The AltOS firmware build for TeleMetrum has two fundamental modes,
492         "idle" and "flight".  Which of these modes the firmware operates in
493         is determined by the orientation of the rocket (well, actually the
494         board, of course...) at the time power is switched on.  If the rocket
495         is "nose up", then TeleMetrum assumes it's on a rail or rod being
496         prepared for launch, so the firmware chooses flight mode.  However,
497         if the rocket is more or less horizontal, the firmware instead enters
498         idle mode.
499       </para>
500       <para>
501         At power on, you will hear three beeps
502         ("S" in Morse code for startup) and then a pause while
503         TeleMetrum completes initialization and self tests, and decides which
504         mode to enter next.
505       </para>
506       <para>
507         In flight or "pad" mode, TeleMetrum turns on the GPS system,
508         engages the flight
509         state machine, goes into transmit-only mode on the RF link sending
510         telemetry, and waits for launch to be detected.  Flight mode is
511         indicated by an audible "di-dah-dah-dit" ("P" for pad) on the
512         beeper, followed by
513         beeps indicating the state of the pyrotechnic igniter continuity.
514         One beep indicates apogee continuity, two beeps indicate
515         main continuity, three beeps indicate both apogee and main continuity,
516         and one longer "brap" sound indicates no continuity.  For a dual
517         deploy flight, make sure you're getting three beeps before launching!
518         For apogee-only or motor eject flights, do what makes sense.
519       </para>
520       <para>
521         In idle mode, you will hear an audible "di-dit" ("I" for idle), and
522         the normal flight state machine is disengaged, thus
523         no ejection charges will fire.  TeleMetrum also listens on the RF
524         link when in idle mode for packet mode requests sent from TeleDongle.
525         Commands can be issued to a TeleMetrum in idle mode over either
526         USB or the RF link equivalently.
527         Idle mode is useful for configuring TeleMetrum, for extracting data
528         from the on-board storage chip after flight, and for ground testing
529         pyro charges.
530       </para>
531       <para>
532         One "neat trick" of particular value when TeleMetrum is used with very
533         large airframes, is that you can power the board up while the rocket
534         is horizontal, such that it comes up in idle mode.  Then you can
535         raise the airframe to launch position, use a TeleDongle to open
536         a packet connection, and issue a 'reset' command which will cause
537         TeleMetrum to reboot, realize it's now nose-up, and thus choose
538         flight mode.  This is much safer than standing on the top step of a
539         rickety step-ladder or hanging off the side of a launch tower with
540         a screw-driver trying to turn on your avionics before installing
541         igniters!
542       </para>
543     </section>
544     <section>
545       <title>GPS </title>
546       <para>
547         TeleMetrum includes a complete GPS receiver.  See a later section for
548         a brief explanation of how GPS works that will help you understand
549         the information in the telemetry stream.  The bottom line is that
550         the TeleMetrum GPS receiver needs to lock onto at least four
551         satellites to obtain a solid 3 dimensional position fix and know
552         what time it is!
553       </para>
554       <para>
555         TeleMetrum provides backup power to the GPS chip any time a LiPo
556         battery is connected.  This allows the receiver to "warm start" on
557         the launch rail much faster than if every power-on were a "cold start"
558         for the GPS receiver.  In typical operations, powering up TeleMetrum
559         on the flight line in idle mode while performing final airframe
560         preparation will be sufficient to allow the GPS receiver to cold
561         start and acquire lock.  Then the board can be powered down during
562         RSO review and installation on a launch rod or rail.  When the board
563         is turned back on, the GPS system should lock very quickly, typically
564         long before igniter installation and return to the flight line are
565         complete.
566       </para>
567     </section>
568     <section>
569       <title>Ground Testing </title>
570       <para>
571         An important aspect of preparing a rocket using electronic deployment
572         for flight is ground testing the recovery system.  Thanks
573         to the bi-directional RF link central to the Altus Metrum system,
574         this can be accomplished in a TeleMetrum-equipped rocket without as
575         much work as you may be accustomed to with other systems.  It can
576         even be fun!
577       </para>
578       <para>
579         Just prep the rocket for flight, then power up TeleMetrum while the
580         airframe is horizontal.  This will cause the firmware to go into
581         "idle" mode, in which the normal flight state machine is disabled and
582         charges will not fire without manual command.  Then, establish an
583         RF packet connection from a TeleDongle-equipped computer using the
584         P command from a safe distance.  You can now command TeleMetrum to
585         fire the apogee or main charges to complete your testing.
586       </para>
587       <para>
588         In order to reduce the chance of accidental firing of pyrotechnic
589         charges, the command to fire a charge is intentionally somewhat
590         difficult to type, and the built-in help is slightly cryptic to
591         prevent accidental echoing of characters from the help text back at
592         the board from firing a charge.  The command to fire the apogee
593         drogue charge is 'i DoIt drogue' and the command to fire the main
594         charge is 'i DoIt main'.
595       </para>
596     </section>
597     <section>
598       <title>Radio Link </title>
599       <para>
600         The chip our boards are based on incorporates an RF transceiver, but
601         it's not a full duplex system... each end can only be transmitting or
602         receiving at any given moment.  So we had to decide how to manage the
603         link.
604       </para>
605       <para>
606         By design, TeleMetrum firmware listens for an RF connection when
607         it's in "idle mode" (turned on while the rocket is horizontal), which
608         allows us to use the RF link to configure the rocket, do things like
609         ejection tests, and extract data after a flight without having to
610         crack open the airframe.  However, when the board is in "flight
611         mode" (turned on when the rocket is vertical) the TeleMetrum only
612         transmits and doesn't listen at all.  That's because we want to put
613         ultimate priority on event detection and getting telemetry out of
614         the rocket and out over
615         the RF link in case the rocket crashes and we aren't able to extract
616         data later...
617       </para>
618       <para>
619         We don't use a 'normal packet radio' mode because they're just too
620         inefficient.  The GFSK modulation we use is just FSK with the
621         baseband pulses passed through a
622         Gaussian filter before they go into the modulator to limit the
623         transmitted bandwidth.  When combined with the hardware forward error
624         correction support in the cc1111 chip, this allows us to have a very
625         robust 38.4 kilobit data link with only 10 milliwatts of transmit power,
626         a whip antenna in the rocket, and a hand-held Yagi on the ground.  We've
627         had flights to above 21k feet AGL with good reception, and calculations
628         suggest we should be good to well over 40k feet AGL with a 5-element yagi on
629         the ground.  We hope to fly boards to higher altitudes soon, and would
630         of course appreciate customer feedback on performance in higher
631         altitude flights!
632       </para>
633     </section>
634     <section>
635       <title>Configurable Parameters</title>
636       <para>
637         Configuring a TeleMetrum board for flight is very simple.  Because we
638         have both acceleration and pressure sensors, there is no need to set
639         a "mach delay", for example.  The few configurable parameters can all
640         be set using a simple terminal program over the USB port or RF link
641         via TeleDongle.
642       </para>
643       <section>
644         <title>Radio Channel</title>
645         <para>
646           Our firmware supports 10 channels.  The default channel 0 corresponds
647           to a center frequency of 434.550 Mhz, and channels are spaced every
648           100 khz.  Thus, channel 1 is 434.650 Mhz, and channel 9 is 435.550 Mhz.
649           At any given launch, we highly recommend coordinating who will use
650           each channel and when to avoid interference.  And of course, both
651           TeleMetrum and TeleDongle must be configured to the same channel to
652           successfully communicate with each other.
653         </para>
654         <para>
655           To set the radio channel, use the 'c r' command, like 'c r 3' to set
656           channel 3.
657           As with all 'c' sub-commands, follow this with a 'c w' to write the
658           change to the parameter block in the on-board DataFlash chip on
659           your TeleMetrum board if you want the change to stay in place across reboots.
660         </para>
661       </section>
662       <section>
663         <title>Apogee Delay</title>
664         <para>
665           Apogee delay is the number of seconds after TeleMetrum detects flight
666           apogee that the drogue charge should be fired.  In most cases, this
667           should be left at the default of 0.  However, if you are flying
668           redundant electronics such as for an L3 certification, you may wish
669           to set one of your altimeters to a positive delay so that both
670           primary and backup pyrotechnic charges do not fire simultaneously.
671         </para>
672         <para>
673           To set the apogee delay, use the 'c d' command.
674           As with all 'c' sub-commands, follow this with a 'c w' to write the
675           change to the parameter block in the on-board DataFlash chip.
676         </para>
677         <para>
678           Please note that the TeleMetrum apogee detection algorithm always
679           fires a fraction of a second *after* apogee.  If you are also flying
680           an altimeter like the PerfectFlite MAWD, which only supports selecting
681           0 or 1 seconds of apogee delay, you may wish to set the MAWD to 0
682           seconds delay and set the TeleMetrum to fire your backup 2 or 3
683           seconds later to avoid any chance of both charges firing
684           simultaneously.  We've flown several airframes this way quite happily,
685           including Keith's successful L3 cert.
686         </para>
687       </section>
688       <section>
689         <title>Main Deployment Altitude</title>
690         <para>
691           By default, TeleMetrum will fire the main deployment charge at an
692           elevation of 250 meters (about 820 feet) above ground.  We think this
693           is a good elevation for most airframes, but feel free to change this
694           to suit.  In particular, if you are flying two altimeters, you may
695           wish to set the
696           deployment elevation for the backup altimeter to be something lower
697           than the primary so that both pyrotechnic charges don't fire
698           simultaneously.
699         </para>
700         <para>
701           To set the main deployment altitude, use the 'c m' command.
702           As with all 'c' sub-commands, follow this with a 'c w' to write the
703           change to the parameter block in the on-board DataFlash chip.
704         </para>
705       </section>
706     </section>
707     <section>
708       <title>Calibration</title>
709       <para>
710         There are only two calibrations required for a TeleMetrum board, and
711         only one for TeleDongle.
712       </para>
713       <section>
714         <title>Radio Frequency</title>
715         <para>
716           The radio frequency is synthesized from a clock based on the 48 Mhz
717           crystal on the board.  The actual frequency of this oscillator must be
718           measured to generate a calibration constant.  While our GFSK modulation
719           bandwidth is wide enough to allow boards to communicate even when
720           their oscillators are not on exactly the same frequency, performance
721           is best when they are closely matched.
722           Radio frequency calibration requires a calibrated frequency counter.
723           Fortunately, once set, the variation in frequency due to aging and
724           temperature changes is small enough that re-calibration by customers
725           should generally not be required.
726         </para>
727         <para>
728           To calibrate the radio frequency, connect the UHF antenna port to a
729           frequency counter, set the board to channel 0, and use the 'C'
730           command to generate a CW carrier.  Wait for the transmitter temperature
731           to stabilize and the frequency to settle down.
732           Then, divide 434.550 Mhz by the
733           measured frequency and multiply by the current radio cal value show
734           in the 'c s' command.  For an unprogrammed board, the default value
735           is 1186611.  Take the resulting integer and program it using the 'c f'
736           command.  Testing with the 'C' command again should show a carrier
737           within a few tens of Hertz of the intended frequency.
738           As with all 'c' sub-commands, follow this with a 'c w' to write the
739           change to the parameter block in the on-board DataFlash chip.
740         </para>
741       </section>
742       <section>
743         <title>Accelerometer</title>
744         <para>
745           The accelerometer we use has its own 5 volt power supply and
746           the output must be passed through a resistive voltage divider to match
747           the input of our 3.3 volt ADC.  This means that unlike the barometric
748           sensor, the output of the acceleration sensor is not ratiometric to
749           the ADC converter, and calibration is required.  We also support the
750           use of any of several accelerometers from a Freescale family that
751           includes at least +/- 40g, 50g, 100g, and 200g parts.  Using gravity,
752           a simple 2-point calibration yields acceptable results capturing both
753           the different sensitivities and ranges of the different accelerometer
754           parts and any variation in power supply voltages or resistor values
755           in the divider network.
756         </para>
757         <para>
758           To calibrate the acceleration sensor, use the 'c a 0' command.  You
759           will be prompted to orient the board vertically with the UHF antenna
760           up and press a key, then to orient the board vertically with the
761           UHF antenna down and press a key.
762           As with all 'c' sub-commands, follow this with a 'c w' to write the
763           change to the parameter block in the on-board DataFlash chip.
764         </para>
765         <para>
766           The +1g and -1g calibration points are included in each telemetry
767           frame and are part of the header extracted by ao-dumplog after flight.
768           Note that we always store and return raw ADC samples for each
769           sensor... nothing is permanently "lost" or "damaged" if the
770           calibration is poor.
771         </para>
772         <para>
773          In the unlikely event an accel cal that goes badly, it is possible
774          that TeleMetrum may always come up in 'pad mode' and as such not be
775          listening to either the USB or radio interfaces.  If that happens,
776          there is a special hook in the firmware to force the board back
777          in to 'idle mode' so you can re-do the cal.  To use this hook, you
778          just need to ground the SPI clock pin at power-on.  This pin is
779          available as pin 2 on the 8-pin companion connector, and pin 1 is
780          ground.  So either carefully install a fine-gauge wire jumper
781          between the two pins closest to the index hole end of the 8-pin
782          connector, or plug in the programming cable to the 8-pin connector
783          and use a small screwdriver or similar to short the two pins closest
784          to the index post on the 4-pin end of the programming cable, and
785          power up the board.  It should come up in 'idle mode' (two beeps).
786         </para>
787       </section>
788     </section>
789
790
791
792   <section>
793     <title>Updating Device Firmware</title>
794     <para>
795       The big conceptual thing to realize is that you have to use a
796       TeleDongle as a programmer to update a TeleMetrum, and vice versa.
797       Due to limited memory resources in the cc1111, we don't support
798       programming either unit directly over USB.
799     </para>
800     <para>
801       You may wish to begin by ensuring you have current firmware images.
802       These are distributed as part of the AltOS software bundle that
803       also includes the AltosUI ground station program.  Newer ground
804       station versions typically work fine with older firmware versions,
805       so you don't need to update your devices just to try out new
806       software features.  You can always download the most recent
807       version from <ulink url="http://www.altusmetrum.org/AltOS/"/>.
808     </para>
809     <para>
810       We recommend updating TeleMetrum first, before updating TeleDongle.
811     </para>
812     <section>
813       <title>Updating TeleMetrum Firmware</title>
814       <orderedlist inheritnum='inherit' numeration='arabic'>
815         <listitem>
816           Find the 'programming cable' that you got as part of the starter
817           kit, that has a red 8-pin MicroMaTch connector on one end and a
818           red 4-pin MicroMaTch connector on the other end.
819         </listitem>
820         <listitem>
821           Take the 2 screws out of the TeleDongle case to get access
822           to the circuit board.
823         </listitem>
824         <listitem>
825           Plug the 8-pin end of the programming cable to the
826           matching connector on the TeleDongle, and the 4-pin end to the
827           matching connector on the TeleMetrum.
828           Note that each MicroMaTch connector has an alignment pin that
829           goes through a hole in the PC board when you have the cable
830           oriented correctly.
831         </listitem>
832         <listitem>
833           Attach a battery to the TeleMetrum board.
834         </listitem>
835         <listitem>
836           Plug the TeleDongle into your computer's USB port, and power
837           up the TeleMetrum.
838         </listitem>
839         <listitem>
840           Run AltosUI, and select 'Flash Image' from the File menu.
841         </listitem>
842         <listitem>
843           Pick the TeleDongle device from the list, identifying it as the
844           programming device.
845         </listitem>
846         <listitem>
847           Select the image you want put on the TeleMetrum, which should have a
848           name in the form telemetrum-v1.0-0.7.1.ihx.  It should be visible
849         in the default directory, if not you may have to poke around
850         your system to find it.
851         </listitem>
852         <listitem>
853           Make sure the configuration parameters are reasonable
854           looking. If the serial number and/or RF configuration
855           values aren't right, you'll need to change them.
856         </listitem>
857         <listitem>
858           Hit the 'OK' button and the software should proceed to flash
859           the TeleMetrum with new firmware, showing a progress bar.
860         </listitem>
861         <listitem>
862           Confirm that the TeleMetrum board seems to have updated ok, which you
863           can do by plugging in to it over USB and using a terminal program
864           to connect to the board and issue the 'v' command to check
865           the version, etc.
866         </listitem>
867         <listitem>
868           If something goes wrong, give it another try.
869         </listitem>
870       </orderedlist>
871     </section>
872     <section>
873       <title>Updating TeleDongle Firmware</title>
874       <para>
875         Updating TeleDongle's firmware is just like updating TeleMetrum
876         firmware, but you switch which board is the programmer and which
877         is the programming target.
878         </para>
879       <orderedlist inheritnum='inherit' numeration='arabic'>
880         <listitem>
881           Find the 'programming cable' that you got as part of the starter
882           kit, that has a red 8-pin MicroMaTch connector on one end and a
883           red 4-pin MicroMaTch connector on the other end.
884         </listitem>
885         <listitem>
886           Find the USB cable that you got as part of the starter kit, and
887           plug the "mini" end in to the mating connector on TeleMetrum.
888         </listitem>
889         <listitem>
890           Take the 2 screws out of the TeleDongle case to get access
891           to the circuit board.
892         </listitem>
893         <listitem>
894           Plug the 8-pin end of the programming cable to the (latching)
895           matching connector on the TeleMetrum, and the 4-pin end to the
896           matching connector on the TeleDongle.
897           Note that each MicroMaTch connector has an alignment pin that
898           goes through a hole in the PC board when you have the cable
899           oriented correctly.
900         </listitem>
901         <listitem>
902           Attach a battery to the TeleMetrum board.
903         </listitem>
904         <listitem>
905           Plug both TeleMetrum and TeleDongle into your computer's USB
906           ports, and power up the TeleMetrum.
907         </listitem>
908         <listitem>
909           Run AltosUI, and select 'Flash Image' from the File menu.
910         </listitem>
911         <listitem>
912           Pick the TeleMetrum device from the list, identifying it as the
913           programming device.
914         </listitem>
915         <listitem>
916           Select the image you want put on the TeleDongle, which should have a
917           name in the form teledongle-v0.2-0.7.1.ihx.  It should be visible
918         in the default directory, if not you may have to poke around
919         your system to find it.
920         </listitem>
921         <listitem>
922           Make sure the configuration parameters are reasonable
923           looking. If the serial number and/or RF configuration
924           values aren't right, you'll need to change them.  The TeleDongle
925           serial number is on the "bottom" of the circuit board, and can
926           usually be read through the translucent blue plastic case without
927           needing to remove the board from the case.
928         </listitem>
929         <listitem>
930           Hit the 'OK' button and the software should proceed to flash
931           the TeleDongle with new firmware, showing a progress bar.
932         </listitem>
933         <listitem>
934           Confirm that the TeleDongle board seems to have updated ok, which you
935           can do by plugging in to it over USB and using a terminal program
936           to connect to the board and issue the 'v' command to check
937           the version, etc.  Once you're happy, remove the programming cable
938           and put the cover back on the TeleDongle.
939         </listitem>
940         <listitem>
941           If something goes wrong, give it another try.
942         </listitem>
943       </orderedlist>
944       <para>
945         Be careful removing the programming cable from the locking 8-pin
946         connector on TeleMetrum.  You'll need a fingernail or perhaps a thin
947         screwdriver or knife blade to gently pry the locking ears out
948         slightly to extract the connector.  We used a locking connector on
949         TeleMetrum to help ensure that the cabling to companion boards
950         used in a rocket don't ever come loose accidentally in flight.
951       </para>
952     </section>
953   </section>
954
955
956
957   </chapter>
958   <chapter>
959
960     <title>AltosUI</title>
961     <para>
962       The AltosUI program provides a graphical user interface for
963       interacting with the Altus Metrum product family, including
964       TeleMetrum and TeleDongle. AltosUI can monitor telemetry data,
965       configure TeleMetrum and TeleDongle devices and many other
966       tasks. The primary interface window provides a selection of
967       buttons, one for each major activity in the system.  This manual
968       is split into chapters, each of which documents one of the tasks
969       provided from the top-level toolbar.
970     </para>
971     <section>
972       <title>Packet Command Mode</title>
973       <subtitle>Controlling TeleMetrum Over The Radio Link</subtitle>
974       <para>
975         One of the unique features of the Altus Metrum environment is
976         the ability to create a two way command link between TeleDongle
977         and TeleMetrum using the digital radio transceivers built into
978         each device. This allows you to interact with TeleMetrum from
979         afar, as if it were directly connected to the computer.
980       </para>
981       <para>
982         Any operation which can be performed with TeleMetrum
983         can either be done with TeleMetrum directly connected to
984         the computer via the USB cable, or through the packet
985         link. Simply select the appropriate TeleDongle device when
986         the list of devices is presented and AltosUI will use packet
987         command mode.
988       </para>
989       <para>
990         One oddity in the current interface is how AltosUI selects the
991         channel for packet mode communications. Instead of providing
992         an interface to specifically configure the channel, it uses
993         whatever channel was most recently selected for the target
994         TeleDongle device in Monitor Flight mode. If you haven't ever
995         used that mode with the TeleDongle in question, select the
996         Monitor Flight button from the top level UI, pick the
997         appropriate TeleDongle device. Once the flight monitoring
998         window is open, select the desired channel and then close it
999         down again. All Packet Command Mode operations will now use
1000         that channel.
1001       </para>
1002       <itemizedlist>
1003         <listitem>
1004           <para>
1005             Save Flight Data—Recover flight data from the rocket without
1006             opening it up.
1007           </para>
1008         </listitem>
1009         <listitem>
1010           <para>
1011             Configure TeleMetrum—Reset apogee delays or main deploy
1012             heights to respond to changing launch conditions. You can
1013             also 'reboot' the TeleMetrum device. Use this to remotely
1014             enable the flight computer by turning TeleMetrum on while
1015             horizontal, then once the airframe is oriented for launch,
1016             you can reboot TeleMetrum and have it restart in pad mode
1017             without having to climb the scary ladder.
1018           </para>
1019         </listitem>
1020         <listitem>
1021           <para>
1022             Fire Igniters—Test your deployment charges without snaking
1023             wires out through holes in the airframe. Simply assembly the
1024             rocket as if for flight with the apogee and main charges
1025             loaded, then remotely command TeleMetrum to fire the
1026             igniters.
1027           </para>
1028         </listitem>
1029       </itemizedlist>
1030       <para>
1031         Packet command mode uses the same RF channels as telemetry
1032         mode. Configure the desired TeleDongle channel using the
1033         flight monitor window channel selector and then close that
1034         window before performing the desired operation.
1035       </para>
1036       <para>
1037         TeleMetrum only enables packet command mode in 'idle' mode, so
1038         make sure you have TeleMetrum lying horizontally when you turn
1039         it on. Otherwise, TeleMetrum will start in 'pad' mode ready for
1040         flight and will not be listening for command packets from TeleDongle.
1041       </para>
1042       <para>
1043         When packet command mode is enabled, you can monitor the link
1044         by watching the lights on the TeleDongle and TeleMetrum
1045         devices. The red LED will flash each time TeleDongle or
1046         TeleMetrum transmit a packet while the green LED will light up
1047         on TeleDongle while it is waiting to receive a packet from
1048         TeleMetrum.
1049       </para>
1050     </section>
1051     <section>
1052       <title>Monitor Flight</title>
1053       <subtitle>Receive, Record and Display Telemetry Data</subtitle>
1054       <para>
1055         Selecting this item brings up a dialog box listing all of the
1056         connected TeleDongle devices. When you choose one of these,
1057         AltosUI will create a window to display telemetry data as
1058         received by the selected TeleDongle device.
1059       </para>
1060       <para>
1061         All telemetry data received are automatically recorded in
1062         suitable log files. The name of the files includes the current
1063         date and rocket serial and flight numbers.
1064       </para>
1065       <para>
1066         The radio channel being monitored by the TeleDongle device is
1067         displayed at the top of the window. You can configure the
1068         channel by clicking on the channel box and selecting the desired
1069         channel. AltosUI remembers the last channel selected for each
1070         TeleDongle and selects that automatically the next time you use
1071         that device.
1072       </para>
1073       <para>
1074         Below the TeleDongle channel selector, the window contains a few
1075         significant pieces of information about the TeleMetrum providing
1076         the telemetry data stream:
1077       </para>
1078       <itemizedlist>
1079         <listitem>
1080           <para>The TeleMetrum callsign</para>
1081         </listitem>
1082         <listitem>
1083           <para>The TeleMetrum serial number</para>
1084         </listitem>
1085         <listitem>
1086           <para>The flight number. Each TeleMetrum remembers how many
1087             times it has flown.
1088           </para>
1089         </listitem>
1090         <listitem>
1091           <para>
1092             The rocket flight state. Each flight passes through several
1093             states including Pad, Boost, Fast, Coast, Drogue, Main and
1094             Landed.
1095           </para>
1096         </listitem>
1097         <listitem>
1098           <para>
1099             The Received Signal Strength Indicator value. This lets
1100             you know how strong a signal TeleDongle is receiving. The
1101             radio inside TeleDongle operates down to about -99dBm;
1102             weaker signals may not be receiveable. The packet link uses
1103             error correction and detection techniques which prevent
1104             incorrect data from being reported.
1105           </para>
1106         </listitem>
1107       </itemizedlist>
1108       <para>
1109         Finally, the largest portion of the window contains a set of
1110         tabs, each of which contain some information about the rocket.
1111         They're arranged in 'flight order' so that as the flight
1112         progresses, the selected tab automatically switches to display
1113         data relevant to the current state of the flight. You can select
1114         other tabs at any time. The final 'table' tab contains all of
1115         the telemetry data in one place.
1116       </para>
1117       <section>
1118         <title>Launch Pad</title>
1119         <para>
1120           The 'Launch Pad' tab shows information used to decide when the
1121           rocket is ready for flight. The first elements include red/green
1122           indicators, if any of these is red, you'll want to evaluate
1123           whether the rocket is ready to launch:
1124           <itemizedlist>
1125             <listitem>
1126               <para>
1127                 Battery Voltage. This indicates whether the LiPo battery
1128                 powering the TeleMetrum has sufficient charge to last for
1129                 the duration of the flight. A value of more than
1130                 3.7V is required for a 'GO' status.
1131               </para>
1132             </listitem>
1133             <listitem>
1134               <para>
1135                 Apogee Igniter Voltage. This indicates whether the apogee
1136                 igniter has continuity. If the igniter has a low
1137                 resistance, then the voltage measured here will be close
1138                 to the LiPo battery voltage. A value greater than 3.2V is
1139                 required for a 'GO' status.
1140               </para>
1141             </listitem>
1142             <listitem>
1143               <para>
1144                 Main Igniter Voltage. This indicates whether the main
1145                 igniter has continuity. If the igniter has a low
1146                 resistance, then the voltage measured here will be close
1147                 to the LiPo battery voltage. A value greater than 3.2V is
1148                 required for a 'GO' status.
1149               </para>
1150             </listitem>
1151             <listitem>
1152               <para>
1153                 GPS Locked. This indicates whether the GPS receiver is
1154                 currently able to compute position information. GPS requires
1155                 at least 4 satellites to compute an accurate position.
1156               </para>
1157             </listitem>
1158             <listitem>
1159               <para>
1160                 GPS Ready. This indicates whether GPS has reported at least
1161                 10 consecutive positions without losing lock. This ensures
1162                 that the GPS receiver has reliable reception from the
1163                 satellites.
1164               </para>
1165             </listitem>
1166           </itemizedlist>
1167           <para>
1168             The LaunchPad tab also shows the computed launch pad position
1169             and altitude, averaging many reported positions to improve the
1170             accuracy of the fix.
1171           </para>
1172         </para>
1173       </section>
1174       <section>
1175         <title>Ascent</title>
1176         <para>
1177           This tab is shown during Boost, Fast and Coast
1178           phases. The information displayed here helps monitor the
1179           rocket as it heads towards apogee.
1180         </para>
1181         <para>
1182           The height, speed and acceleration are shown along with the
1183           maxium values for each of them. This allows you to quickly
1184           answer the most commonly asked questions you'll hear during
1185           flight.
1186         </para>
1187         <para>
1188           The current latitude and longitude reported by the GPS are
1189           also shown. Note that under high acceleration, these values
1190           may not get updated as the GPS receiver loses position
1191           fix. Once the rocket starts coasting, the receiver should
1192           start reporting position again.
1193         </para>
1194         <para>
1195           Finally, the current igniter voltages are reported as in the
1196           Launch Pad tab. This can help diagnose deployment failures
1197           caused by wiring which comes loose under high acceleration.
1198         </para>
1199       </section>
1200       <section>
1201         <title>Descent</title>
1202         <para>
1203           Once the rocket has reached apogee and (we hope) activated the
1204           apogee charge, attention switches to tracking the rocket on
1205           the way back to the ground, and for dual-deploy flights,
1206           waiting for the main charge to fire.
1207         </para>
1208         <para>
1209           To monitor whether the apogee charge operated correctly, the
1210           current descent rate is reported along with the current
1211           height. Good descent rates generally range from 15-30m/s.
1212         </para>
1213         <para>
1214           To help locate the rocket in the sky, use the elevation and
1215           bearing information to figure out where to look. Elevation is
1216           in degrees above the horizon. Bearing is reported in degrees
1217           relative to true north. Range can help figure out how big the
1218           rocket will appear. Note that all of these values are relative
1219           to the pad location. If the elevation is near 90°, the rocket
1220           is over the pad, not over you.
1221         </para>
1222         <para>
1223           Finally, the igniter voltages are reported in this tab as
1224           well, both to monitor the main charge as well as to see what
1225           the status of the apogee charge is.
1226         </para>
1227       </section>
1228       <section>
1229         <title>Landed</title>
1230         <para>
1231           Once the rocket is on the ground, attention switches to
1232           recovery. While the radio signal is generally lost once the
1233           rocket is on the ground, the last reported GPS position is
1234           generally within a short distance of the actual landing location.
1235         </para>
1236         <para>
1237           The last reported GPS position is reported both by
1238           latitude and longitude as well as a bearing and distance from
1239           the launch pad. The distance should give you a good idea of
1240           whether you'll want to walk or hitch a ride. Take the reported
1241           latitude and longitude and enter them into your handheld GPS
1242           unit and have that compute a track to the landing location.
1243         </para>
1244         <para>
1245           Finally, the maximum height, speed and acceleration reported
1246           during the flight are displayed for your admiring observers.
1247         </para>
1248       </section>
1249       <section>
1250         <title>Site Map</title>
1251         <para>
1252           When the rocket gets a GPS fix, the Site Map tab will map
1253           the rocket's position to make it easier for you to locate the
1254           rocket, both while it is in the air, and when it has landed. The
1255           rocket's state is indicated by colour: white for pad, red for
1256           boost, pink for fast, yellow for coast, light blue for drogue,
1257           dark blue for main, and black for landed.
1258         </para>
1259         <para>
1260           The map's scale is approximately 3m (10ft) per pixel. The map
1261           can be dragged using the left mouse button. The map will attempt
1262           to keep the rocket roughly centred while data is being received.
1263         </para>
1264         <para>
1265           Images are fetched automatically via the Google Maps Static API,
1266           and are cached for reuse. If map images cannot be downloaded,
1267           the rocket's path will be traced on a dark grey background
1268           instead.
1269         </para>
1270       </section>
1271     </section>
1272     <section>
1273       <title>Save Flight Data</title>
1274       <para>
1275         TeleMetrum records flight data to its internal flash memory.
1276         This data is recorded at a much higher rate than the telemetry
1277         system can handle, and is not subject to radio drop-outs. As
1278         such, it provides a more complete and precise record of the
1279         flight. The 'Save Flight Data' button allows you to read the
1280         flash memory and write it to disk.
1281       </para>
1282       <para>
1283         Clicking on the 'Save Flight Data' button brings up a list of
1284         connected TeleMetrum and TeleDongle devices. If you select a
1285         TeleMetrum device, the flight data will be downloaded from that
1286         device directly. If you select a TeleDongle device, flight data
1287         will be downloaded from a TeleMetrum device connected via the
1288         packet command link to the specified TeleDongle. See the chapter
1289         on Packet Command Mode for more information about this.
1290       </para>
1291       <para>
1292         The filename for the data is computed automatically from the recorded
1293         flight date, TeleMetrum serial number and flight number
1294         information.
1295       </para>
1296     </section>
1297     <section>
1298       <title>Replay Flight</title>
1299       <para>
1300         Select this button and you are prompted to select a flight
1301         record file, either a .telem file recording telemetry data or a
1302         .eeprom file containing flight data saved from the TeleMetrum
1303         flash memory.
1304       </para>
1305       <para>
1306         Once a flight record is selected, the flight monitor interface
1307         is displayed and the flight is re-enacted in real time. Check
1308         the Monitor Flight chapter above to learn how this window operates.
1309       </para>
1310     </section>
1311     <section>
1312       <title>Graph Data</title>
1313       <para>
1314         Select this button and you are prompted to select a flight
1315         record file, either a .telem file recording telemetry data or a
1316         .eeprom file containing flight data saved from the TeleMetrum
1317         flash memory.
1318       </para>
1319       <para>
1320         Once a flight record is selected, the acceleration (blue),
1321         velocity (green) and altitude (red) of the flight are plotted and
1322         displayed, measured in metric units.
1323       </para>
1324       <para>
1325         The graph can be zoomed into a particular area by clicking and
1326         dragging down and to the right. Once zoomed, the graph can be
1327         reset by clicking and dragging up and to the left. Holding down
1328         control and clicking and dragging allows the graph to be panned.
1329         The right mouse button causes a popup menu to be displayed, giving
1330         you the option save or print the plot.
1331       </para>
1332       <para>
1333         Note that telemetry files will generally produce poor graphs
1334         due to the lower sampling rate and missed telemetry packets,
1335         and will also often have significant amounts of data received
1336         while the rocket was waiting on the pad. Use saved flight data
1337         for graphing where possible.
1338       </para>
1339     </section>
1340     <section>
1341       <title>Export Data</title>
1342       <para>
1343         This tool takes the raw data files and makes them available for
1344         external analysis. When you select this button, you are prompted to select a flight
1345         data file (either .eeprom or .telem will do, remember that
1346         .eeprom files contain higher resolution and more continuous
1347         data). Next, a second dialog appears which is used to select
1348         where to write the resulting file. It has a selector to choose
1349         between CSV and KML file formats.
1350       </para>
1351       <section>
1352         <title>Comma Separated Value Format</title>
1353         <para>
1354           This is a text file containing the data in a form suitable for
1355           import into a spreadsheet or other external data analysis
1356           tool. The first few lines of the file contain the version and
1357           configuration information from the TeleMetrum device, then
1358           there is a single header line which labels all of the
1359           fields. All of these lines start with a '#' character which
1360           most tools can be configured to skip over.
1361         </para>
1362         <para>
1363           The remaining lines of the file contain the data, with each
1364           field separated by a comma and at least one space. All of
1365           the sensor values are converted to standard units, with the
1366           barometric data reported in both pressure, altitude and
1367           height above pad units.
1368         </para>
1369       </section>
1370       <section>
1371         <title>Keyhole Markup Language (for Google Earth)</title>
1372         <para>
1373           This is the format used by
1374           Googleearth to provide an overlay within that
1375           application. With this, you can use Googleearth to see the
1376           whole flight path in 3D.
1377         </para>
1378       </section>
1379     </section>
1380     <section>
1381       <title>Configure TeleMetrum</title>
1382       <para>
1383         Select this button and then select either a TeleMetrum or
1384         TeleDongle Device from the list provided. Selecting a TeleDongle
1385         device will use Packet Comamnd Mode to configure remote
1386         TeleMetrum device. Learn how to use this in the Packet Command
1387         Mode chapter.
1388       </para>
1389       <para>
1390         The first few lines of the dialog provide information about the
1391         connected TeleMetrum device, including the product name,
1392         software version and hardware serial number. Below that are the
1393         individual configuration entries.
1394       </para>
1395       <para>
1396         At the bottom of the dialog, there are four buttons:
1397       </para>
1398       <itemizedlist>
1399         <listitem>
1400           <para>
1401             Save. This writes any changes to the TeleMetrum
1402             configuration parameter block in flash memory. If you don't
1403             press this button, any changes you make will be lost.
1404           </para>
1405         </listitem>
1406         <listitem>
1407           <para>
1408             Reset. This resets the dialog to the most recently saved values,
1409             erasing any changes you have made.
1410           </para>
1411         </listitem>
1412         <listitem>
1413           <para>
1414             Reboot. This reboots the TeleMetrum device. Use this to
1415             switch from idle to pad mode by rebooting once the rocket is
1416             oriented for flight.
1417           </para>
1418         </listitem>
1419         <listitem>
1420           <para>
1421             Close. This closes the dialog. Any unsaved changes will be
1422             lost.
1423           </para>
1424         </listitem>
1425       </itemizedlist>
1426       <para>
1427         The rest of the dialog contains the parameters to be configured.
1428       </para>
1429       <section>
1430         <title>Main Deploy Altitude</title>
1431         <para>
1432           This sets the altitude (above the recorded pad altitude) at
1433           which the 'main' igniter will fire. The drop-down menu shows
1434           some common values, but you can edit the text directly and
1435           choose whatever you like. If the apogee charge fires below
1436           this altitude, then the main charge will fire two seconds
1437           after the apogee charge fires.
1438         </para>
1439       </section>
1440       <section>
1441         <title>Apogee Delay</title>
1442         <para>
1443           When flying redundant electronics, it's often important to
1444           ensure that multiple apogee charges don't fire at precisely
1445           the same time as that can overpressurize the apogee deployment
1446           bay and cause a structural failure of the airframe. The Apogee
1447           Delay parameter tells the flight computer to fire the apogee
1448           charge a certain number of seconds after apogee has been
1449           detected.
1450         </para>
1451       </section>
1452       <section>
1453         <title>Radio Channel</title>
1454         <para>
1455           This configures which of the 10 radio channels to use for both
1456           telemetry and packet command mode. Note that if you set this
1457           value via packet command mode, you will have to reconfigure
1458           the TeleDongle channel before you will be able to use packet
1459           command mode again.
1460         </para>
1461       </section>
1462       <section>
1463         <title>Radio Calibration</title>
1464         <para>
1465           The radios in every Altus Metrum device are calibrated at the
1466           factory to ensure that they transmit and receive on the
1467           specified frequency for each channel. You can adjust that
1468           calibration by changing this value. To change the TeleDongle's
1469           calibration, you must reprogram the unit completely.
1470         </para>
1471       </section>
1472       <section>
1473         <title>Callsign</title>
1474         <para>
1475           This sets the callsign included in each telemetry packet. Set this
1476           as needed to conform to your local radio regulations.
1477         </para>
1478       </section>
1479     </section>
1480     <section>
1481       <title>Configure AltosUI</title>
1482       <para>
1483         This button presents a dialog so that you can configure the AltosUI global settings.
1484       </para>
1485       <section>
1486         <title>Voice Settings</title>
1487         <para>
1488           AltosUI provides voice annoucements during flight so that you
1489           can keep your eyes on the sky and still get information about
1490           the current flight status. However, sometimes you don't want
1491           to hear them.
1492         </para>
1493         <itemizedlist>
1494           <listitem>
1495             <para>Enable—turns all voice announcements on and off</para>
1496           </listitem>
1497           <listitem>
1498             <para>
1499               Test Voice—Plays a short message allowing you to verify
1500               that the audio systme is working and the volume settings
1501               are reasonable
1502             </para>
1503           </listitem>
1504         </itemizedlist>
1505       </section>
1506       <section>
1507         <title>Log Directory</title>
1508         <para>
1509           AltosUI logs all telemetry data and saves all TeleMetrum flash
1510           data to this directory. This directory is also used as the
1511           staring point when selecting data files for display or export.
1512         </para>
1513         <para>
1514           Click on the directory name to bring up a directory choosing
1515           dialog, select a new directory and click 'Select Directory' to
1516           change where AltosUI reads and writes data files.
1517         </para>
1518       </section>
1519       <section>
1520         <title>Callsign</title>
1521         <para>
1522           This value is used in command packet mode and is transmitted
1523           in each packet sent from TeleDongle and received from
1524           TeleMetrum. It is not used in telemetry mode as that transmits
1525           packets only from TeleMetrum to TeleDongle. Configure this
1526           with the AltosUI operators callsign as needed to comply with
1527           your local radio regulations.
1528         </para>
1529       </section>
1530     </section>
1531     <section>
1532       <title>Flash Image</title>
1533       <para>
1534         This reprograms any Altus Metrum device by using a TeleMetrum or
1535         TeleDongle as a programming dongle. Please read the directions
1536         for connecting the programming cable in the main TeleMetrum
1537         manual before reading these instructions.
1538       </para>
1539       <para>
1540         Once you have the programmer and target devices connected,
1541         push the 'Flash Image' button. That will present a dialog box
1542         listing all of the connected devices. Carefully select the
1543         programmer device, not the device to be programmed.
1544       </para>
1545       <para>
1546         Next, select the image to flash to the device. These are named
1547         with the product name and firmware version. The file selector
1548         will start in the directory containing the firmware included
1549         with the AltosUI package. Navigate to the directory containing
1550         the desired firmware if it isn't there.
1551       </para>
1552       <para>
1553         Next, a small dialog containing the device serial number and
1554         RF calibration values should appear. If these values are
1555         incorrect (possibly due to a corrupted image in the device),
1556         enter the correct values here.
1557       </para>
1558       <para>
1559         Finally, a dialog containing a progress bar will follow the
1560         programming process.
1561       </para>
1562       <para>
1563         When programming is complete, the target device will
1564         reboot. Note that if the target device is connected via USB, you
1565         will have to unplug it and then plug it back in for the USB
1566         connection to reset so that you can communicate with the device
1567         again.
1568       </para>
1569     </section>
1570     <section>
1571       <title>Fire Igniter</title>
1572       <para>
1573         This activates the igniter circuits in TeleMetrum to help test
1574         recovery systems deployment. Because this command can operate
1575         over the Packet Command Link, you can prepare the rocket as
1576         for flight and then test the recovery system without needing
1577         to snake wires inside the airframe.
1578       </para>
1579       <para>
1580         Selecting the 'Fire Igniter' button brings up the usual device
1581         selection dialog. Pick the desired TeleDongle or TeleMetrum
1582         device. This brings up another window which shows the current
1583         continutity test status for both apogee and main charges.
1584       </para>
1585       <para>
1586         Next, select the desired igniter to fire. This will enable the
1587         'Arm' button.
1588       </para>
1589       <para>
1590         Select the 'Arm' button. This enables the 'Fire' button. The
1591         word 'Arm' is replaced by a countdown timer indicating that
1592         you have 10 seconds to press the 'Fire' button or the system
1593         will deactivate, at which point you start over again at
1594         selecting the desired igniter.
1595       </para>
1596     </section>
1597   </chapter>
1598   <chapter>
1599     <title>Using Altus Metrum Products</title>
1600     <section>
1601       <title>Being Legal</title>
1602       <para>
1603         First off, in the US, you need an <ulink url="http://www.altusmetrum.org/Radio/">amateur radio license</ulink> or
1604         other authorization to legally operate the radio transmitters that are part
1605         of our products.
1606       </para>
1607       </section>
1608       <section>
1609         <title>In the Rocket</title>
1610         <para>
1611           In the rocket itself, you just need a <ulink url="http://www.altusmetrum.org/TeleMetrum/">TeleMetrum</ulink> board and
1612           a LiPo rechargeable battery.  An 860mAh battery weighs less than a 9V
1613           alkaline battery, and will run a <ulink url="http://www.altusmetrum.org/TeleMetrum/">TeleMetrum</ulink> for hours.
1614         </para>
1615         <para>
1616           By default, we ship TeleMetrum with a simple wire antenna.  If your
1617           electronics bay or the airframe it resides within is made of carbon fiber,
1618           which is opaque to RF signals, you may choose to have an SMA connector
1619           installed so that you can run a coaxial cable to an antenna mounted
1620           elsewhere in the rocket.
1621         </para>
1622       </section>
1623       <section>
1624         <title>On the Ground</title>
1625         <para>
1626           To receive the data stream from the rocket, you need an antenna and short
1627           feedline connected to one of our <ulink url="http://www.altusmetrum.org/TeleDongle/">TeleDongle</ulink> units.  The
1628           TeleDongle in turn plugs directly into the USB port on a notebook
1629           computer.  Because TeleDongle looks like a simple serial port, your computer
1630           does not require special device drivers... just plug it in.
1631         </para>
1632         <para>
1633           The GUI tool, AltosUI, is written in Java and runs across
1634           Linux, Mac OS and Windows. There's also a suite of C tools
1635           for Linux which can perform most of the same tasks.
1636         </para>
1637         <para>
1638           After the flight, you can use the RF link to extract the more detailed data
1639           logged in the rocket, or you can use a mini USB cable to plug into the
1640           TeleMetrum board directly.  Pulling out the data without having to open up
1641           the rocket is pretty cool!  A USB cable is also how you charge the LiPo
1642           battery, so you'll want one of those anyway... the same cable used by lots
1643           of digital cameras and other modern electronic stuff will work fine.
1644         </para>
1645         <para>
1646           If your rocket lands out of sight, you may enjoy having a hand-held GPS
1647           receiver, so that you can put in a waypoint for the last reported rocket
1648           position before touch-down.  This makes looking for your rocket a lot like
1649           Geo-Cacheing... just go to the waypoint and look around starting from there.
1650         </para>
1651         <para>
1652           You may also enjoy having a ham radio "HT" that covers the 70cm band... you
1653           can use that with your antenna to direction-find the rocket on the ground
1654           the same way you can use a Walston or Beeline tracker.  This can be handy
1655           if the rocket is hiding in sage brush or a tree, or if the last GPS position
1656           doesn't get you close enough because the rocket dropped into a canyon, or
1657           the wind is blowing it across a dry lake bed, or something like that...  Keith
1658           and Bdale both currently own and use the Yaesu VX-7R at launches.
1659         </para>
1660         <para>
1661           So, to recap, on the ground the hardware you'll need includes:
1662           <orderedlist inheritnum='inherit' numeration='arabic'>
1663             <listitem>
1664               an antenna and feedline
1665             </listitem>
1666             <listitem>
1667               a TeleDongle
1668             </listitem>
1669             <listitem>
1670               a notebook computer
1671             </listitem>
1672             <listitem>
1673               optionally, a handheld GPS receiver
1674             </listitem>
1675             <listitem>
1676               optionally, an HT or receiver covering 435 Mhz
1677             </listitem>
1678           </orderedlist>
1679         </para>
1680         <para>
1681           The best hand-held commercial directional antennas we've found for radio
1682           direction finding rockets are from
1683           <ulink url="http://www.arrowantennas.com/" >
1684             Arrow Antennas.
1685           </ulink>
1686           The 440-3 and 440-5 are both good choices for finding a
1687           TeleMetrum-equipped rocket when used with a suitable 70cm HT.
1688         </para>
1689       </section>
1690       <section>
1691         <title>Data Analysis</title>
1692         <para>
1693           Our software makes it easy to log the data from each flight, both the
1694           telemetry received over the RF link during the flight itself, and the more
1695           complete data log recorded in the DataFlash memory on the TeleMetrum
1696           board.  Once this data is on your computer, our postflight tools make it
1697           easy to quickly get to the numbers everyone wants, like apogee altitude,
1698           max acceleration, and max velocity.  You can also generate and view a
1699           standard set of plots showing the altitude, acceleration, and
1700           velocity of the rocket during flight.  And you can even export a data file
1701           useable with Google Maps and Google Earth for visualizing the flight path
1702           in two or three dimensions!
1703         </para>
1704         <para>
1705           Our ultimate goal is to emit a set of files for each flight that can be
1706           published as a web page per flight, or just viewed on your local disk with
1707           a web browser.
1708         </para>
1709       </section>
1710       <section>
1711         <title>Future Plans</title>
1712         <para>
1713           In the future, we intend to offer "companion boards" for the rocket that will
1714           plug in to TeleMetrum to collect additional data, provide more pyro channels,
1715           and so forth.  A reference design for a companion board will be documented
1716           soon, and will be compatible with open source Arduino programming tools.
1717         </para>
1718         <para>
1719           We are also working on the design of a hand-held ground terminal that will
1720           allow monitoring the rocket's status, collecting data during flight, and
1721           logging data after flight without the need for a notebook computer on the
1722           flight line.  Particularly since it is so difficult to read most notebook
1723           screens in direct sunlight, we think this will be a great thing to have.
1724         </para>
1725         <para>
1726           Because all of our work is open, both the hardware designs and the software,
1727           if you have some great idea for an addition to the current Altus Metrum family,
1728           feel free to dive in and help!  Or let us know what you'd like to see that
1729           we aren't already working on, and maybe we'll get excited about it too...
1730         </para>
1731     </section>
1732   </chapter>
1733 </book>