/CSE_GNSS

Arduino library for reading and writing GPS/GNSS receivers with NMEA output.

Primary LanguageC++MIT LicenseMIT

CSE_GNSS

CSE_GNSS

CSE_GNSS is a generic Arduino library from CIRCUITSTATE Electronics to read and write any GPS/GNSS module that supports NMEA output over UART. You can define the NMEA sentence in any custom formats and extract the data coming from the GNSS module.

This library is in pre-release stage. Any feedback is highly appreciated.

Installation

This library is available from the official Arduino Library Manager. Open the Arduino IDE, search for CSE_GNSS and install the latest version of the library.

Additionally, you can download the latest release package from the GitHub repository and install it manually. To do so, open the Arduino IDE, go to Sketch > Include Library > Add .ZIP Library…​ and select the downloaded file.

Another method is to clone the GitHub repository directly into your libraries folder. The development branch will have the latest features, bug fixes and other changes. To do so, navigate to your libraries folder (usually located at Documents/Arduino/libraries on Windows and ~/Documents/Arduino/libraries on macOS) and execute the following command:

git clone https://github.com/CIRCUITSTATE/CSE_GNSS.git

The library can also be installed via PlatformIO. All officially listed Arduino listed libraries are automatically fetched by PlatformIO. Use the lib_deps search option to install the library.

Examples

Two example sketches are included with this library which you can find inside the examples folder.

  • Print_GPRMC - Directly reads the NMEA output from the GNSS module and prints it on the serial monitor.
  • View_GNSS_Data - Reads the NMEA output from the GNSS module, extract the data and prints it on the serial monitor in key-value format.

Tutorial

A complete tutorial on GPS/GNSS is available on the CIRCUITSTATE website. This tutorial uses the u-blox NEO-6M GY-NEO6MV2 GPS module wired with a FireBeetle-ESP32E board.

API Documentation

The API documentation is available at API.md.

References

  1. What is GPS/GNSS & How to Interface u-blox NEO-6M GPS Module with Arduino - CIRCUITSTATE Electronics