OpenGPS Readme
--------------

LICENSE
-------

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA

REQUIREMENTS
------------

1) x86 PC >=1GHz and >=64MB RAM.
2) RTAI-patched Linux kernel

INSTALL
-------

OpenGPS has been tested with RTAI 3.1 and Linux kernel 2.4.27.  It is
recommended to use these if possible. Things will probably work on a 2.6
kernel, but you are on your own if it doesn't.

RTAI: http://www.rtai.org
Kernel: http://www.kernel.org/pub/linux/kernel/v2.4/linux-2.4.27.tar.bz2

Follow the documentation for installing RTAI + Linux kernel. Once you are
done with this, compile the needed OpenGPS code:

cd <OpenGPS_Install_dir>/src/ogr
make

This will compile and install ogr and ogrt_module.o (described below).

RUNNING
-------

OpenGPS has two parts to it:

1) kernel module (ogrt_module.o)
2) User-land support code (ogr)

To run this code, one must first insert the rtai modules into the kernel, 
then insert ogrt_module.o and run the user-side ogr binary, do this 
with the scripts (as root)

cd OpenGPS/scripts/
./rtai_load.sh

run the binary

ogr
(all data files and input files will be created wrt. your current working
 directory, so with the default setup, you'd better be in OpenGPS/ when
 running the ogr binary)

when done, ctrl-c and

cd OpenGPS/scripts
./rtai_unload.sh

Depending on how you compiled RTAI, you might have to edit the script a bit.

If all goes well, you won't see any error message (maybe some warnings).

At this point the receiver will start up, do a self-test and start searching
for satellites in OpenGPS/input/acquisitionList.txt

OTHER PROGRAMS
--------------

There are some other programs you can use to see what the receiver is doing:

ogMenu
------
Compile and install with:

cd OpenGPS/src/menu
make
ogMenu

WHERE DATA IS SAVED
-------------------

Have a look at OpenGPS/input/channels.txt

Data will be saved with respect to your current working dir in directories
corresponding to the GMT time.

HARDWARE SUPPORT
----------------

Look in OpenGPS/include/ogrt_defines.h

You can undef and define the board that you have. Remember to recompile the
code in OpenGPS/src/ogr.
