757f9b7535d9c8ca903f491406b6975fc9403ed9
[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 The firmware and associated software are licensed [GPL version 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
16
17 ## Available Versions ##
18
19 [[!inline pages="./releases/* and !*/Discussion" show="10"
20 actions=no rootpage="releases" ]]
21
22 The latest source is always available from [git.gag.com](http://git.gag.com) 
23 in the project [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).  
24
25 ## Features ##
26
27 More documentation is coming soon, but in the meantime, 
28 most operations in the second-generation GUI are pretty easy to figure out.
29
30 ## Platform Specific Notes ##
31
32 ### Linux ###
33
34 If you use [Debian](http://www.debian.org), then a pre-built package for 
35 32-bit x86 is currently available here:
36
37         wget -O - http://altusmetrum.org/apt/altusmetrum.key | apt-key add -
38         wget -O /etc/apt/sources.list.d/altos.list http://altusmetrum.org/apt/altos.list
39         apt-get update
40         apt-get install altos
41
42 If you use some other distribution of Linux, then 
43 a Linux package of our second-generation Java bits that 
44 should run on any distribution with a modern Java version is also 
45 available.  Unlike the Debian pacakge, which depends on various libraries
46 already part of the Debian distribution, this package includes a "fat" jar
47 file with all of the Java libraries that aren't part of the basic Java runtime
48 environment included, so it should "just work" on any system with 
49 Java 6.  Development and testing is done with OpenJDK 6, but current 
50 downloads from [java.com](http://java.com) should be fine too.
51
52 If you'd rather build from source, our source tree includes documentation on 
53 how to build packages for various
54 Linux systems such as [Arch Linux](http://www.archlinux.org), and the 
55 debian/ directory contains all the control
56 files for building the Debian packages on other architectures or derivatives
57 such as [Ubuntu](http://ubuntu.com).
58
59 Bdale has also created a theme for 
60 [GDM](http://projects.gnome.org/gdm/) that he uses on his primary notebook,
61 and the 
62 [Simple Login Manager](http://slim.berlios.de/) that he uses on all of his
63 other machines and which is ideally suited for machines dedicated to AltOS 
64 ground station use.  It includes a photo of a drag-race between 
65 nearly-identical rockets
66 built by Keith and Bdale, that was the first time either of us gave TeleMetrum
67 complete control of a rocket flight without some other backup!  See the themes/
68 directory in the source tree (the themes are included in the Debian package).
69
70 ### Mac ###
71
72 A Mac OS X package that is compatible with 
73 versions 10.5 "Leopard" and later (including 10.6 "Snow Leopard") is 
74 available.  The Mac operating system includes Java, and all Altus Metrum
75 products show up as simple USB serial ports, so this should just work
76 with no additional drivers or other dependency issues.  Older versions of 
77 the Mac operating system come with Java versions that are too old for use 
78 with Altus Metrum software, and we know of no way to update the Java version
79 other than upgrading to a newer operating system.
80
81 ### Windows ###
82
83 Our Windows package is known to work on at least some flavors of XP, Vista, and 
84 Windows 7 Enterprise. If you don't already have Java installed, 
85 download and install a current Java 6 version from [java.com](http://java.com)
86 first.  Then download our installer and run it.  Windows already has 
87 the required USB serial device driver, and our package should do the right
88 things to bind it to our devices, but if you get a complaint about the device
89 being unrecognized, try pointing to the copy of the telemetrum.inf file 
90 included in the package directory manually.  Reports of success or failure 
91 with other versions of Windows would be appreciated!