Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@nseidle
nseidle committed Apr 5, 2024
1 parent fc295fb commit 237862e
Show file tree
Hide file tree
Showing 9 changed files with 53 additions and 95 deletions.
4 changes: 2 additions & 2 deletions Firmware/readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Firmware

This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-u-blox-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#updating-u-blox-firmware) for more information about the firmware that runs the ZED-F9x Receiver.

* **RTK_Surveyor** - The main firmware for the RTK Surveyor
* **Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.

## Compilation Instructions

See [Compiling Source](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#compiling-source) for detailed steps.
See [Compiling Source](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#compiling-source) for detailed steps.
76 changes: 17 additions & 59 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,81 +1,39 @@
SparkFun RTK Firmware
SparkFun RTK Everywhere Firmware
===========================================================

The line of RTK Everywhere products offered by SparkFun all run identical firmware. The [RTK Everywhere firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) and this guide cover the following products:

<table class="table table-hover table-striped table-bordered">
<tr align="center">
<td><a href="https://www.sparkfun.com/products/20000"><img src="https://cdn.sparkfun.com//assets/parts/1/9/7/4/6/20000-SparkFun_RTK_Facet_L-Band-01.jpg"></a></td>
<td><a href="https://www.sparkfun.com/products/19029"><img src="https://cdn.sparkfun.com//assets/parts/1/8/6/3/0/RTK_Facet_Photos-01.jpg"></a></td>
<td><a href="https://www.sparkfun.com/products/22429"><img src="https://cdn.sparkfun.com//assets/parts/2/2/5/2/3/SparkFun-Reference-Station--05.jpg"></a></td>
</tr>
<td><a href="https://www.sparkfun.com/products/24672"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
</tr>
<tr align="center">
<td><a href="https://www.sparkfun.com/products/20000">SparkFun RTK Facet L-Band (GPS-20000)</a></td>
<td><a href="https://www.sparkfun.com/products/19029">SparkFun RTK Facet (GPS-19029)</a></td>
<td><a href="https://www.sparkfun.com/products/22429">SparkFun RTK Reference Station (GPS-22429)</a></td>
<td><a href="https://www.sparkfun.com/products/24672">SparkFun RTK Torch (GPS-24672)</a></td>
</tr>
<tr align="center">
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide">Hookup Guide</a></td>
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide">Hookup Guide</a></td>
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-reference-station-hookup-guide">Hookup Guide</a></td>
</tr>
<tr align="center">
<td><a href="https://www.sparkfun.com/products/18590"><img src="https://cdn.sparkfun.com//assets/parts/1/8/0/7/5/18590-SparkFun_RTK_Express_Plus-04.jpg"></a></td>
<td><a href="https://www.sparkfun.com/products/18442"><img src="https://cdn.sparkfun.com//assets/parts/1/7/2/4/1/18019-SparkFun_RTK_Express-09.jpg"></a></td>
<td><a href="https://www.sparkfun.com/products/18443"><img src="https://cdn.sparkfun.com//assets/parts/1/6/4/0/1/17369-SparkFun_RTK_Surveyor-14.jpg"></a></td>
</tr>
<tr align="center">
<td><a href="https://www.sparkfun.com/products/18590">SparkFun RTK Express Plus (GPS-18590)</a></td>
<td><a href="https://www.sparkfun.com/products/18442">SparkFun RTK Express (GPS-18442)</a></td>
<td><a href="https://www.sparkfun.com/products/18443">SparkFun RTK Surveyor (GPS-18443)</a></td>
</tr>
<tr align="center">
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide">Hookup Guide</a></td>
<td><a href="https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide">Hookup Guide</a></td>
</tr>
</table>

The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) and [SparkFun RTK Reference Station](https://www.sparkfun.com/products/22429) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Firmware/accuracy_verification/) at up to 20Hz!

This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware) and the firmware that runs on the SparkFun RTK product line including:

* [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000)
* [SparkFun RTK Facet](https://www.sparkfun.com/products/19029)
* [SparkFun RTK Reference Station](https://www.sparkfun.com/products/22429)
* [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590)
* [SparkFun RTK Express](https://www.sparkfun.com/products/18442)
* [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443)

For compiled binaries of the firmware, please see [SparkFun RTK Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries).

If you're interested in the PCB, enclosure, or overlay on each product please see the hardware repos:
The [SparkFun RTK Torch](https://www.sparkfun.com/products/24672) is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/accuracy_verification/) at up to 20Hz!

* [SparkFun RTK Facet L-Band Hardware](https://github.com/sparkfun/SparkFun_RTK_Facet)
* [SparkFun RTK Facet Hardware](https://github.com/sparkfun/SparkFun_RTK_Facet)
* [SparkFun RTK Reference Station Hardware](https://github.com/sparkfun/SparkFun_RTK_Reference_Station)
* [SparkFun RTK Express Plus Hardware](https://github.com/sparkfun/SparkFun_RTK_Express_Plus)
* [SparkFun RTK Express Hardware](https://github.com/sparkfun/SparkFun_RTK_Express)
* [SparkFun RTK Surveyor Hardware](https://github.com/sparkfun/SparkFun_RTK_Surveyor)
This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware) and the firmware that runs on the SparkFun RTK product line including:

Thanks:
* [SparkFun RTK Torch](https://www.sparkfun.com/products/24672)

* Special thanks to [Avinab Malla](https://github.com/avinabmalla) for the creation of [SW Maps](https://play.google.com/store/apps/details?id=np.com.softwel.swmaps&hl=en_US&gl=US) and for pointers on handling the ESP32 read/write tasks.
For compiled binaries of the firmware, please see [SparkFun RTK Everywhere Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries).

Documentation
--------------

* **[RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/)** - A detail guide describing all the various software features of the RTK product line. Essentially it is a manual for the firmware in this repository.
* **[RTK Facet L-Band Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide)** - Hookup guide for the SparkFun RTK Facet L-Band.
* **[RTK Facet Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide)** - Hookup guide for the SparkFun RTK Facet.
* **[RTK Reference Station Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-reference-station-hookup-guide)** - Hookup guide for the SparkFun RTK Reference Station.
* **[RTK Express Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide)** - Hookup guide for the SparkFun RTK Express and Express Plus.
* **[RTK Surveyor Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide)** - Hookup guide for the SparkFun RTK Surveyor.
* **[RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/)** - A detail 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 firmware as well as various feature unit tests
* **/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](https://docs.sparkfun.com/SparkFun_RTK_Firmware/)
* **/docs** - Markdown pages for the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/)

Repository Branch Structure
---------------------------
Expand All @@ -98,18 +56,18 @@ A pre-release is often created using the latest stable release candidate. These
Building from Source
--------------------

For building the firmware, see the [Firmware README](Firmware/readme.md). For compiled binaries of the firmware, please see [SparkFun RTK Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries).
For building the firmware, see the [Firmware README](Firmware/readme.md). For compiled binaries of the firmware, please see [SparkFun RTK Everywhere Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries).

For the documentation, see [mkdocs.yml](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/mkdocs.yml) and [/workflows/mkdocs.yml](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/mkdocs.yml).
For the documentation, see [mkdocs.yml](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/mkdocs.yml) and [/workflows/mkdocs.yml](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/.github/workflows/mkdocs.yml).

For building the Uploader_GUI see [SparkFun_RTK_Firmware_Uploader](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader). The pyinstaller executables are generated by the [/workflows](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader/tree/main/.github/workflows)

For building the u-blox_Update_GUI see [u-blox_Update_GUI](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/u-blox_Update_GUI) and the header comments of [RTK_u-blox_Update_GUI.py](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/u-blox_Update_GUI/RTK_u-blox_Update_GUI.py)
For building the u-blox_Update_GUI see [u-blox_Update_GUI](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/u-blox_Update_GUI) and the header comments of [RTK_u-blox_Update_GUI.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/u-blox_Update_GUI/RTK_u-blox_Update_GUI.py)

License Information
-------------------

This product is _**open source**_! Please feel free to [contribute](https://docs.sparkfun.com/SparkFun_RTK_Firmware/contribute/) to both the firmware and documentation.
This product is _**open source**_! Please feel free to [contribute](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/contribute/) to both the firmware and documentation.

Various bits of the code have different licenses applied. Anything SparkFun wrote is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round!

Expand Down
4 changes: 2 additions & 2 deletions docs/contribute.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ All of this documentation can be modified by you! Please help us make it better.

*The edit button at the top of every page*

Does something not make sense? Find a typo? Hit the edit button and make it better. If a section is confusing please [open an issue](https://github.com/sparkfun/SparkFun_RTK_Firmware/issues) and let us know.
Does something not make sense? Find a typo? Hit the edit button and make it better. If a section is confusing please [open an issue](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues) and let us know.

These pages are contained in the [docs folder](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/docs) of the [SparkFun RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) repository. Fork this repo, make changes to the markdown, then create a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
These pages are contained in the [docs folder](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/tree/main/docs) of the [SparkFun RTK Everywhere Firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) repository. Fork this repo, make changes to the markdown, then create a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
Loading

0 comments on commit 237862e

Please sign in to comment.