NAME

Device::GPS - Read GPS (NMEA) data over a wire

SYNOPSIS

my $gps = Device::GPS->new({
    connection => Device::GPS::Connection::Serial->new({
        port => '/dev/ttyACM0',
        baud => 9600,
    }),
});
$gps->add_callback( $gps->CALLBACK_POSITION, sub {
    my ($time, $lat_deg, $lat_min, $lat_sec, $ns,
        $long_deg, $long_min, $long_sec, $ew,
        $quality, $satellites, $horz_dil, $altitude, $height, 
        $time_since_last_dgps, $dgps_station_id) = @_;
    say "Lat: $lat_deg deg $lat_min.$lat_sec' $ns";
    say "Long: $long_deg deg $long_min.$lat_sec' $ew";
});


while(1) { $gps->parse_next }

DESCRIPTION

Captures GPS data using a callback system.

METHODS

new

my $gps = Device::GPS->new({
    connection => Device::GPS::Connection::Serial->new({
        port => '/dev/ttyACM0',
        baud => 9600,
    }),
});

Constructor. The connection parameter needs to be some object that does the Device::GPS::Connection role.

parse_next

Call this continually in a loop to get the next set of data.

add_callback

add_callback( $callback_type, $callback )

Set a callback that will be called when we parse a given GPS command. There are constants provided for the types. Below is a list of the constants and the arguments your callback will get for each one.

CALLBACK_POSITION (GPGGA)

($time, $lat_deg, $lat_min, $lat_sec, $ns,
    $long_deg, $long_min, $long_sec, $ew,
    $quality, $satellites, $horz_dil, $altitude, $height, 
    $time_since_last_dgps, $dgps_station_id);

• time - Time of capture

• lat_deg - Latitude degrees

• lat_min - Latitude arcminutes

• lat_sec - Latitude arcseconds

• ns - "N" or "S" for latitude

• long_deg - Longitude degrees

• long_min - Longitude arcminutes

• long_sec - Longitude arcseconds

• ew - "E" or "W" for longitude

• quality - Quality number

• satellites - Number of satellites being tracked

• horz_dil - Horizontal dilution of position

• altitude - Altitude in meters above sealevel

• height - Height of geoid

• time_since_last_dgps - time (in seconds) since last DGPS update

• dgps_station_id - DGPS station ID number

CALLBACK_VELOCITY (GPVTG)

($true_track, 'T', $mag_track, 'M', $ground_speed_knots, 'N',
    $ground_speed_kph, 'K');

• true_track - True track made good (degrees)

• mag_track - Magnetic track made good

• ground_speed_knots - Ground speed in knots

• ground_speed_kph - Ground speed in kph

CALLBACK_ACTIVE_SATS (GPGSA) CALLBACK_SATS_IN_VIEW (GPGSV) CALLBACK_REC_MIN (GPRMC) CALLBACK_GEO_LOC (GPGLL)

SEE ALSO

GPS::NMEA

LICENSE

Copyright (c) 2015 Timm Murray All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, 
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright 
  notice, this list of conditions and the following disclaimer in the 
  documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.