view release on metacpan or  search on metacpan

README  view on Meta::CPAN

            The passed hash references are read-only.

        on_fix => $cb->({point})
            Called regularly (usually about once/second), even when there is
            no connection to the GPSD (so is useful to update your idea of
            the current position). The passed hash reference must *not* be
            modified in any way.

            If "mode" is 2 or 3, then the "{point}" hash contains at least
            the following members, otherwise it is undefined which members
            exist. Members whose values are not known are "undef" (usually
            the error values, speed and so on).

               time         when this fix was received (s)

               lat          latitude (S -90..90 N)
               lon          longitude (W -180..180 E)
               alt          altitude

               herr         estimated horizontal error (m)
               verr         estimated vertical error (m)

               bearing      bearing over ground (0..360)
               berr         estimated error in bearing (degrees)
               speed        speed over ground (m/s)
               serr         estimated error in speed over ground (m/s)
               vspeed       vertical velocity, positive = upwards (m/s)
               vserr        estimated error in vspeed (m/s)

               mode         1 = no fix, 2 = 2d fix, 3 = 3d fix

    ($lat, $lon) = $gps->estimate ([$max_seconds])
        This returns an estimate of the current position based on the last
        fix and the time passed since then.

        Useful for interactive applications where you want more frequent
        updates, but not very useful to store, as the next fix might well be
        totally off. For example, when displaying a real-time map, you could
        simply call "estimate" ten times a second and update the cursor or
        map position, but you should use "on_fix" to actually gather data to
        plot the course itself.

        If the fix is older then $max_seconds (default: 1.9 times the update
        interval, i.e. usually 1.9 seconds) or if no fix is available,
        returns the empty list.

    $gps->record_log ($path)
        If $path is defined, then that file will be created or truncated and
        a log of all (raw) packets received will be written to it. This log
        file can later be replayed by calling "$gps->replay_log ($path)".

        If $path is undefined then the log will be closed.

    $gps->replay_log ($path, %options)
        Replays a log file written using "record_log" (or stops replaying
        when $path is undefined). While the log file replays, real GPS
        events will be ignored. This comes in handy when testing.

        Please note that replaying a log will change configuration options
        that will not be restored, so it's best not to reuse a gpsd object
        after a replay.

        The "AnyEvent::GPSD" distribution comes with an example log
        (eg/example.aegps) that you can replay for testing or enjoyment
        purposes.

        The options include:

        compress => 1
            If set to a true value (default: false), then passages without
            fix will be replayed much faster than passages with fix. The
            same happens for passages without much movement.

        stretch => $factor
            Multiplies all times by the given factor. Values < 1 make the
            log replay faster, values > 1 slower. Note that the frequency of
            fixes will not be increased, o stretch factors > 1 do not work
            well.

            A stretch factor of zero is not allowed, but if you want to
            replay a log instantly you may speicfy a very low value (e.g.
            1e-10).

SEE ALSO
    AnyEvent.

AUTHOR
       Marc Lehmann <schmorp@schmorp.de>
       http://home.schmorp.de/