"Initial commit to Gerrit"
[profile/ivi/gpsd.git] / README
1 COPYRIGHT
2 =========
3
4 This software (gpsd) released under the terms and conditions of the BSD
5 License, a copy of which is included in the file COPYING.
6
7 GENERAL
8 =======
9
10 gpsd is a userland daemon acting as a translator between GPS or
11 Loran-C receivers and clients. gpsd listens on port 2947 for clients
12 requesting position/time/velocity information.  The receivers are
13 expected to generate position information in a well-known format -- as
14 NMEA-0183 sentences, SiRF binary, Rockwell binary, Garmin binary
15 format, or other vendor binary protocols.  gpsd takes this
16 information from the GPS and translates it into something uniform and
17 easier to understand for clients.  The distribution includes sample
18 clients, application interface libraries, and test/profiling tools.
19
20 There is a project site for gpsd at <http://gpsd.berlios.de/>.
21 Look there for updates, news, and project mailing lists.  See that
22 website for a list of GPS units known to be compatible.
23
24 See the file INSTALL for installation instructions and some tips on
25 how to troubleshoot your installation.
26
27 Distro integrators: An RPM spec file is included in the gpsd
28 distribution.  It wants to set up a hotplug script to notify gpsd
29 when a potential GPS device goes active and should be polled.  The
30 goal is zero configuration; users should never have to tell gpsd how
31 to configure itself.  If you can't use RPM, use what you see in the
32 specfile as a model.
33
34 1.X CREDITS
35 ===========
36
37 Remco Treffkorn designed and originated the code.
38
39 Russ Nelson maintained gpsd for a couple of years.
40
41 Carsten Tschach's gpstrans-0.31b code was the original model for nmea_parse.c.
42
43 Bob Lorenzini <hwm@netcom.com> provided testing and feedback.
44
45 Brook Milligan <brook@trillium.NMSU.Edu> combined gpsd and gpsclient
46 into one package and autoconfiscated it.
47
48 Derrick J. Brashear <shadow@dementia.org> (KB3EGH) added code for the
49 EarthMate DeLorme. He also added "incredibly gross code to output
50 NMEA sentences" (his own words :-) He also did the first cut at
51 DGPS support (see http://www.wsrcc.com/wolfgang/gps/dgps-ip.html), 
52 for the Earthmate.
53
54 Curt Mills <BowHunter@mail.com> (WE7U) furthered the dgps support,
55 writing the portion for other GPS receivers.
56
57 None of these people are active in 2.X, through Remco de-lurks on the
58 mailing list occasionally.
59
60 2.X CREDITS
61 ===========
62
63 Eric S. Raymond drastically rewrote this code to clean it up and extend it.
64 The 2.X architecture has become significantly different and far more 
65 modularized. His new features include:
66    * Documentation (what a concept!)
67    * Cleaned up, simplified command-line options.
68    * Now understands the GLL (Geographic position - Latitude, Longitude)
69      sentence from NMEA 3.0. 
70    * Now parses both the NMEA 3.01 and pre-3.01 variants of the VTG sentence 
71      correctly.
72    * New 'y' command supports satellite location -- it should no longer ever
73      be necessary for clients to go to raw mode unless they want to monitor and
74      and log the NMEA stream itself.
75    * New 'w' command toggles 'watcher' mode. In watcher mode gpsd ships
76      a gpsd-style response for each incoming sentence as if the client
77      had just sent all commands that asked for data contained in the sentence.
78    * New 'x' command allows the client to query whether or not the GPS
79      is on-line.
80    * Massive refactoring -- one main loop now calls a self-contained
81      driver object for each type.
82    * The GPS-bashing code the daemon uses can now be directly linked as a
83      library, libgpsd(3). 
84    * C and Python libraries are available to encapsulate the client side of
85      querying gpsd, see libgps(3).
86    * Cleaned-up error reporting, we don't use syslog when running in foreground
87      but send all error and status messages to the tty instead.
88    * Added -n option to do batch monitoring of GPSes.
89    * xgpsspeed is working again; xgps has been seriously reworked and improved.
90    * RPMs which include installation of gpsd to start up at boot time 
91      are available.
92    * New gpsprobe program probes the capabilities of GPSes and generates
93      error scattergrams from fixes.  (Later this moved to gpsprof.)
94    * Autobauding, self-configuration, and hotplugging.  gpsd can now get
95      its device from a hotplug script, and figures out itself which baud 
96      rate to use and what the GPS's device type is.
97    * More new commands: 'I', 'U', 'E', 'B', 'Z'. See the docs.
98    * Support for SiRF binary mode.
99    * Support for RTCM104 and AIVDM.
100    * Support for multiple devices.
101    * Other test tools -- gpsfake, gpscat.
102
103 Chris Kuethe <ckuethe@mail.berlios.de> maintains the OpenBSD port, shipped
104 the 2.34 release, is our SiRF and low-level protocols expert, and does a 
105 lot of general hacking and support.
106
107 Gary Miller <gem@rellim.com> wrote the driver for Garmin binary protocol.
108
109 Amaury Jacquot <sxpert@esitcom.org> added DBUS support.
110
111 Ville Nuorvala <vnuorval@tcs.hut.fi> wrote the NTRIP support.
112
113 We are delighted to acknowlege the assistance of Carl Carter, a field
114 application engineer at SiRF.  He assisted us with the correction and
115 tuning of the SiRF binary-protocol driver, shedding a good deal of 
116 light on murky aspects of the chip's behavior.
117
118 We are also delighted to acknowlege the assistance of Timo Ylhainen, VP of
119 Software Operations at Fastrax. He clarified a number of points about
120 the iTalk protocol, helping to further development of iTalk support.