diff --git a/Firmware/readme.md b/Firmware/readme.md index 61ecd2bb5..b7d2e6878 100644 --- a/Firmware/readme.md +++ b/Firmware/readme.md @@ -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. diff --git a/README.md b/README.md index 4c055ed27..5474ab20e 100644 --- a/README.md +++ b/README.md @@ -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: + - - - - + + - - - + - - - - - - - - - - - - - - - - -
SparkFun RTK Facet L-Band (GPS-20000)SparkFun RTK Facet (GPS-19029)SparkFun RTK Reference Station (GPS-22429)SparkFun RTK Torch (GPS-24672)
Hookup GuideHookup GuideHookup Guide
SparkFun RTK Express Plus (GPS-18590)SparkFun RTK Express (GPS-18442)SparkFun RTK Surveyor (GPS-18443)
Hookup GuideHookup GuideHookup Guide
-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 --------------------------- @@ -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! diff --git a/docs/contribute.md b/docs/contribute.md index c7c68b37e..ca82e25f1 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/firmware_update.md b/docs/firmware_update.md index 0f8175bfd..3b2cebeaf 100644 --- a/docs/firmware_update.md +++ b/docs/firmware_update.md @@ -41,7 +41,7 @@ From time to time SparkFun will release new firmware for the RTK product line to The OTA method is generally recommended. For more information see [here](firmware_update.md#updating-firmware-over-the-air). -Remember, all SparkFun RTK devices are open source hardware meaning you have total access to the [firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) and [hardware](https://github.com/sparkfun/SparkFun_RTK_Facet). Be sure to check out each repo for the latest firmware and hardware information. +Remember, all SparkFun RTK devices are open source hardware meaning you have total access to the [firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) and [hardware](https://github.com/sparkfun/SparkFun_RTK_Facet). Be sure to check out each repo for the latest firmware and hardware information. ## Updating Firmware Over-The-Air ![Updating Firmware from WiFi config page]() @@ -74,7 +74,7 @@ This GUI makes it easy to point and click your way through a firmware update. Th The latest GUI release can be downloaded [here](https://github.com/sparkfun/SparkFun_RTK_Firmware_Uploader/releases). -Download the latest RTK firmware binary file located on the [releases page](https://github.com/sparkfun/SparkFun_RTK_Firmware/releases) or from the [binaries repo](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries). +Download the latest RTK firmware binary file located on the [releases page](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/releases) or from the [binaries repo](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries). **To Use** @@ -86,7 +86,7 @@ Download the latest RTK firmware binary file located on the [releases page](http *Device Manager showing 'USB-Serial CH340' port on COM27* -* Get the latest binary file located on the [releases page](https://github.com/sparkfun/SparkFun_RTK_Firmware/releases) or from the [binaries repo](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries). +* Get the latest binary file located on the [releases page](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/releases) or from the [binaries repo](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries). * Run *RTKUploader.exe* (it takes a few seconds to start) * Click *Browse* and select the binary file to upload * Select the COM port previously seen in the Device Manager @@ -102,11 +102,11 @@ If your RTK 'freezes' after the update, press ```Reset ESP32``` to get it going *Firmware update taking place* -Download the latest binary file located on the [releases page](https://github.com/sparkfun/SparkFun_RTK_Firmware/releases) or from the [binaries repo](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries). +Download the latest binary file located on the [releases page](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/releases) or from the [binaries repo](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries). The firmware upgrade menu will only display files that have the "RTK_Surveyor_Firmware*.bin" file name format so don't change the file names once loaded onto the SD card. Select the firmware you'd like to load and the system will proceed to load the new firmware, then reboot. -**Note:** The firmware is called `RTK_Surveyor_Firmware_vXX.bin` even though there are various RTK products (Facet, Express, Surveyor, etc). We united the different platforms into one. The [RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) runs on all our RTK products. +**Note:** The firmware is called `RTK_Surveyor_Firmware_vXX.bin` even though there are various RTK products (Facet, Express, Surveyor, etc). We united the different platforms into one. The [RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) runs on all our RTK products. ### Force Firmware Loading @@ -122,7 +122,7 @@ Firmware may be uploaded to the unit by clicking on 'Upload BIN', selecting the ## Updating Firmware From CLI -The command-line interface is also available. You’ll need to download the [RTK Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries) repo. This repo contains the binaries but also various supporting tools including esptool.exe and the three binaries required along with the firmware (bootloader, partitions, and app0). +The command-line interface is also available. You’ll need to download the [RTK Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries) repo. This repo contains the binaries but also various supporting tools including esptool.exe and the three binaries required along with the firmware (bootloader, partitions, and app0). ### Windows @@ -174,7 +174,7 @@ RTK Surveyors sold before September 2021 may have an ESP32 WROOM module with 4MB The GUI (as of v1.3) will autodetect the ESP32's flash size and load the appropriate partition file. No user interaction is required. -If you are using the CLI method, be sure to point to the [4MB partition file](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/blob/main/bin/RTK_Surveyor_Partitions_4MB.bin?raw=true). For example: +If you are using the CLI method, be sure to point to the [4MB partition file](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/blob/main/bin/RTK_Surveyor_Partitions_4MB.bin?raw=true). For example: ``` esptool.exe --chip esp32 --port COM6 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size detect 0x1000 ./bin/RTK_Surveyor.ino.bootloader.bin 0x8000 ./bin/**RTK_Surveyor_Partitions_4MB**.bin 0xe000 ./bin/boot_app0.bin 0x10000 ./RTK_Surveyor_Firmware_vxx.bin @@ -211,19 +211,19 @@ The firmware on u-blox devices can be updated using a [Windows-based GUI](firmwa *SparkFun RTK u-blox Firmware Update Tool* -The [SparkFun RTK u-blox Firmware Update Tool](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/u-blox_Update_GUI) is a simple Windows GUI and python script that runs the ubxfwupdate.exe tool. This allows users to directly update module firmware without the need for u-center. Additionally, this tool queries the module to verify that the firmware type matches the module. Because the RTK Facet L-Band contains two u-blox modules that both appear as identical serial ports, it can be difficult and perilous to know which port to load firmware. This tool prevents ZED-F9P firmware from being accidentally loaded onto a NEO-D9S receiver and vice versa. +The [SparkFun RTK u-blox Firmware Update Tool](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/u-blox_Update_GUI) is a simple Windows GUI and python script that runs the ubxfwupdate.exe tool. This allows users to directly update module firmware without the need for u-center. Additionally, this tool queries the module to verify that the firmware type matches the module. Because the RTK Facet L-Band contains two u-blox modules that both appear as identical serial ports, it can be difficult and perilous to know which port to load firmware. This tool prevents ZED-F9P firmware from being accidentally loaded onto a NEO-D9S receiver and vice versa. -The SparkFun RTK u-blox Firmware Update Tool will only run on Windows as it relies upon u-blox's `ubxfwupdate.exe`. The full, integrated executable for Windows is available [here](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/raw/main/u-blox_Update_GUI/Windows_exe/RTK_u-blox_Update_GUI.exe). +The SparkFun RTK u-blox Firmware Update Tool will only run on Windows as it relies upon u-blox's `ubxfwupdate.exe`. The full, integrated executable for Windows is available [here](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/raw/main/u-blox_Update_GUI/Windows_exe/RTK_u-blox_Update_GUI.exe). * Attach the RTK device's USB port to your computer using a USB cable * Turn the RTK device on * Open Device Manager to confirm which COM port the device is operating on -![Device Manager showing USB Serial port on COM14](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/raw/main/u-blox_Update_GUI/SparkFun_RTK_u-blox_Updater_COM_Port.jpg) +![Device Manager showing USB Serial port on COM14](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/raw/main/u-blox_Update_GUI/SparkFun_RTK_u-blox_Updater_COM_Port.jpg) *Device Manager showing USB Serial port on COM14* -* Get the latest binary firmware file from the [ZED Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/ZED%20Firmware), [NEO Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/NEO%20Firmware) folder, or the [u-blox](https://www.u-blox.com/) website +* Get the latest binary firmware file from the [ZED Firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/ZED%20Firmware), [NEO Firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/NEO%20Firmware) folder, or the [u-blox](https://www.u-blox.com/) website * Run *RTK_u-blox_Update_GUI.exe* (it takes a few seconds to start) * Click the Firmware File *Browse* and select the binary file for the update * Select the COM port previously seen in the Device Manager @@ -239,7 +239,7 @@ If you're familiar with u-center a tutorial with step-by-step instructions for l This module is used in the Surveyor, Express, and Facet. It is capable of both Rover *and* base modes. -Most of these binaries can be found in the [ZED Firmware/ZED-F9P](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/ZED%20Firmware/ZED-F9P) folder. +Most of these binaries can be found in the [ZED Firmware/ZED-F9P](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/ZED%20Firmware/ZED-F9P) folder. All field testing and device-specific performance parameters were obtained with ZED-F9P v1.30. @@ -255,7 +255,7 @@ All field testing and device-specific performance parameters were obtained with This module is used in the Express Plus. It contains an internal IMU and additional algorithms to support high-precision location fixes using dead reckoning. The ZED-F9R is not capable of operating in base mode. -Most of these binaries can be found in the [ZED Firmware/ZED-F9R](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/ZED%20Firmware/ZED-F9R) folder. +Most of these binaries can be found in the [ZED Firmware/ZED-F9R](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/ZED%20Firmware/ZED-F9R) folder. * v1.00 Initial release. @@ -265,7 +265,7 @@ Most of these binaries can be found in the [ZED Firmware/ZED-F9R](https://github This module is used in the Facet L-Band to receive encrypted PMP messages over ~1.55GHz broadcast via a geosynchronous Inmarsat. -This binary file can be found in the [NEO Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/NEO%20Firmware) folder. +This binary file can be found in the [NEO Firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries/tree/main/NEO%20Firmware) folder. * v1.04 Initial release. @@ -275,7 +275,7 @@ As of writing, no additional releases of the NEO-D9S firmware have been made. ### Windows -The SparkFun RTK firmware is compiled using Arduino (currently v1.8.15). To compile: +The SparkFun RTK Everywhere Firmware is compiled using Arduino (currently v1.8.15). To compile: 1. Install [Arduino](https://www.arduino.cc/en/software). @@ -285,7 +285,7 @@ The SparkFun RTK firmware is compiled using Arduino (currently v1.8.15). To comp ```C:\Users\\[user name]\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.2\tools\partitions\app3M_fat9M_16MB.csv``` - with the app3M_fat9M_16MB.csv [file](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/Firmware/app3M_fat9M_16MB.csv?raw=true) found in the [Firmware folder](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Firmware). This will increase the program partition from a maximum of 1.9MB to 3MB. + with the app3M_fat9M_16MB.csv [file](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/app3M_fat9M_16MB.csv?raw=true) found in the [Firmware folder](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/tree/main/Firmware). This will increase the program partition from a maximum of 1.9MB to 3MB. 4. From the Arduino IDE, set the core settings from the **Tools** menu: @@ -315,7 +315,7 @@ Using the library manager in the Arduino IDE, for each of the libraries below: 2. Click on the library - 3. Select the version listed in the compile-rtk-firmware.yml file for the [main](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/compile-rtk-firmware.yml) or the [release_candidate](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/.github/workflows/compile-rtk-firmware.yml) branch + 3. Select the version listed in the compile-rtk-firmware.yml file for the [main](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/.github/workflows/compile-rtk-firmware.yml) or the [release_candidate](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/release_candidate/.github/workflows/compile-rtk-firmware.yml) branch 4. Click on the Install button in the lower right @@ -412,7 +412,7 @@ Execute the following commands to create the Linux virtual machine: #### Build Environment -Execute the following commands to create the build environment for the SparkFun RTK Firmware: +Execute the following commands to create the build environment for the SparkFun RTK Everywhere Firmware: 1. sudo adduser $USER dialout 2. sudo shutdown -r 0 @@ -489,17 +489,17 @@ Execute the following commands to create the build environment for the SparkFun 16. chmod +x new-firmware-4mb.sh - Get the SparkFun RTK Firmware sources + Get the SparkFun RTK Everywhere Firmware sources 17. mkdir ~/SparkFun/RTK 18. cd ~/SparkFun/RTK -19. git clone https://github.com/sparkfun/SparkFun_RTK_Firmware . +19. git clone https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware . Get the SparkFun RTK binaries 20. mkdir ~/SparkFun/RTK_Binaries 21. cd ~/SparkFun/RTK_Binaries -22. git clone https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries.git . +22. git clone https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries.git . Install the Arduino IDE @@ -570,7 +570,7 @@ Execute the following commands to create the build environment for the SparkFun 1. Locate the library 2. Click on the library - 3. Select the version listed in the compile-rtk-firmware.yml file for the [main](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/compile-rtk-firmware.yml) or the [release_candidate](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/.github/workflows/compile-rtk-firmware.yml) branch + 3. Select the version listed in the compile-rtk-firmware.yml file for the [main](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/.github/workflows/compile-rtk-firmware.yml) or the [release_candidate](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/release_candidate/.github/workflows/compile-rtk-firmware.yml) branch 4. Click on the Install button in the lower right Library List: @@ -616,4 +616,4 @@ Execute the following commands to create the build environment for the SparkFun ### Arduino CLI -The firmware can be compiled using [Arduino CLI](https://github.com/arduino/arduino-cli). This makes compilation fairly platform independent and flexible. All release candidates and firmware releases are compiled using Arduino CLI using a github action. You can see the source of the action [here](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/.github/workflows/compile-release.yml), and use it as a starting point for Arduino CLI compilation. +The firmware can be compiled using [Arduino CLI](https://github.com/arduino/arduino-cli). This makes compilation fairly platform independent and flexible. All release candidates and firmware releases are compiled using Arduino CLI using a github action. You can see the source of the action [here](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/.github/workflows/compile-release.yml), and use it as a starting point for Arduino CLI compilation. diff --git a/docs/gis_software.md b/docs/gis_software.md index 954e7e0d8..d3afb4c08 100644 --- a/docs/gis_software.md +++ b/docs/gis_software.md @@ -500,7 +500,7 @@ If you return to the iOS Bluetooth Settings, you will see that your iOS and RTK ## Other GIS Packages -Hopefully, these examples give you an idea of how to connect the RTK product line to most any GIS software. If there is other GIS software that you'd like to see configuration information about, please open an issue on the [RTK Firmware repo](https://github.com/sparkfun/SparkFun_RTK_Firmware/issues) and we'll add it. +Hopefully, these examples give you an idea of how to connect the RTK product line to most any GIS software. If there is other GIS software that you'd like to see configuration information about, please open an issue on the [RTK Firmware repo](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues) and we'll add it. ## What's an NTRIP Caster? diff --git a/docs/menu_ethernet.md b/docs/menu_ethernet.md index dfa9ec2be..c9bcc2f5c 100644 --- a/docs/menu_ethernet.md +++ b/docs/menu_ethernet.md @@ -39,4 +39,4 @@ E.g. to connect to a local machine via its IP Address, select option "c" and the ![Ethernet TCP Client connection](img/Terminal/TCP_Client.gif) -The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/main/Firmware/Tools/TCP_Server.py). \ No newline at end of file +The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/Tools/TCP_Server.py). \ No newline at end of file diff --git a/docs/menu_firmware.md b/docs/menu_firmware.md index 32ecf5681..0269e16e6 100644 --- a/docs/menu_firmware.md +++ b/docs/menu_firmware.md @@ -6,7 +6,7 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png) *Firmware Update menu* -From time to time SparkFun will release new firmware for the RTK product line to add and improve functionality. For most users, firmware can be upgraded over WiFi using the [OTA method](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-over-the-air). +From time to time SparkFun will release new firmware for the RTK product line to add and improve functionality. For most users, firmware can be upgraded over WiFi using the [OTA method](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#updating-firmware-over-the-air). The Firmware Update menu allows users to check for and install updates. Turning on *Automatic firmware updates* will cause the device to periodically check and install updates when they become available. This can be helpful for remote stations that cannot have manual interventions. diff --git a/docs/quickstart-torch.md b/docs/quickstart-torch.md index 32eb5b8aa..541cf7396 100644 --- a/docs/quickstart-torch.md +++ b/docs/quickstart-torch.md @@ -4,7 +4,7 @@ This quick start guide will get you started in 10 minutes or less. For the full product manual, please proceed to the [**Introduction**](index.md). -Are you using [Android](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#android) or [iOS](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#ios)? +Are you using [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#android) or [iOS](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#ios)? ## Android @@ -49,7 +49,7 @@ Are you using [Android](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#a *Figure 7* -You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the [RTK Crash Course](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#rtk-crash-course). +You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the [RTK Crash Course](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#rtk-crash-course). ## iOS @@ -91,7 +91,7 @@ The software options for Apple iOS are much more limited because Apple products *Figure 7* -You can now use your RTK device to measure points with very good (sub-meter) accuracy. If you need extreme accuracy (down to 10mm) continue reading the [RTK Crash Course](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#rtk-crash-course). +You can now use your RTK device to measure points with very good (sub-meter) accuracy. If you need extreme accuracy (down to 10mm) continue reading the [RTK Crash Course](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#rtk-crash-course). ## RTK Crash Course @@ -122,7 +122,7 @@ Be sure to check if your state or country provides corrections for free. Many do *The base station at SparkFun* -You can set up your own correction source. This is done with a 2nd GNSS receiver that is stationary, often called a Base Station. There is just the one-time upfront cost of the Base Station hardware. See the [Creating a Permanent Base](https://docs.sparkfun.com/SparkFun_RTK_Firmware/permanent_base/) document for more information. +You can set up your own correction source. This is done with a 2nd GNSS receiver that is stationary, often called a Base Station. There is just the one-time upfront cost of the Base Station hardware. See the [Creating a Permanent Base](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/permanent_base/) document for more information. ## NTRIP Example @@ -208,4 +208,4 @@ Facet L-Band is unique in that it must obtain keys to decrypt the signal from a Upon successful reception and decryption of L-Band corrections, the satellite dish icon will increase to a three-pronged icon (Figure 5). As the unit's accuracy increases a normal cross-hair will turn to a double blinking cross-hair indicating a floating RTK solution, and a solid double cross-hair will indicate a fixed RTK solution. The HPA will be below 0.030 (30mm) or better once RTK Fix is achieved. -You can now use your RTK device to measure points with millimeter accuracy. Please see [Android](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#android) or [iOS](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/#ios) for guidance on getting the RTK device connected to GIS software over Bluetooth. +You can now use your RTK device to measure points with millimeter accuracy. Please see [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#android) or [iOS](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#ios) for guidance on getting the RTK device connected to GIS software over Bluetooth. diff --git a/docs/readme.md b/docs/readme.md index 614209f50..c939cc165 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1 +1 @@ -This folder contains the markdown files for the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/) that are rendered by [mkdocs](https://www.mkdocs.org/). \ No newline at end of file +This folder contains the markdown files for the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/) that are rendered by [mkdocs](https://www.mkdocs.org/). \ No newline at end of file