rtkgps(1)

NAME
rtkgps - download log files and read/set device status for certain models of Royaltek GPS logger

SYNOPSIS
rtkgps [-h] [-v] [-d dev [-r rate] | -b addr] command

DESCRIPTION
rtkgps allows device configuration, status reporting, and log downloading for some models (RBT-2300 and RGM-3800) of Royaltek GPS loggers. RtkGPS provides a command line interface (unlike some of the other software for this device, which is GUI based), but should work on any Linux platform, including portable devices such as the Nokia 770/800 series. Unless disabled at compile time, rtkgps corrects the altitude values read from the logger by estimating the EGM96 geoid undulations with respect to the WGS-84 ellipsoid.

GENERAL OPTIONS

-h  Display usage information.

-v  Verbose mode.

-d dev
    Connect to GPS logger via serial device dev.

-r rate
    Configure serial device to communicate at rate baud. Valid values are 50, 75, 150, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, and 115200. The default is 57600 baud.

-b addr
    Connect to GPS logger using bluetooth address addr.

If neither -d nor -b is specified, a bluetooth scan will be performed for a device with matching name; if a single matching device is found, the bluetooth address of that device will be used to open a connection.

COMMANDS

[-e] status
    Display current GPS logger device status. Options are:

    -e  Display extended status information.

date
    Determine current UTC date/time.

list
    List log files on GPS logger.

[-c flg] [-l lgtp] [-m mfo] [-s int] set
    Set GPS logger parameters. Options are:

    -c flg
        Specify real-time location output mode. Valid values of flg are 0 (disable) and 1 (enable).

    -l lgtp
        Specify log type. Valid values of lgtp are tl (time,location), tla (time,location,altitude), and tlav (time,location,altitude,velocity).

    -m mfo
        Specify memory full behaviour. Valid values of mfo are o (overwrite) and s (stop).

    -s int
        Specify sampling interval in seconds. Valid values of int are integers in the range from 1 to 60.

[-n] [-p] [-o dest [-u]] [-f nstr] read
    Retrieve a log file from the GPS logger. If a log file index is not specified, all log files are retrieved. Options are:

    -n  Write log in simple native text format instead of the default NMEA format.

    -p  Display text progress bar during log file retrieval.

    -o dest
        Specify destination path. If dest is a directory, output is written to a file in that directory named according to a standard format, otherwise output is written to the specified file. The standard filename format is the date and time of the first fix in the log file.

    -u  Skip downloading date for existing files. This flag is ignored for the last log file in memory since it is actively being extended, and will differ each time it is downloaded.

    -f nstr
        Specify index number(s) of log file(s) to retrieve as a single file number, or a range in the format n-m (all integers between n and m, inclusive), -m (all integers from 0 to m, inclusive), or n- (all integers from n to the maximum file index, inclusive).

[-y] erase
    Erase all log files in GPS logger memory. Options are:

    -y  Don't ask for confirmation.

CAVEATS
This version of rtkgps should be used with caution, as it has not yet been extensively tested. Thus far the only testing has been on a little-endian architecture, with the RBT-2300 and RGM-3800. Code has been included to support big-endian architectures, but this has not been tested. Bug reports would be appreciated, as would reports from users attempting to use this software on a big-endian architecture.

AUTHOR
Brendt Wohlberg <osspkg@gmail.com>

COPYRIGHT
The geoid height data file ww15mgh.dat was derived from the ww15mgh.grd data obtained from <http://earth-info.nga.mil/GandG/wgs84/gravitymod/egm96/egm96.html>, which appears (there is no explicit license information) to be in the public domain. The remainder of the rtkgps distribution is subject to the following copyright/license terms: Copyright © 2008-2010 Brendt Wohlberg <osspkg@gmail.com> This program is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License <http://www.gnu.org/licenses/gpl-2.0.txt>. 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.

ACKNOWLEDGMENT
This software would not have been possible without the details of the communications protocol kindly provided by "Aeropic", author of Pocket PC software <http://aeropic.free.fr/RBT_2300> for the RBT-2300. A few additional commands in the communications protocol were discovered in the rgm3800.py software <http://www.kapet.de/rgm3800/> by Karsten Petersen. Martin Weber <martin dot weber at gmx dot info> pointed out some bugs and submitted numerous code improvements, including support for the RGM3800 and for compiling under the Cygwin environment.