first cut at turnon scripts for EasyTimer v2

[fw/altos] / doc / pyro-channels.inc

diff --git a/doc/pyro-channels.inc b/doc/pyro-channels.inc
index 7fd0641245947739811ccd2e6b547d459bdea011..930245fa2128c6fbebdbe6080ccc434391350368 100644 (file)
--- a/doc/pyro-channels.inc
+++ b/doc/pyro-channels.inc
@@ -13,12 +13,14 @@ rate during descent is a bit noisy and so be careful when using it
 during these phases of the flight.
 
 Height above pad:: Select a value, and then choose whether the height
-above the launch pad should be above or below that value.
-
-Orientation:: TeleMega and EasyMega contain a 3-axis gyroscope and
-accelerometer which is used to compute the orientation of the
-rocket. A record of orientations over the last 0.64 seconds is kept
-and the largest value within this period is compared with the
+above the launch pad should be above or below that value. Note that
+because EasyTimer has only a low-range accelerometer and no barometer,
+this value will not be very reliable on that device.
+
+Orientation:: TeleMega, EasyMega and EasyTimer contain a 3-axis
+gyroscope and accelerometer which is used to compute the orientation
+of the rocket. A record of orientations over the last 0.64 seconds is
+kept and the largest value within this period is compared with the
 specified value. Note that the tilt angle is not the change in angle
 from the launch pad, but rather absolute relative to gravity—the
 3-axis accelerometer is used to compute the angle of the rocket on the
@@ -42,9 +44,17 @@ launch pad and initialize the system.
   of less than that value.
   ====
 
-Flight Time:: Time since boost was detected. Select a value and choose
-whether to activate the pyro channel before or after that amount of
-time.
+Flight Time:: Time since launch. Select a value and choose whether to
+activate the pyro channel before or after that amount of time.
+
+[WARNING]
+Firmware versions older than 1.8.6 have a bug which resets the time
+since launch to zero each time a motor starts burning. Update firmware
+to get the correct behavior.
+
+[WARNING]
+Firmware versions older than 1.9.8 cannot use times longer
+than 327.67 seconds. Update firmware if you need a longer time.
 
 Ascending:: A deprecated configuration value which was the same as
 setting Ascent rate > 0. Existing configurations using this will be
@@ -57,7 +67,9 @@ cleared and must be reconfigured by the user.
 After Motor:: The flight software counts each time the rocket starts
 accelerating and then decelerating (presumably due to a motor or
 motors burning). Use this value for multi-staged or multi-airstart
-launches.
+launches. As of version 1.8.6 firmware, this checks to make sure at
+least this many motors have burned. Before version 1.8.6, this checked
+to make sure that exactly this many motors had burned.
 
 Delay:: Once the other parameters all become true, a timer is
 started for the specified amount of time. While the timer is running,
@@ -66,6 +78,10 @@ false, then the pyro channel is disabled and will not fire. If the
 timer expires and all of the other parameters have remained true for
 the entire time, then the pyro channel is fired.
 
+[WARNING]
+Firmware versions older than 1.9.8 cannot use delays longer
+than 327.67 seconds. Update firmware if you need a longer delay.
+
 Flight State:: The flight software tracks the flight
 through a sequence of states:
 
@@ -83,14 +99,14 @@ through a sequence of states:
    than 200m/s. Ascent rate will greater than zero. Vertical
    acceleration will be less than zero.
 
- * Drogue. The rocket has reached apogee and
-   is heading back down, but is above the
-   configured Main altitude. Ascent rate will be less than zero during
-   this state. Vertical acceleration will be negative until the rocket
-   reaches a terminal descent rate, at which point Vertical
-   acceleration will be zero. Both Ascent rate and Vertical
+ * Drogue. The rocket has reached apogee and is heading back down, but
+   is above the configured Main altitude. Ascent rate will be less
+   than zero during this state. Vertical acceleration will be negative
+   until the rocket reaches a terminal descent rate, at which point
+   Vertical acceleration will be zero. Both Ascent rate and Vertical
    acceleration are very noisy in this state, so be careful when
-   trying to use them to control pyro channels.
+   trying to use them to control pyro channels. This state selection
+   is not available on EasyTimer.
 
  * Main. The rocket is still descending, and
    is below the Main altitude. Ascent rate will be less than zero
@@ -99,7 +115,7 @@ through a sequence of states:
    it will settle down to a zero value once the rocket has reached the
    terminal velocity under the main chute. Ascent rate and Vertical
    acceleration should be much less noisy once the main chute has
-   deployed.
+   deployed. This state selection is not available on EasyTimer.
 
  * Landed. The rocket is no longer moving.