summaryrefslogtreecommitdiff
path: root/gpsd.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2006-06-07 14:55:39 +0000
committerEric S. Raymond <esr@thyrsus.com>2006-06-07 14:55:39 +0000
commit5568d76480dab43f3340b0f8fe4f47e1fe1f2a0b (patch)
tree0b71fdd78f18d59f511ea33210138432821e686c /gpsd.xml
parent3cbcbb2d4c2012f6c15862612f84383670d1cdd6 (diff)
downloadgpsd-5568d76480dab43f3340b0f8fe4f47e1fe1f2a0b.tar.gz
Robin Darroch's O-mode patch merged...
...but actual generation of the mode field is disabled. Regression tests fail in a strange way; checksums are off by one. Must grovel back through the versions and figure out why.
Diffstat (limited to 'gpsd.xml')
-rw-r--r--gpsd.xml23
1 files changed, 19 insertions, 4 deletions
diff --git a/gpsd.xml b/gpsd.xml
index d2e86418..6ac06869 100644
--- a/gpsd.xml
+++ b/gpsd.xml
@@ -236,7 +236,7 @@ cycle times; consult your hardware protocol description to make sure
this works.</para>
<para>This command will return '?' at start of session, before the
-first full packet has been received from the GPS, because its type is
+first full packet has been received from the GPS, because the GPS type is
not yet known. To set up conditions for a real answer, issue it after
some command that reads position/velocity/time information from the
device.</para></listitem>
@@ -394,7 +394,9 @@ fractional part of up to .01sec precision.</para></listitem>
<varlistentry>
<term>altitude</term>
-<listitem><para>Altitude as in the A report (%f, meters).</para></listitem>
+<listitem><para>Altitude as in the A report (%f, meters). If the mode
+field is not 3 this is an estimate and should be treated as
+unreliable.</para></listitem>
</varlistentry>
<varlistentry>
@@ -434,8 +436,8 @@ of the O command reported this field in knots.</para></listitem>
<varlistentry>
<term>estimated error in speed over ground</term>
<listitem><para>Error estimate for speed (%f, meters/sec, 95%
-confidence). Note: older versions of the O command reported this field in
-knots.</para></listitem>
+confidence). Note: older experimental versions of the O command
+reported this field in knots.</para></listitem>
</varlistentry>
<varlistentry>
@@ -444,6 +446,13 @@ knots.</para></listitem>
(%f, meters/sec, 95% confidence).</para></listitem>
</varlistentry>
+<varlistentry>
+<term>mode</term>
+<listitem><para>The NMEA mode (%d, ?=no mode value yet seen,
+1=no fix, 2=2D, 3=3D). (This field was not reported at protocol
+levels 2 and lower.)</para></listitem>
+</varlistentry>
+
</variablelist>
</listitem>
</varlistentry>
@@ -604,6 +613,12 @@ response. Additionally, watching clients get notifications in the
form X=0 or X=%f when the online/offline status of the GPS
changes.</para>
+<para>Clients should be prepared for the possibility that additional
+fields (such as heading or roll/pitch/yaw) may be added to the O
+command, and not treat the occurrence of extra fields as an error.
+The protocol number will be incremented if and when sych fields
+are added.</para>
+
<para>Sending SIGHUP to a running <application>gpsd</application>
forces it to close all GPSes and all client connections. It will then
attempt to reconnect to any GPSes on its device list and resume