update info on using separate pyro batteries to encourage including a switch
[fw/altos] / doc / usage.inc
index caccc168bd3bdbce4f04b0f0a73ad62f336121c5..68d08bad8690a821f8b5649f70d788e187383156 100644 (file)
 
                Altus Metrum flight computers include a beeper to
                provide information about the state of the system.
+               ifdef::telemini[]
                TeleMini doesn't have room for a beeper, so instead it
                uses an LED, which works the same, except for every
                beep is replaced with the flash of the LED.
+               endif::telemini[]
 
-               Here's a short summary of all of the modes and the beeping (or
-               flashing, in the case of TeleMini v1) that accompanies each
-               mode. In the description of the beeping pattern, “dit” means a
-               short beep while "dah" means a long beep (three times as
-               long). “Brap” means a long dissonant tone.
+               Here's a short summary of all of the modes and the
+               beeping
+               ifdef::telemini[(or flashing, in the case of TeleMini v1)]
+               that accompanies each mode. In the description of the
+               beeping pattern, “dit” means a short beep while "dah"
+               means a long beep (three times as long). “Brap” means
+               a long dissonant tone.
 
                .AltOS Modes
                [options="border",cols="1,1,2,2"]
@@ -80,7 +84,8 @@
                |Idle
                |I
                |dit dit
-               |Ready to accept commands over USB or radio link.
+               |Ready to accept commands over USB
+               ifdef::radio[or radio link.]
 
                |Pad
                |P
                 controlling the flight or transmitting telemetry
                 signals, but no record of the flight will be
                 stored in on-board flash.
+
+               ifdef::easymega,telemega[]
+               |Additional Igniters
+               |four very short beeps
+               |Continuity indication for the four additional pyro
+                channels on TeleMega and EasyMega. One high tone for
+                no continuity, one low tone for continuity. These are
+                produced after the continuity indicators for the two
+                primary igniter channels.
+               endif::easymega,telemega[]
+
                |====
 
+               ifdef::radio[]
                For devices with a radio transmitter, in addition to
                the digital and APRS telemetry signals, you can also
                receive audio tones with a standard amateur
                find the rocket using RDF techniques when the signal
                is too weak to receive GPS information via telemetry
                or APRS.
+               endif::radio[]
 
        === Turning On the Power
 
                Flight/Pad::
                The flight computer is waiting to detect
                launch and then fly the rocket. In this mode, the USB
-               link is disabled, and the radio goes into
-               transmit-only mode. The only way to get out of this
-               mode is to power the flight computer down.
+               link is
+               ifdef::radio[disabled, and the radio goes into transmit-only mode.]
+               ifndef::radio[disabled.]
+               The only way to get out of this
+               mode is to power the flight computer down. See below for how to get the flight
+               computer to come up in Flight/Pad mode at power on.
 
                Idle::
                The flight computer is ready to communicate over USB
-               and in packet mode over the radio. You can configure
+               ifdef::radio[and in packet mode over the radio.]
+               You can configure
                the flight computer, download data or display
-               the current state.
+               the current state. See below for how to get the flight
+               computer to come up in Idle mode at power on.
 
+               ifdef::telemetrum,easymega,telemega[]
                For flight computers with accelerometers (TeleMetrum,
                EasyMega and TeleMega), the mode is selected by the
                orientation of the board during the self test
                interval. If the board is pointing upwards as if ready
                to fly, it will enter Flight/Pad mode. Otherwise, it will
                enter Idle mode.
+               endif::telemetrum,easymega,telemega[]
 
+               ifdef::easymini[]
                For EasyMini, if the USB cable is connected to a
                computer, it will enter Idle mode. Otherwise, it will
                enter Flight/Pad mode.
+               endif::easymini[]
 
+               ifdef::telemini[]
                For TeleMini v1.0, if a packet link is waiting to
                connect when the device is powered on, it will enter
                Idle mode, otherwise it will enter Flight/Pad mode.
+               endif::telemini[]
 
                You can see in <<_understanding_beeps>>
                how to tell which mode the flight computer is in.
                flight computer. These require three connections, one to
                the battery, one to the positive power input on the flight
                computer and one to ground. Find instructions on how to
-               hook these up for each flight computer below. The follow
+               hook these up for each flight computer below. Then follow
                the instructions that come with your active switch to
                connect it up.
 
 
                To use a separate pyro battery, connect the negative pyro
                battery terminal to the flight computer ground terminal,
-               the positive battery terminal to the igniter and the other
+               the the switched positive battery terminal to the igniter 
+               and the other
                igniter lead to the negative pyro terminal on the flight
                computer. When the pyro channel fires, it will complete the
                circuit between the negative pyro terminal and the ground
                to hook this up for each flight computer will be found
                in the section below for that flight computer.
 
+               Note that you must include a switch in the positive lead of 
+               the pyro battery for safety, as the on-board power switch 
+               circuit on our product only controls current flow from the 
+               the primary or system battery!
+
+
        === Using a Different Kind of Battery
 
-               EasyMini and TeleMini v2 are designed to use either a
+               EasyMini
+               ifdef::telemini[and TeleMini v2 are]
+               ifndef::telemini[is]
+               designed to use either a
                lithium polymer battery or any other battery producing
                between 4 and 12 volts, such as a rectangular 9V
                battery.
 
+               ifdef::telemega,easymega,telemetrum[]
                [WARNING]
                TeleMega, EasyMega and TeleMetrum are only designed to
                operate off a single-cell Lithium Polymer battery and
                cannot be used with any other kind. Connecting a
                different kind of battery to any of these will destroy
                the board.
+               endif::telemega,easymega,telemetrum[]
+
+       === Using Packet Link Mode
+
+               All AltusMetrum flight computers that have a radio can
+               communicate with the ground station software for
+               configuration and other operations using the Packet
+               Link mode. This uses radio communication instead of a
+               USB cable. To set this up, the ground station software
+               must be configured to the correct data rate, frequency
+               and callsign.
+
+               You can monitor Packet Link mode from TeleBT or
+               TeleDongle by watching the LEDs. Each time the device
+               transmits, the red LED will flash. When the link is
+               busy, or when the link is not working, the device will
+               transmit 10 times per second, so the LED will flash
+               rapidly. When the link is working and there is no data
+               to send, the link will flash once per second, and the
+               LED will flash more slowly.