summaryrefslogtreecommitdiff
path: root/gpsprof.xml
blob: 0daa841e78e01355fc77858f026427cec8f11da5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is Copyright (c) 2010 by the GPSD project
BSD terms apply: see the file COPYING in the distribution root for details.
-->
<!DOCTYPE refentry PUBLIC 
   "-//OASIS//DTD DocBook XML V4.1.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='gpsprof.1'>
<refentryinfo><date>10 Feb 2005</date></refentryinfo>
<refmeta>
<refentrytitle>gpsprof</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">The GPSD Project</refmiscinfo>
<refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>gpsprof</refname>
<refpurpose>profile a GPS and gpsd, plotting latency information</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>gpsprof</command>  
      <arg choice='opt'>-f <replaceable>plot_type</replaceable></arg>
      <arg choice='opt'>-m <replaceable>threshold</replaceable></arg>
      <arg choice='opt'>-n <replaceable>packetcount</replaceable></arg>
      <arg choice='opt'>-s <replaceable>speed</replaceable></arg>
      <arg choice='opt'>-t <replaceable>title</replaceable></arg>
      <arg choice='opt'>-D <replaceable>debuglevel</replaceable></arg>
      <arg choice='opt'>-h</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>

<para><application>gpsprof</application> performs accuracy and latency
profiling onm a GPS. It emits to standard output a GNUPLOT program
that draws an illustrative graph. It can also be told to emit the raw
profile data.  The information it provides can be useful for
establishing an upper bound on latency, and thus on position accuracy
of a GPS in motion.</para>

<para><application>gpsprof</application> uses instrumentation built
into <application>gpsd</application>.</para>

<para>To display the graph, use
<citerefentry><refentrytitle>gnuplot</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
Thus, for example, to display the default spatial scatter plot, do
this:

<programlisting>
gpsprof | gnuplot -persist
</programlisting>
</para>

</refsect1>
<refsect1 id='options'><title>OPTIONS</title>

<para>The -f option sets the plot type. The X axis is samples
(sentences with timestamps).  The Y axis is normally latency in seconds.
Currently the following plot types are defined:</para>

<variablelist>
<varlistentry>
<term>space</term>
<listitem>
<para>Generate a scattergram of fixes and plot a probable-error
circle.  This data is only meaningful if the GPS is held stationary
while <application>gpsprof</application> is running. 
This is the default.</para>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>uninstrumented</term>
<listitem>
<para>Plot total latency without instrumentation.  Useful mainly as a
check that the instrumentation is not producing significant
distortion.  It only plots times for reports that contain fixes;
staircase-like artifacts in the plot are created when elapsed time
from reports without fixes is lumped in.</para>
</listitem>
</varlistentry>
</variablelist>

<para>Because of RS232 buffering effects, the profiler sometimes
generates reports of ridiculously high latencies right at the
beginning of a session.  The -m option lets you set a latency threshold, in
multiples of the cycle time, above which reports are discarded.</para>

<para>The -n option sets the number of packets to sample.  The default
is 100.</para>

<para>The -s option sets the baud rate.  Note, this will only work if
the chipset accepts a speed-change command (SiRFstarII and SiRFstarIII
support this feature).</para>

<para>The -t option sets a text string to be included in the plot
title.</para>

<para>The -h option makes <application>gpsprof</application> print 
a usage message and exit.</para>

<para>The -D sets debug level.</para>

</refsect1>
<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>gpsd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgps</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libgpsd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsfake</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpsctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gpscat</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnuplot</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
</refsect1>

<refsect1 id='maintainer'><title>AUTHOR</title> 

<para>Eric S. Raymond <email>esr@thyrsus.com</email>.  There is a
project page for <application>gpsd</application> <ulink
url="http://gpsd.berlios.de/">here</ulink>.</para>

</refsect1>

</refentry>