git.gag.com Git - web/altusmetrum/blob - AltOS/index.mdwn

   1 # AltOS
   2
   3 AltOS is the name of Keith's firmware "operating system" for
   4 Altus Metrum products.
   5
   6 In addition to the firmware for hardware products like
   7 [TeleMetrum](../TeleMetrum), [TeleMini](../TeleMini), and
   8 [TeleDongle](../TeleDongle), the AltOS source tree also
   9 includes AltosUI, which provides for flight monitoring, post-flight
  10 analysis, device configuration and firmware updating. AltosUI runs on
  11 Linux, Mac OS X and Windows. It's written in [Java](http://java.com)
  12 and offers the same functionality and interface on all three
  13 platforms. A small platform-specific library communicates with the USB
  14 interface on the Altus Metrum devices.
  15
  16 There are also Linux-specific tools that provide lower level access to
  17 the devices which are useful for developing firmware for the devices.
  18
  19 We maintain a list of [launch site GPS coordinates](launch-sites.txt).  If
  20 your favorite launch site isn't included, please let us know!
  21
  22 ## Available Versions ##
  23
  24 There is a single manual for most Altus Metrum products, which is available
  25 in [html](doc/altusmetrum.html) and [pdf](doc/altusmetrum.pdf) formats.
  26
  27 We also have an AltOS internals document for programmers
  28 in [html](doc/altos.html) and [pdf](doc/altos.pdf) formats, and a
  29 document describing the AltOS over the radio protocol
  30 in [html](doc/telemetry.html) and [pdf](doc/telemetry.pdf) formats.
  31
  32 If you're running Windows 8, you should take a look at [Installing AltosUI on
  33 Windows 8](Win8) which will help you install the operating system
  34 drivers needed to communicate with the USB hardware.
  35
  36 Each available download includes AltosUI, documentation, and firmware updates
  37 for all current products.
  38
  39 [[!inline pages="./releases/* and !*/Discussion and !*.sh and !*.html and !*.bz2 and !*.zip and !*.exe and !*.dmg" show="10" rss="no" raw="yes" ]]
  40
  41 ## Source Code ##
  42
  43 The latest source, which may include unreleased work in progress, is always
  44 available from [git.gag.com](http://git.gag.com)
  45 in the project [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).
  46
  47 We've gathered a few notes on [buidling AltOS](building).
  48
  49 ## Future Plans ##
  50
  51 Bug reports, feature requests, and planning for AltOS releases happens
  52 on the [Altus Metrum Trac Site](http://trac.gag.com/altusmetrum).
  53
  54 A number of features are implemented or in process in the sources available
  55 in our publicly visible repository that are not part of the current stable
  56 release.
  57
  58 * Motor characterization. Because TeleMetrum contains a
  59   high-resolution, high-frequency accelerometer, it is possible to
  60   take the data from that and compute an accurate thrust curve for
  61   the motor.
  62
  63 * Comprehensive PDF and/or HTML -based flight report. Construct a
  64   complete report of the flight suitable for publication on the web
  65   that includes graphs of the flight and details about motor
  66   performance etc.
  67
  68 * Publish flight data to the Altus Metrum web site. This will allow
  69   you to share your flight data with others, and let you download
  70   flights published by others.
  71
  72 There are any number of additions that could be made to this list; feel free
  73 to send along ideas that you’ve got. Of course, all of this software is
  74 licensed under the GNU General Public License, so you can get the source and
  75 hack on it in the comfort of your own home.
  76
  77 ## Platform Specific Notes ##
  78
  79 ### Linux ###
  80
  81 If you use [Debian](http://www.debian.org), you can simply install the 'altos'
  82 package from any Debian mirror, like so:
  83
  84                 apt-get update
  85                 apt-get install altos
  86
  87 If you use some other distribution of Linux, then
  88 a Linux package of our second-generation Java bits that
  89 should run on any distribution with a modern Java version is also
  90 available.  Unlike the Debian pacakge, which depends on various libraries
  91 already part of the Debian distribution, this package includes a "fat" jar
  92 file with all of the Java libraries that aren't part of the basic Java runtime
  93 environment included, so it should "just work" on any system with
  94 Java 6.  Development and testing is done with OpenJDK 6, but current
  95 downloads from [java.com](http://java.com) should be fine too.
  96
  97 If you'd rather build from source, our source tree includes documentation on
  98 how to build packages for various
  99 Linux systems such as [Arch Linux](http://www.archlinux.org), and the
 100 debian/ directory contains all the control
 101 files for building the Debian packages on other architectures or derivatives
 102 such as [Ubuntu](http://ubuntu.com).
 103
 104 Bdale has also created a theme for
 105 [GDM](http://projects.gnome.org/gdm/) that he uses on his primary notebook,
 106 and the
 107 [Simple Login Manager](http://slim.berlios.de/) that he uses on all of his
 108 other machines and which is ideally suited for machines dedicated to AltOS
 109 ground station use.  It includes a photo of a drag-race between
 110 nearly-identical rockets
 111 built by Keith and Bdale, that was the first time either of us gave TeleMetrum
 112 complete control of a rocket flight without some other backup!  See the themes/
 113 directory in the source tree (the themes are included in the Debian package).
 114
 115 ### Mac ###
 116
 117 A Mac OS X package that is compatible with versions 10.5 "Leopard" and
 118 later.  The Mac operating system includes Java, and all Altus Metrum products
 119 show up as simple USB serial ports, so this should just work with no
 120 additional drivers or other dependency issues.  Older versions of the Mac
 121 operating
 122 system, and even newer versions for PowerPC-based machines, come with
 123 Java version 5 or older, which is too old for use with Altus Metrum
 124 software. We know of no way to update the Java version other than
 125 upgrading to a newer operating system (for Intel based macs) or
 126 purchasing new hardware (for PowerPC based macs).
 127
 128 If you have trouble installing on a Mac, and are getting errors about the
 129 package being corrupt, you may not be configured to allow installation of
 130 software from arbitrary sources.  One customer running 10.8.1 reported that
 131 he was able to work around this by going to "System Preferences", "Security
 132 & Privacy", "General", and then clicking the "Anywhere" radio button where
 133 it askes "Allow applications downloaded from:".
 134
 135 ### Windows ###
 136
 137 Our Windows package is known to work on at least some flavors of XP, Vista, and
 138 Windows 7 Enterprise. If you don't already have Java installed,
 139 download and install a current Java 6 version from [java.com](http://java.com)
 140 first.  Then download our installer and run it.  Windows already has
 141 the required USB serial device driver, and our package should do the right
 142 things to bind it to our devices, but if you get a complaint about the device
 143 being unrecognized, try pointing to the copy of the telemetrum.inf file
 144 included in the package directory manually.
 145
 146 Note that on some Windows 7 systems, it may be necessary to install AltOS using
 147 'compatibility mode'.  You can set this mode by
 148 [changing the properties](http://www.sevenforums.com/tutorials/316-compatibility-mode.html)
 149 of the installer .exe.
 150
 151 ## License ##
 152
 153 The firmware and associated software are licensed [GPL version
 154 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)