Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 5.47 KB

README.md

File metadata and controls

84 lines (54 loc) · 5.47 KB
Raw

SparkFun RTK Everywhere Firmware

The line of RTK Everywhere products offered by SparkFun all run identical firmware. The RTK Everywhere firmware and this guide cover the following products:

SparkFun RTK Torch (GPS-25662) SparkFun RTK EVK (GPS-24342)
Hookup Guide Hookup Guide

The SparkFun RTK Torch is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical accuracy at up to 20Hz. It supports Galileo E6 HAS and has built-in tilt compensation too!

The SparkFun RTK EVK is the perfect development platform for your fixed or mobile high-precision positioning and navigation needs. We called it the EVK (Evaluation Kit) as it truly covers all the options: L1 + L2 RTK GNSS, with L-Band correction built-in. Regarding connectivity, the SparkFun RTK EVK has it all: WiFi / Bluetooth®, Ethernet and LTE cellular!

This repo houses the RTK Product Manual and the firmware that runs on the SparkFun RTK product line including:

For compiled binaries of the firmware, please see SparkFun RTK Everywhere Firmware Binaries.

Documentation

  • RTK Everywhere Product Manual - A detailed guide describing all the various software features of the RTK product line. Essentially it is a manual for the firmware in this repository.

Repository Contents

  • /Firmware - Source code for SparkFun RTK Everywhere Firmware as well as various feature unit tests
  • /Graphics - Original bitmap icons for the display
  • /docs - Markdown pages for the RTK Product Manual

Repository Branch Structure

This repository has two long-term branches: main and release_candidate.

With respect to the firmware, main is a branch where only changes that are appropriate for all users are applied. Thus, following main means updating to normal releases, and perhaps bugfixes to those releases.

In contrast, release_candidate is where new code is added as it is developed.

The documentation source code is in docs/ on main. It is built automatically on push and stored in the branch gh-pages, from which it is served at the above URL. Documentation changes are pushed directly to main.

Release Process

A release is made by merging release_candidate back to main, and then applying a tag to that commit on main.

A pre-release is often created using the latest stable release candidate. These binaries will have extra debug statements turned on that will not be present in a formal release, but should not affect behavior of the firmware.

Building from Source

For building the firmware, see the Firmware README. For compiled binaries of the firmware, please see SparkFun RTK Everywhere Firmware Binaries.

For the documentation, see mkdocs.yml and /workflows/mkdocs.yml.

For building the Uploader_GUI see SparkFun_RTK_Firmware_Uploader. The pyinstaller executables are generated by the /workflows

For building the u-blox_Update_GUI see u-blox_Update_GUI and the header comments of RTK_u-blox_Update_GUI.py

License Information

This product is open source! Please see License.md for more details.

Please feel free to contribute to both the firmware and documentation.

Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.

Distributed as-is; no warranty is given.

  • Your friends at SparkFun.