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

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