try the AltOS index page to see if the builder works
authorBdale Garbee <bdale@gag.com>
Fri, 17 May 2013 05:49:10 +0000 (23:49 -0600)
committerBdale Garbee <bdale@gag.com>
Fri, 17 May 2013 05:49:10 +0000 (23:49 -0600)
MicroPeak/index.mdwn

index 3f75c209255826114128740a333fe92d1990632a..745e53da32dcae02cc01c155a7bdde30efdf4605 100644 (file)
-[[!meta title="MicroPeak"]]
-<img src="../logos/micropeak-oneline.svg" height="100"/>
+# AltOS
 
-# Introducing MicroPeak by AltusMetrum #
+AltOS is the name of Keith's firmware "operating system" for 
+Altus Metrum products.
 
-Micropeak is a barometric logging altimeter for precision model
-rocketry altitude measurements.
+In addition to the firmware for hardware products like
+[TeleMetrum](../TeleMetrum), [TeleMini](../TeleMini), and
+[TeleDongle](../TeleDongle), the AltOS source tree also
+includes AltosUI, which provides for flight monitoring, post-flight
+analysis, device configuration and firmware updating. AltosUI runs on
+Linux, Mac OS X and Windows. It's written in [Java](http://java.com)
+and offers the same functionality and interface on all three
+platforms. A small platform-specific library communicates with the USB
+interface on the Altus Metrum devices.
 
-<a href="v1.0/micropeak-dime.jpg"><img
-src="v1.0/micropeak-dime-640.jpg"></a>
+There are also Linux-specific tools that provide lower level access to
+the devices which are useful for developing firmware for the devices.
 
-Production units are available from the
-[Garbee and Garbee](http://auric.gag.com/index.php?route=product/product&product_id=80) 
-web store and [Apogee Components](http://www.apogeerockets.com/Electronics_Payloads/Altimeters/MicroPeak_Altimeter)
+We maintain a list of [launch site GPS coordinates](launch-sites.txt).  If 
+your favorite launch site isn't included, please let us know!
 
-Data download is available using the [MicroPeak USB adapter](../MicroPeakUSB).
+## Available Versions ##
 
-## Documentation ##
+There is a single manual for most Altus Metrum products, which is available 
+in [html](doc/altusmetrum.html) and [pdf](doc/altusmetrum.pdf) formats.
 
-The MicroPeak manual is available in
-[html](../AltOS/doc/micropeak.html) and
-[pdf](../AltOS/doc/micropeak.pdf) formats.
+We also have an AltOS internals document for programmers 
+in [html](doc/altos.html) and [pdf](doc/altos.pdf) formats, and a
+document describing the AltOS over the radio protocol 
+in [html](doc/telemetry.html) and [pdf](doc/telemetry.pdf) formats.
 
-## Software ##
-
-The MicroPeak application runs on Linux, Mac OS X and Windows. It
-communicates with the [MicroPeak USB adapter](../MicroPeakUSB) to download and analyze
-flight data. It's written in [Java](http://java.com) and offers the
-same functionality and interface on all three platforms. It uses the
-FTDI USB Serial drivers to communicate with the hardware. If you're
-running Mac OS X or Windows, a compatible version of those drivers is
-included with the software. You can also install a different from from
-the [FTDI Driver](http://www.ftdichip.com/FTDrivers.htm) page.
+If you're running Windows 8, you should take a look at [Installing AltosUI on
+Windows 8](Win8) which will help you install the operating system
+drivers needed to communicate with the USB hardware.
 
 [[!inline pages="./releases/* and !*/Discussion and !*.html and !*.bz2 and !*.zip and !*.exe" show="10" rss="no" raw="yes" ]]
 
-## Hardware Features ##
-
- * Measure ground pressure and peak altitude pressure.
- * Logs 48 seconds of flight data
- * Orange LED blinks out maximum height in decimeters.
- * 18mm x 14mm. 1.9g including battery.
- * Power switch.
-
-The CR1025 battery holder is mounted on the back side of the board, so there are no external wires or batteries to manage.
-
-## Software features ##
-
- * Saves last flight data to non-volatile memory.
- * Reports previous flight on power-on.
- * Automatically shuts down on landing to preserve battery.
-
-## Battery Holder ##
-
-MicroPeak includes an integrated battery holder on the back side of
-the circuit board.
-
-<a href="v1.0/micropeak-back.jpg"><img
-src="v1.0/micropeak-back-640.jpg"></a>
-
-## Developer View ##
-
-Here's a close-up view of the hardware
-
-<a href="v1.0/micropeak.jpg"><img src="v1.0/micropeak-640.jpg"></a>
-
- * Hardware Features
-       * [ATMEL ATtiny85](http://www.atmel.com/devices/attiny85.aspx) Microcontroller
-               * 8K flash
-               * 512B RAM
-               * 512B EEPROM
-               * SPI/I2C interface
-       * [Measurement Specialties MS5607](http://www.meas-spec.com/product/t_product.aspx?id=8499) Micro Altimeter Module
-               * Wide range — 120kPa to 1kPa (approximately -1500m to 31000m)
-               * High precision — 2.4Pa resolution (approximately 20cm at sea level)
-               * Factory calibrated.
-       * CR1025 Lithium Battery
-               * 30mAh. Runs MicroPeak for more than 40 hours on the pad or in flight
-       * [OSRAM LO T67K](http://catalog.osram-os.com/catalogue/catalogue.do?favOid=000000000002269f00090023&act=showBookmark) orange LED
-       * Standard 6-pin AVR programming interface.
-
- * Software Features
-       * Written in C
-       * Samples pressure every 96ms
-       * Delay 30s after power-on to finish airframe prep
-       * Detect boost with 10m altitude change
-       * Exponential averaging filter to minimize transient effects.
-
- * Tools Used
-       * [gEDA](http://www.gpleda.org/) for schematic capture and PCB layout
-       * [GCC](http://gcc.gnu.org) as an AVR cross-compiler
-
- * Licenses
-       * The hardware is licensed under the [TAPR](http://www.tapr.org) [Open Hardware License](http://www.tapr.org/ohl.html)
-       * The software is licensed [GPL version 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
-
-<center><img src="../logos/micropeak.svg" height="64"/>
+## Source Code ##
+
+The latest source, which may include unreleased work in progress, is always 
+available from [git.gag.com](http://git.gag.com) 
+in the project [fw/altos](http://git.gag.com/?p=fw/altos;a=summary).  
+
+We've gathered a few notes on [buidling AltOS](building).
+
+## Future Plans ##
+
+Bug reports, feature requests, and planning for AltOS releases happens
+on the [Altus Metrum Trac Site](http://trac.gag.com/altusmetrum).
+
+A number of features are implemented or in process in the sources available
+in our publicly visible repository that are not part of the current stable
+release.
+
+* Motor characterization. Because TeleMetrum contains a
+  high-resolution, high-frequency accelerometer, it is possible to
+  take the data from that and compute an accurate thrust curve for
+  the motor.
+
+* Comprehensive PDF and/or HTML -based flight report. Construct a
+  complete report of the flight suitable for publication on the web
+  that includes graphs of the flight and details about motor
+  performance etc.
+   
+* Publish flight data to the Altus Metrum web site. This will allow
+  you to share your flight data with others, and let you download
+  flights published by others.
+
+There are any number of additions that could be made to this list; feel free 
+to send along ideas that you’ve got. Of course, all of this software is 
+licensed under the GNU General Public License, so you can get the source and 
+hack on it in the comfort of your own home.
+
+## Platform Specific Notes ##
+
+### Linux ###
+
+If you use [Debian](http://www.debian.org), you can simply install the 'altos'
+package from any Debian mirror, like so:
+
+               apt-get update
+               apt-get install altos
+
+If you use [Ubuntu](http://ubuntulinux.org), pre-built packages are available
+from [this PPA](https://launchpad.net/~sconklin/+archive/altos/) 
+maintained by Steve Conklin and friends.
+
+If you use some other distribution of Linux, then 
+a Linux package of our second-generation Java bits that 
+should run on any distribution with a modern Java version is also 
+available.  Unlike the Debian pacakge, which depends on various libraries
+already part of the Debian distribution, this package includes a "fat" jar
+file with all of the Java libraries that aren't part of the basic Java runtime
+environment included, so it should "just work" on any system with 
+Java 6.  Development and testing is done with OpenJDK 6, but current 
+downloads from [java.com](http://java.com) should be fine too.
+
+If you'd rather build from source, our source tree includes documentation on 
+how to build packages for various
+Linux systems such as [Arch Linux](http://www.archlinux.org), and the 
+debian/ directory contains all the control
+files for building the Debian packages on other architectures or derivatives
+such as [Ubuntu](http://ubuntu.com).
+
+Bdale has also created a theme for 
+[GDM](http://projects.gnome.org/gdm/) that he uses on his primary notebook,
+and the 
+[Simple Login Manager](http://slim.berlios.de/) that he uses on all of his
+other machines and which is ideally suited for machines dedicated to AltOS 
+ground station use.  It includes a photo of a drag-race between 
+nearly-identical rockets
+built by Keith and Bdale, that was the first time either of us gave TeleMetrum
+complete control of a rocket flight without some other backup!  See the themes/
+directory in the source tree (the themes are included in the Debian package).
+
+### Mac ###
+
+A Mac OS X package that is compatible with versions 10.5 "Leopard" and
+later.  The Mac operating system includes Java, and all Altus Metrum products 
+show up as simple USB serial ports, so this should just work with no 
+additional drivers or other dependency issues.  Older versions of the Mac 
+operating
+system, and even newer versions for PowerPC-based machines, come with
+Java version 5 or older, which is too old for use with Altus Metrum
+software. We know of no way to update the Java version other than
+upgrading to a newer operating system (for Intel based macs) or
+purchasing new hardware (for PowerPC based macs).
+
+If you have trouble installing on a Mac, and are getting errors about the
+package being corrupt, you may not be configured to allow installation of
+software from arbitrary sources.  One customer running 10.8.1 reported that
+he was able to work around this by going to "System Preferences", "Security
+& Privacy", "General", and then clicking the "Anywhere" radio button where
+it askes "Allow applications downloaded from:".
+
+### Windows ###
+
+Our Windows package is known to work on at least some flavors of XP, Vista, and 
+Windows 7 Enterprise. If you don't already have Java installed, 
+download and install a current Java 6 version from [java.com](http://java.com)
+first.  Then download our installer and run it.  Windows already has 
+the required USB serial device driver, and our package should do the right
+things to bind it to our devices, but if you get a complaint about the device
+being unrecognized, try pointing to the copy of the telemetrum.inf file 
+included in the package directory manually.
+
+Note that on some Windows 7 systems, it may be necessary to install AltOS using
+'compatibility mode'.  You can set this mode by 
+[changing the properties](http://www.sevenforums.com/tutorials/316-compatibility-mode.html)
+of the installer .exe.
+
+## License ##
+
+The firmware and associated software are licensed [GPL version
+2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)