Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.adoc 5.2 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. gpsd README file
  2. ----------------
  3. WARNING
  4. ~~~~~~~
  5. The files at https://gitlab.com/gpsd/gpsd/-/tags are NOT the gpsd
  6. release files. DO NOT use them. The release files are at:
  7. http://download-mirror.savannah.gnu.org/releases/gpsd/
  8. GENERAL
  9. ~~~~~~~
  10. gpsd is a userland daemon acting as a translator between GPS and
  11. AIS receivers and their 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. The website for GPSD where you can find updates, news, and
  20. project mailing lists is: https://gpsd.io/
  21. See that website for a list of GPS units known to be compatible.
  22. See the file INSTALL.adoc for installation instructions and some tips on
  23. how to troubleshoot your installation. The file build.adoc has
  24. instructions for building from source. The packaging/ directory
  25. contains resources and suggestions for packagers and distribution
  26. integrators.
  27. LICENSE
  28. ~~~~~~~
  29. This software (gpsd) is released under the terms and conditions of the BSD
  30. License, a copy of which is included in the file COPYING.
  31. 1.X CREDITS
  32. ~~~~~~~~~~~
  33. Remco Treffkorn designed and originated the code.
  34. Russ Nelson maintained gpsd for a couple of years.
  35. Carsten Tschach's gpstrans-0.31b code was the original model for nmea_parse.c.
  36. Bob Lorenzini <hwm@netcom.com> provided testing and feedback.
  37. Brook Milligan <brook@trillium.NMSU.Edu> combined gpsd and gpsclient
  38. into one package and autoconfiscated it.
  39. Derrick J. Brashear <shadow@dementia.org> (KB3EGH) added code for the
  40. EarthMate DeLorme. He also added "incredibly gross code to output
  41. NMEA sentences" (his own words :-) He also did the first cut at
  42. DGPS support (see http://www.wsrcc.com/wolfgang/gps/dgps-ip.html),
  43. for the Earthmate.
  44. Curt Mills <BowHunter@mail.com> (WE7U) furthered the dgps support,
  45. writing the portion for other GPS receivers.
  46. None of these people have been active in 2.X and later versions; gpsd
  47. has evolved out of recognition from the 1.X codebase.
  48. 2.X CREDITS
  49. ~~~~~~~~~~~
  50. Eric S. Raymond drastically rewrote this code in late 2004/early 2005
  51. to clean it up and extend it. The 2.X architecture has become
  52. significantly different and far more modularized. His new features
  53. included:
  54. * Documentation (what a concept!)
  55. * Cleaned up, simplified command-line options.
  56. * Now understands the GLL (Geographic position - Latitude, Longitude)
  57. sentence from NMEA 3.0.
  58. * Now parses both the NMEA 3.01 and pre-3.01 variants of the VTG sentence
  59. correctly.
  60. * New commands including 'y', 'w', and 'x', since obsolesced by a
  61. JSON-based protocol.
  62. * Massive refactoring -- one main loop now calls a self-contained
  63. driver object for each type.
  64. * The GPS-bashing code the daemon uses can now be directly linked as a
  65. library, libgpsd(3).
  66. * C and Python libraries are available to encapsulate the client side of
  67. querying gpsd, see libgps(3).
  68. * Cleaned-up error reporting, we don't use syslog when running in the foreground
  69. but send all error and status messages to the tty instead.
  70. * Added -n option to do batch monitoring of GPSes.
  71. * xgpsspeed is working again; xgps has been seriously reworked and improved.
  72. * RPMs which include installation of gpsd to start up at boot time
  73. are available.
  74. * New gpsprobe program probes the capabilities of GPSes and generates
  75. error scattergrams from fixes. (Later this moved to gpsprof.)
  76. * Autobauding, self-configuration, and hotplugging. gpsd can now get
  77. its device from a hotplug script, and figures out itself which baud
  78. rate to use and what the GPS's device type is.
  79. * Support for SiRF binary mode.
  80. * Support for RTCM104 and AIVDM.
  81. * Support for multiple devices.
  82. * Other test tools -- gpsfake, gpscat, gpsmon.
  83. Chris Kuethe <ckuethe@mainframe.cx> maintains the OpenBSD port, shipped
  84. the 2.34 release, is our SiRF and low-level protocols expert, and does a
  85. lot of general hacking and support. He has release authority.
  86. Gary Miller <gem@rellim.com> wrote the driver for Garmin binary protocol
  87. and most of the support for PPS handling on serial devices. He has release
  88. authority.
  89. Amaury Jacquot <sxpert@esitcom.org> added DBUS support.
  90. Ville Nuorvala <vnuorval@tcs.hut.fi> wrote the NTRIP support.
  91. We are delighted to acknowledge the assistance of Carl Carter, a field
  92. application engineer at SiRF. He assisted us with the correction and
  93. tuning of the SiRF binary-protocol driver, shedding a good deal of
  94. light on murky aspects of the chip's behavior.
  95. We are also delighted to acknowledge the assistance of Timo Ylhainen, VP of
  96. Software Operations at Fastrax. He clarified some points about
  97. the iTalk protocol, helping to further development of iTalk support.
  98. 3.X CREDITS
  99. ~~~~~~~~~~~
  100. The main feature of the 3.x versions is a stabilized and finalized
  101. version of the JSON command/response protocol. This was designed and mainly
  102. implemented by ESR. Gary Miller wrote the subframe support.