doc: Create release notes for version 1.4
[fw/altos] / doc / release-notes-1.4.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
5 <article>
6   <para>
7     Version 1.4 is a major release. It includes support for our new
8     TeleGPS product, new features and bug fixes in in the flight
9     software for all our boards and the AltosUI ground station
10   </para>
11   <para>
12     AltOS Firmware Changes
13     <itemizedlist>
14       <listitem>
15         <para>
16           Add support for TeleGPS boards.
17         </para>
18       </listitem>
19       <listitem>
20         <para>
21           Replace the 'dit dit dit' tones at startup with the current
22           battery voltage, measured in tenths of a volt. This lets you
23           check the battery voltage without needing telemetry, which
24           is especially useful on EasyMini.
25         </para>
26       </listitem>
27       <listitem>
28         <para>
29           Change state beeping to "Farnsworth spacing", which means
30           they're quite a bit faster than before, and so they take
31           less time to send.
32         </para>
33       </listitem>
34       <listitem>
35         <para>
36           Make the beeper tone configurable, making it possible to
37           distinguish between two Altus Metrum products in the same ebay.
38         </para>
39       </listitem>
40       <listitem>
41         <para>
42           Fix bug preventing the selection of the 'Flight State After'
43           mode in pyro configuration.
44         </para>
45       </listitem>
46     </itemizedlist>
47   </para>
48   <para>
49     AltosUI new features
50     <itemizedlist>
51       <listitem>
52         <para>
53           Add zooming and new content types (terrain and road maps) to
54           map view. Change map storage format from PNG to Jpeg, which
55           saves a huge amount of disk space. You will need to
56           re-download all of your pre-loaded map images.
57         </para>
58       </listitem>
59       <listitem>
60         <para>
61           Add a distance measuring device to the maps view. Select
62           this by using any button other than the left one, or by
63           pressing shift or control on the keyboard while using the
64           left button.
65         </para>
66       </listitem>
67       <listitem>
68         <para>
69           Add new 'Ignitor' tab to the flight monitor display for
70           TeleMega's extra ignitors.
71         </para>
72       </listitem>
73       <listitem>
74         <para>
75           Increase the width of data lines in the graphs to make them
76           easier to read.
77         </para>
78       </listitem>
79       <listitem>
80         <para>
81           Add additional ignitor firing marks and voltages to the
82           graph so you can see when the ignitors fired, along with
83           the ignitor voltages.
84         </para>
85       </listitem>
86       <listitem>
87         <para>
88           Add GPS course, ground speed and climb rate as optional
89           graph elements.
90         </para>
91       </listitem>
92     </itemizedlist>
93   </para>
94   <para>
95     AltosUI fixes
96     <itemizedlist>
97       <listitem>
98         <para>
99           When flashing new firmware, re-try opening the device as
100           sometimes it takes a while for the underlying operating
101           system to recognize that the device has rebooted in
102           preparation for the flashing operation.
103         </para>
104       </listitem>
105       <listitem>
106         <para>
107           Hide Tilt Angle in ascent tab for devices that don't have a gyro.
108         </para>
109       </listitem>
110       <listitem>
111         <para>
112           Filter out speed and acceleration spikes caused by ejection
113           charge firing when computing the maximum values. This
114           provides a more accurate reading of those maximums.
115         </para>
116       </listitem>
117       <listitem>
118         <para>
119           Fix EasyMini voltage displays. Early EasyMini prototypes
120           used a 3.0V regulator, and AltosUI still used that value as
121           the basis of the computation. Production EasyMini boards
122           have always shipped with a 3.3V regulator. Also, purple
123           EasyMini boards sensed the battery voltage past the blocking
124           diode, resulting in a drop of about 150mV from the true
125           battery voltage. Compensate for that when displaying the
126           value.
127         </para>
128       </listitem>
129       <listitem>
130         <para>
131           Display error message when trying to configure maximum
132           flight log size while the flight computer still has flight
133           data stored.
134         </para>
135       </listitem>
136       <listitem>
137         <para>
138           Handle TeleMetrum and TeleMini eeprom files generated with
139           pre-1.0 firmware. Those ancient versions didn't report the
140           log format, so just use the product name instead.
141         </para>
142       </listitem>
143     </itemizedlist>
144   </para>
145   <para>
146     TeleGPS Application
147     <itemizedlist>
148       <listitem>
149         <para>
150           New application designed for use with TeleGPS boards.
151         </para>
152       </listitem>
153       <listitem>
154         <para>
155           Shares code with AltosUI, mostly just trimmed down to focus
156           on TeleGPS-related functions.
157         </para>
158       </listitem>
159     </itemizedlist>
160   </para>
161   <para>
162     Documentation changes
163     <itemizedlist>
164       <listitem>
165         <para>
166           Re-create the drill template images; they should print
167           correctly from Firefox at least. Ship these as individual
168           PDF files so they're easy to print.
169         </para>
170       </listitem>
171       <listitem>
172         <para>
173           Add a description of the 'Apogee Lockout' setting, which
174           prevents the apogee charge from firing for a configurable
175           amount of time after boost.
176         </para>
177       </listitem>
178     </itemizedlist>
179   </para>
180 </article>