LwGPS latest-develop documentation

Welcome to the documentation for version latest-develop.

LwGPS is lightweight, platform independent library to parse NMEA statements from GPS receivers. It is highly optimized for embedded systems.

_images/logo.svg

Download library Getting started Open Github Donate

Features

  • Written in C (C11)

  • Platform independent, easy to use

  • Built-in support for 4 GPS statements

    • GPGGA or GNGGA: GPS fix data

    • GPGSA or GNGSA: GPS active satellites and dillusion of position

    • GPGSV or GNGSV: List of satellites in view zone

    • GPRMC or GNRMC: Recommended minimum specific GPS/Transit data

  • Optional float or double floating point units

  • Low-level layer is separated from application layer, thus allows you to add custom communication with GPS device

  • Works with operating systems

  • Works with different communication interfaces

  • User friendly MIT license

Requirements

  • C compiler

  • Driver for receiving data from GPS receiver

  • Few kB of non-volatile memory

Contribute

Fresh contributions are always welcome. Simple instructions to proceed:

  1. Fork Github repository

  2. Respect C style & coding rules used by the library

  3. Create a pull request to develop branch with new features or bug fixes

Alternatively you may:

  1. Report a bug

  2. Ask for a feature request

License

MIT License

Copyright (c) 2024 Tilen MAJERLE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.