21aa8ba42b098f32cd242479369662a6fd9424b3
[web/altusmetrum] / AltOS / index.mdwn
1 # AltOS
2
3 AltOS is the name of Keith's firmware "operating system" for 
4 [TeleMetrum](../TeleMetrum/) and [TeleDongle](../TeleDongle/).
5
6 In addition to the firmware for [TeleMetrum](../TeleMetrum) and
7 [TeleDongle](../TeleDongle) boards, the AltOS source tree also
8 includes AltosUI, which provides for flight monitoring, post-flight
9 analysis, device configuration and firmware updating. AltosUI runs on
10 Linux, Mac OS X and Windows. It's written in [Java](http://java.com)
11 and offers the same functionality and interface on all three
12 platforms. A small platform-specific library communicates with the USB
13 interface on the Altus Metrum devices.
14
15 There are also Linux-specific tools that provide lower level access to
16 the devices which are useful for developing firmware for the devices.
17
18 The firmware and associated software are licensed [GPL version
19 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
20
21 ## Available Versions ##
22
23 There is a single manual for all Altus Metrum products, which is available 
24 in [html](doc/altusmetrum.html) and [pdf](doc/altusmetrum.pdf) formats.
25
26 [[!inline pages="./releases/* and !*/Discussion and !*.bz2 and !*.zip and !*.exe" show="10" rss="no" raw="yes" ]]
27
28 The latest source, which may include unreleased work in progress, is always 
29 available from [git.gag.com](http://git.gag.com) 
30 in the project [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).  
31
32 If you need to debug code on an Altus Metrum product, you may want our special
33 version of SDCC containing a highly modified sdcdb with support for the cc1111
34 debugging interface, which you can find on [git.gag.com](http://git.gag.com) 
35 in the project [fw/sdcc](http://git.gag.com/?p=fw/sdcc;a=summary).  This is
36 not necessary if you just want to rebuild AltOS and use it.
37
38 ### Version 0.9.2 Features ###
39
40 Version 0.9.2 is an AltosUI bug-fix release, with no firmware changes.
41
42  * Fix plotting problems due to missing file in the Mac OS install image.
43
44  * Always read whole eeprom blocks, mark empty records invalid, display
45    parsing errors to user.
46
47  * Add software version to Configure AltosUI dialog
48
49 ### Version 0.9 Features ###
50
51 Version 0.9 adds a few new firmware features and accompanying AltosUI
52 changes, along with new hardware support.
53
54  * Support for TeleMetrum v1.1 hardware. Sources for the flash memory
55    part used in v1.0 dried up, so v1.1 uses a different part which
56    required a new driver and support for explicit flight log erasing.
57
58  * Multiple flight log support. This stores more than one flight log
59    in the on-board flash memory. It also requires the user to
60    explicitly erase flights so that you won't lose flight logs just
61    because you fly the same board twice in one day.
62
63  * Telemetry support for devices with serial number >= 256. Previous
64    versions used a telemetry packet format that provided only 8 bits
65    for the device serial number. This change requires that both ends
66    of the telemetry link be running the 0.9 firmware or they will not
67    communicate.
68
69 ### Version 0.8 Features ###
70
71 Version 0.8 offers a major upgrade in the AltosUI
72 interface. Significant new features include:
73
74 * Post-flight graphing tool. This lets you explore the behaviour of
75   your rocket after flight with a scroll-able and zoom-able chart
76   showing the altitude, speed and acceleration of the airframe along
77   with events recorded by the flight computer. You can export graphs
78   to PNG files, or print them directly.
79
80 * Real-time moving map which overlays the in-progress flight on
81   satellite imagery fetched from
82   [Google Maps](http://maps.google.com). This lets you see in pictures
83   where your rocket has landed, allowing you to plan recovery
84   activities more accurately.
85
86 * Wireless recovery system testing. Prep your rocket for flight and test
87   fire the deployment charges to make sure things work as
88   expected. All without threading wires through holes in your
89   airframe.
90
91 * Optimized flight status displays. Each flight state now has it's own
92   custom 'tab' in the flight monitoring window so you can focus on the
93   most important details. Pre-flight, the system shows a set of
94   red/green status indicators for battery voltage, apogee/main igniter
95   continutity and GPS reception. Wait until they're all green and your
96   rocket is ready for flight. There are also tabs for ascent, descent
97   and landing along with the original tabular view of the data.
98
99 * Monitor multiple flights simultaneously. If you have more than one
100   TeleDongle, you can monitor a flight with each one on the same
101   computer.
102
103 * Automatic flight monitoring at startup. Plug TeleDongle into the
104   machine before starting AltosUI and it will automatically connect to
105   it and prepare to monitor a flight.
106
107 * Exports Google Earth flight tracks. Using the Keyhole Markup
108   Language (.kml) file format, this provides a 3D view of your rocket
109   flight through the Google Earth program.
110
111 ### Version 0.7.1 Features ###
112
113 Version 0.7.1 is the first release containing our new cross-platform Java-based user interface. AltosUI can:
114
115 * Receive and log telemetry from a connected TeleDongle device. All data 
116   received is saved to log files named with the current date and the connected 
117   rocket serial and flight numbers. There is no mode in which telemetry data 
118   will not be saved.
119
120 * Download logged data from TeleMetrum devices, either through a direct USB 
121   connection or over the air through a TeleDongle device.
122
123 * Configure a TeleMetrum device, setting the radio channel, callsign, apogee 
124   delay and main deploy height. This can be done through either a USB 
125   connection or over a radio link via a TeleDongle device.
126
127 * Replay a flight in real-time. This takes a saved telemetry log or eeprom 
128   download and replays it through the user interface so you can relive your 
129   favorite rocket flights.
130
131 * Reprogram Altus Metrum devices. Using an Altus Metrum device connected via 
132   USB, another Altus Metrum device can be reprogrammed using the supplied 
133   programming cable between the two devices.
134
135 * Export Flight data to a comma-separated-values file. This takes either 
136   telemetry or on-board flight data and generates data suitable for use in 
137   external applications. All data is exported using standard units so that no 
138   device-specific knowledge is needed to handle the data.
139
140 * Speak to you during the flight. Instead of spending the flight hunched over 
141   your laptop looking at the screen, enjoy the view while the computer tells 
142   you what’s going on up there. During ascent, you hear the current flight 
143   state and altitude information. During descent, you get azimuth, elevation 
144   and range information to try and help you find your rocket in the air. Once 
145   on the ground, the direction and distance are reported.
146
147 AltosUI provides all of these features on the three target operating systems, 
148 Linux, Mac OS X (version 10.5 or newer) and Windows (XP, Vista or 7). The bulk 
149 of the software is written in Java and is built once and tested and delivered 
150 on all three target platforms. A tiny ‘shim’ library is built on each system 
151 to provide access to the Altus Metrum devices connected over the USB link.
152
153 ## Future Plans ##
154
155 A number of features are implemented or in process in the sources available
156 in our publicly visible repository that are not part of the current stable
157 release.
158
159 * A Kalman-filter based approach to apogee detection using more than just the
160   baro sensor, so that we can safely control apogee ejection on flights to
161   altitudes beyond the range of our baro sensor alone.  Unlike the other items
162   on the list, this will be a significant change to the in-rocket TeleMetrum
163   firmware.  It may therefore be a while before this becomes part of a stable 
164   firmware release.
165
166 * Motor characterization. Because TeleMetrum contains a
167   high-resolution, high-frequency accelerometer, it is possible to
168   take the data from that and compute an accurate thrust curve for
169   the motor.
170
171 * Comprehensive PDF and/or HTML -based flight report. Construct a
172   complete report of the flight suitable for publication on the web
173   that includes graphs of the flight and details about motor
174   performance etc.
175    
176 * Publish flight data to the Altus Metrum web site. This will allow
177   you to share your flight data with others, and let you download
178   flights published by others.
179
180 There are any number of additions that could be made to this list; feel free 
181 to send along ideas that you’ve got. Of course, all of this software is 
182 licensed under the GNU General Public License, so you can get the source and 
183 hack on it in the comfort of your own home.
184
185 ## Platform Specific Notes ##
186
187 ### Linux ###
188
189 If you use [Debian](http://www.debian.org), then a pre-built package for 
190 32-bit x86 is currently available here:
191
192         wget -O - http://altusmetrum.org/apt/altusmetrum.key | apt-key add -
193         wget -O /etc/apt/sources.list.d/altos.list http://altusmetrum.org/apt/altos.list
194         apt-get update
195         apt-get install altos
196
197 If you use some other distribution of Linux, then 
198 a Linux package of our second-generation Java bits that 
199 should run on any distribution with a modern Java version is also 
200 available.  Unlike the Debian pacakge, which depends on various libraries
201 already part of the Debian distribution, this package includes a "fat" jar
202 file with all of the Java libraries that aren't part of the basic Java runtime
203 environment included, so it should "just work" on any system with 
204 Java 6.  Development and testing is done with OpenJDK 6, but current 
205 downloads from [java.com](http://java.com) should be fine too.
206
207 If you'd rather build from source, our source tree includes documentation on 
208 how to build packages for various
209 Linux systems such as [Arch Linux](http://www.archlinux.org), and the 
210 debian/ directory contains all the control
211 files for building the Debian packages on other architectures or derivatives
212 such as [Ubuntu](http://ubuntu.com).
213
214 Bdale has also created a theme for 
215 [GDM](http://projects.gnome.org/gdm/) that he uses on his primary notebook,
216 and the 
217 [Simple Login Manager](http://slim.berlios.de/) that he uses on all of his
218 other machines and which is ideally suited for machines dedicated to AltOS 
219 ground station use.  It includes a photo of a drag-race between 
220 nearly-identical rockets
221 built by Keith and Bdale, that was the first time either of us gave TeleMetrum
222 complete control of a rocket flight without some other backup!  See the themes/
223 directory in the source tree (the themes are included in the Debian package).
224
225 ### Mac ###
226
227 A Mac OS X package that is compatible with versions 10.5 "Leopard" and
228 later (including 10.6 "Snow Leopard") is available.  The Mac operating
229 system includes Java, and all Altus Metrum products show up as simple
230 USB serial ports, so this should just work with no additional drivers
231 or other dependency issues.  Older versions of the Mac operating
232 system, and even newer versions for PowerPC-based machines, come with
233 Java version 5 or older, which is too old for use with Altus Metrum
234 software. We know of no way to update the Java version other than
235 upgrading to a newer operating system (for Intel based macs) or
236 purchasing new hardware (for PowerPC based macs).
237
238 ### Windows ###
239
240 Our Windows package is known to work on at least some flavors of XP, Vista, and 
241 Windows 7 Enterprise. If you don't already have Java installed, 
242 download and install a current Java 6 version from [java.com](http://java.com)
243 first.  Then download our installer and run it.  Windows already has 
244 the required USB serial device driver, and our package should do the right
245 things to bind it to our devices, but if you get a complaint about the device
246 being unrecognized, try pointing to the copy of the telemetrum.inf file 
247 included in the package directory manually.