typo fixed
[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 includes a
8 number of utilities useful for monitoring and logging telemetry during flight,
9 post-processing flight data for analysis, and utilities for updating firmware,
10 and developing and debugging new functionality.  The first generation of these
11 utilities were Linux-only, but our current second-generation software written
12 largely in [Java](http://java.com) with a small platform-specific library 
13 works identically on Windows, Mac, and Linux systems!
14
15 ## Features ##
16
17 ### User View ###
18
19 Documentation is coming soon, but in the meantime, 
20 most operations in the second-generation GUI are pretty easy to figure out.
21
22 ### Developer View ###
23
24 * The firmware and associated software are licensed [GPL version 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
25
26 ## Artifacts ##
27
28 The source is available from [git.gag.com](http://git.gag.com) in the project 
29 [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).  
30
31 ### Linux ###
32
33 If you use [Debian](http://www.debian.org), then a pre-built package for 
34 32-bit x86 is currently available here:
35
36         wget -O - http://altusmetrum.org/apt/altusmetrum.key | apt-key add -
37         wget -O /etc/apt/sources.list.d/altos.list http://altusmetrum.org/apt/altos.list
38         apt-get update
39         apt-get install altos
40
41 If you use some other distribution of Linux, then 
42 a [Linux package](Altos-Linux.tgz) of our second-generation Java bits that 
43 should run on any distribution with a modern Java version is also 
44 available.  Unlike the Debian pacakge, which depends on various libraries
45 already part of the Debian distribution, this package includes a "fat" jar
46 file with all of the Java libraries that aren't part of the basic Java runtime
47 environment included, so it should "just work" on any system with 
48 Java 6.  Development and testing is done with OpenJDK 6, but current 
49 downloads from [java.com](http://java.com) should be fine too.
50
51 If you'd rather build from source, our source tree includes documentation on 
52 how to build packages for various
53 Linux systems such as [Arch Linux](http://www.archlinux.org), and the 
54 debian/ directory contains all the control
55 files for building the Debian packages on other architectures or derivatives
56 such as [Ubuntu](http://ubuntu.com).
57
58 Bdale has also created a theme for 
59 [GDM](http://projects.gnome.org/gdm/) that he uses on his primary notebook,
60 and the 
61 [Simple Login Manager](http://slim.berlios.de/) that he uses on all of his
62 other machines and which is ideally suited for machines dedicated to AltOS 
63 ground station use.  It includes a photo of a drag-race between 
64 nearly-identical rockets
65 built by Keith and Bdale, that was the first time either of us gave TeleMetrum
66 complete control of a rocket flight without some other backup!  See the themes/
67 directory in the source tree (the themes are included in the Debian package).
68
69 ### Mac ###
70
71 A [Mac OS X package](Altos-Mac.zip) that is compatible with 
72 versions 10.5 "Leopard" and later (including 10.6 "Snow Leopard") is now 
73 available.  The Mac operating system includes Java, and all Altus Metrum
74 products show up as simple USB serial ports, so this should just work
75 with no additional drivers or other dependency issues.  Older versions of 
76 the Mac operating system come with Java version that are too old for use 
77 with Altus Metrum software, and we know of no way to update the Java version
78 other than upgrading to a newer operating system.
79
80 ### Windows ###
81
82 Our [Windows package](Altos-Windows.zip) is known to work on XP and 
83 32-bit Windows 7 Enterprise.  If you don't already have Java installed, 
84 download and install a current Java 6 version from [java.com](http://java.com)
85 first.  Then download our zip and extract the files.  Windows already has 
86 the required USB serial device driver, but you will probably need to manually
87 point to the telemetrum.inf file included in the download when you first plug 
88 in an Altus Metrum device to "train" Windows to know that it's ok to use the 
89 existing driver to support our products.  Once that's taken care of, just
90 clicking on the 'altosui' program should work to launch the user interface.
91 Reports of success or failure with other versions of Windows would be 
92 appreciated!
93