diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 1 | ||||
| -rw-r--r-- | doc/RELNOTES | 4 | ||||
| -rw-r--r-- | doc/altusmetrum-docinfo.xml | 14 | ||||
| -rw-r--r-- | doc/config-device.inc | 8 | ||||
| -rw-r--r-- | doc/easymini-release-notes.inc | 4 | ||||
| -rw-r--r-- | doc/intro.inc | 10 | ||||
| -rw-r--r-- | doc/load-maps.inc | 6 | ||||
| -rw-r--r-- | doc/pyro-channels.inc | 106 | ||||
| -rw-r--r-- | doc/release-notes-1.8.6.inc | 33 | ||||
| -rw-r--r-- | doc/release-notes.inc | 4 | ||||
| -rw-r--r-- | doc/telegps-release-notes.inc | 4 |
11 files changed, 149 insertions, 45 deletions
diff --git a/doc/Makefile b/doc/Makefile index efa7f9d3..3661a6d6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,6 +3,7 @@ # RELNOTES_INC=\ + release-notes-1.8.6.inc \ release-notes-1.8.5.inc \ release-notes-1.8.4.inc \ release-notes-1.8.3.inc \ diff --git a/doc/RELNOTES b/doc/RELNOTES index c3980882..748d2b5b 100644 --- a/doc/RELNOTES +++ b/doc/RELNOTES @@ -1,5 +1,9 @@ Creating documentation for a new release of AltOS +* Make sure that doc/altusmetrum-docinfo.xml has the right copyright + year, and add release to the revision history at the front (release + notes will be pulled in by release-notes.inc) + * Write release notes in release-notes-${version}.inc. Add to Makefile diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 3ea79f8b..7b696b97 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -47,6 +47,20 @@ <revhistory> <?dbhtml filename="altusmetrum-revhistory.html"?> <revision> + <revnumber>1.8.6</revnumber> + <date>6 Aug 2018</date> + <revremark> + Various pyro channel configuration updates. + </revremark> + </revision> + <revision> + <revnumber>1.8.5</revnumber> + <date>18 Mar 2018</date> + <revremark> + Minor ground station software updates. + </revremark> + </revision> + <revision> <revnumber>1.8.4</revnumber> <date>20 Dec 2017</date> <revremark> diff --git a/doc/config-device.inc b/doc/config-device.inc index 99d5c008..0ca6afff 100644 --- a/doc/config-device.inc +++ b/doc/config-device.inc @@ -23,7 +23,7 @@ ifdef::altusmetrum[] ==== Apogee Lockout - Apogee lockout is the number of seconds after boost + Apogee lockout is the number of seconds after launch where the flight computer will not fire the apogee charge, even if the rocket appears to be at apogee. This is often called 'Mach Delay', as it is @@ -35,6 +35,12 @@ ifdef::altusmetrum[] pressure increase, and so this setting should be left at the default value of zero to disable it. + [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. + endif::altusmetrum[] ifdef::radio[] diff --git a/doc/easymini-release-notes.inc b/doc/easymini-release-notes.inc index 2d289b12..425236ef 100644 --- a/doc/easymini-release-notes.inc +++ b/doc/easymini-release-notes.inc @@ -1,6 +1,10 @@ [appendix] == Release Notes :leveloffset: 2 + include::release-notes-1.8.6.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.8.5.raw[] <<<< diff --git a/doc/intro.inc b/doc/intro.inc index 6b0cd318..bff009c0 100644 --- a/doc/intro.inc +++ b/doc/intro.inc @@ -7,6 +7,16 @@ we also hope to empower you to take as active a role in our collective future as you wish! + Our goal is to include in this document all of the information required + to successfully configure and use Altus Metrum products. But + documentation is a lot like software in that it can contain "bugs", + and can probably always be improved! If you have questions that + aren't answered in this manual, or just need a little help figuring + things out, we strongly suggest joining the Altus Metrum user email + list, which you can do by visiting + https://lists.gag.com/mailman/listinfo/altusmetrum. There's a lot + of useful information in the mailing list archives! + The first device created for our community was TeleMetrum, a dual deploy altimeter with fully integrated GPS and radio telemetry as standard features, and a “companion interface” that will diff --git a/doc/load-maps.inc b/doc/load-maps.inc index e7717d89..ccab4795 100644 --- a/doc/load-maps.inc +++ b/doc/load-maps.inc @@ -5,7 +5,11 @@ Before heading out to a new launch site, you can use this to load satellite images in case you don't have - internet connectivity at the site. + internet connectivity at the site. Try not to wait + until the last minute, though, particularly if you're + heading to a major launch. If too many people are + all trying to download map data at once, Google may + limit access until the next day. There's a drop-down menu of launch sites we know about; if your favorites aren't there, please let us diff --git a/doc/pyro-channels.inc b/doc/pyro-channels.inc index 3b918544..ab5baef0 100644 --- a/doc/pyro-channels.inc +++ b/doc/pyro-channels.inc @@ -1,33 +1,28 @@ -Acceleration:: Select a value, and then choose -whether acceleration should be above or below -that value. Acceleration is positive upwards, -so accelerating towards the ground would -produce negative numbers. Acceleration during -descent is noisy and inaccurate, so be careful -when using it during these phases of the -flight. - -Vertical speed:: Select a value, and then -choose whether vertical speed should be above -or below that value. Speed is positive -upwards, so moving towards the ground would -produce negative numbers. Speed during descent -is a bit noisy and so be careful when using it +Vertical Acceleration:: Select a value, and then choose whether +acceleration away from the ground should be above or below that +value. Acceleration is positive upwards, so accelerating towards the +ground would produce negative numbers. Acceleration during descent is +noisy and inaccurate, so be careful when using it during these phases +of the flight. + +Ascent rate:: Select a value, and then choose whether ascent rate +should be above or below that value. Ascent rate is positive upwards, +so moving towards the ground would produce negative numbers. Ascent +rate during descent is a bit noisy and so be careful when using it during these phases of the flight. -Height:: Select a value, and then choose -whether the height above the launch pad should -be above or below that value. +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 measure the current angle. Note that -this 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 launch -pad and initialize the system. +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 +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 +launch pad and initialize the system. [NOTE] ==== @@ -47,45 +42,70 @@ 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. -Ascending:: A simple test saying whether the rocket is going up or -not. This is exactly equivalent to testing whether the speed is > 0. +[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. -Descending:: A simple test saying whether the rocket is going down or -not. This is exactly equivalent to testing whether the speed is < 0. +Ascending:: A deprecated configuration value which was the same as +setting Ascent rate > 0. Existing configurations using this will be +cleared and must be reconfigured by the user. + +Descending:: A deprecated configuration value which was the same as +setting Ascent rate < 0. Existing configurations using this will be +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:: This value doesn't perform any checks, instead it inserts a -delay between the time when the other parameters become true and when -the pyro channel is activated. +Delay:: Once the other parameters all become true, a timer is +started for the specified amount of time. While the timer is running, +the other parameters are checked repeatedly and if any of them become +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. Flight State:: The flight software tracks the flight through a sequence of states: * Boost. The motor has lit and the rocket is - accelerating upwards. + accelerating upwards. Ascent rate will be greater than zero. + Vertical acceleration will be greater than zero. * Fast. The motor has burned out and the rocket is decelerating, but it is going - faster than 200m/s. + faster than 200m/s. Ascent rate will be greater than zero. Vertical + acceleration will be less than zero. * Coast. The rocket is still moving upwards - and decelerating, but the speed is less - than 200m/s. + and decelerating, but the Ascent rate is less + 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. + 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. * Main. The rocket is still descending, and - is below the Main altitude + is below the Main altitude. Ascent rate will be less than zero + during this state. Vertical acceleration may be briefly less than + zero as the rocket slows from drogue descent to main descent, but + 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. * Landed. The rocket is no longer moving. diff --git a/doc/release-notes-1.8.6.inc b/doc/release-notes-1.8.6.inc new file mode 100644 index 00000000..1467977c --- /dev/null +++ b/doc/release-notes-1.8.6.inc @@ -0,0 +1,33 @@ += Release Notes for Version 1.8.6 +:toc!: +:doctype: article + + Version 1.8.6 + + == AltOS + + * Use maximum of 64 previous tilt values in pyro tilt tests + + * Eliminate 100m height requirement for coast detection + + * Change After Motor pyro check to be >= instead of == + + * Change Time since Boost to be Time since launch. + + == AltosUI, TeleGPS + + * Clarify pyro test phrasing + + * Remove ascending/descending from pyro config UI + + * Fix accel calibration in Antenna Down mode + + * Add mag sensor reporting for TeleMega v3 idle monitoring. + + * Fix radio parameter saving at 2400 bps telmetry rate. + + == MicroPeak + + * Report altimeter-recorded maximum height value + + diff --git a/doc/release-notes.inc b/doc/release-notes.inc index b7c7f5a7..693699df 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -1,6 +1,10 @@ [appendix] == Release Notes :leveloffset: 2 + include::release-notes-1.8.6.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.8.5.raw[] <<<< diff --git a/doc/telegps-release-notes.inc b/doc/telegps-release-notes.inc index f451c2c8..9c1353f8 100644 --- a/doc/telegps-release-notes.inc +++ b/doc/telegps-release-notes.inc @@ -2,6 +2,10 @@ == Release Notes :leveloffset: 2 + include::release-notes-1.8.6.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.8.5.raw[] <<<< |