Skip to content

Commit dfffd8a

Browse files
Fix spacing
Replace markdown indentation with tabs instead of spacing Remove space from end of line Fix double spaces in text Add empty line to end of markdown files
1 parent fc572f6 commit dfffd8a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+687
-690
lines changed

.github/workflows/build_documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ jobs:
4343
4444
- name: Install Insiders build
4545
env:
46-
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
46+
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
4747
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
4848
- run: mkdocs gh-deploy --clean

.github/workflows/compile-rtk-everywhere.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Build RTK Everywhere
2-
on:
2+
on:
33
workflow_dispatch:
4-
branches:
4+
branches:
55

66
env:
77
FILENAME_PREFIX: RTK_Everywhere_Firmware
@@ -14,7 +14,7 @@ env:
1414

1515
jobs:
1616
build:
17-
17+
1818
name: Build
1919
runs-on: ubuntu-latest
2020

@@ -145,7 +145,7 @@ jobs:
145145
- name: Compile Sketch
146146
run: arduino-cli compile --fqbn "esp32:esp32:esp32":DebugLevel=${{ env.DEBUG_LEVEL }},PSRAM=enabled ./Firmware/RTK_Everywhere/RTK_Everywhere.ino
147147
--build-property build.partitions=RTKEverywhere
148-
--build-property upload.maximum_size=4055040
148+
--build-property upload.maximum_size=4055040
149149
--build-property "compiler.cpp.extra_flags=-MMD -c \"-DPOINTPERFECT_LBAND_TOKEN=$POINTPERFECT_LBAND_TOKEN\" \"-DPOINTPERFECT_IP_TOKEN=$POINTPERFECT_IP_TOKEN\" \"-DPOINTPERFECT_LBAND_IP_TOKEN=$POINTPERFECT_LBAND_IP_TOKEN\" \"-DFIRMWARE_VERSION_MAJOR=$FIRMWARE_VERSION_MAJOR\" \"-DFIRMWARE_VERSION_MINOR=$FIRMWARE_VERSION_MINOR\" \"-DENABLE_DEVELOPER=${{ env.ENABLE_DEVELOPER }}\""
150150
--export-binaries
151151

@@ -156,11 +156,11 @@ jobs:
156156
157157
- name: Upload binary to action
158158
uses: actions/upload-artifact@v3
159-
with:
159+
with:
160160
name: ${{ env.FILENAME_PREFIX }}${{ env.FILE_ENDING_UNDERSCORE }}
161161
path: ./Firmware/RTK_Everywhere/build/esp32.esp32.esp32/${{ env.FILENAME_PREFIX }}${{ env.FILE_ENDING_UNDERSCORE }}.bin
162162

163-
163+
164164
- name: Push binary to Binaries Repo
165165
# uses: dmnemec/copy_file_to_another_repo_action #Workaround for Issue: https://github.com/orgs/community/discussions/55820#discussioncomment-5946136
166166
uses: Jason2866/copy_file_to_another_repo_action@http408_fix

.github/workflows/non-release-build.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Non-Release Build
2-
on:
2+
on:
33
workflow_dispatch:
4-
branches:
4+
branches:
55

66
env:
77
FILENAME_PREFIX: RTK_Everywhere_Firmware
@@ -14,7 +14,7 @@ env:
1414

1515
jobs:
1616
build:
17-
17+
1818
name: Build
1919
runs-on: ubuntu-latest
2020

@@ -144,7 +144,7 @@ jobs:
144144
- name: Compile Sketch
145145
run: arduino-cli compile --fqbn "esp32:esp32:esp32":DebugLevel=${{ env.DEBUG_LEVEL }},PSRAM=enabled ./Firmware/RTK_Everywhere/RTK_Everywhere.ino
146146
--build-property build.partitions=RTKEverywhere
147-
--build-property upload.maximum_size=3145728
147+
--build-property upload.maximum_size=3145728
148148
--build-property "compiler.cpp.extra_flags=-MMD -c \"-DPOINTPERFECT_LBAND_TOKEN=$POINTPERFECT_LBAND_TOKEN\" \"-DPOINTPERFECT_IP_TOKEN=$POINTPERFECT_IP_TOKEN\" \"-DPOINTPERFECT_LBAND_IP_TOKEN=$POINTPERFECT_LBAND_IP_TOKEN\" \"-DFIRMWARE_VERSION_MAJOR=$FIRMWARE_VERSION_MAJOR\" \"-DFIRMWARE_VERSION_MINOR=$FIRMWARE_VERSION_MINOR\" \"-DENABLE_DEVELOPER=${{ env.ENABLE_DEVELOPER }}\""
149149
--export-binaries
150150

@@ -160,7 +160,7 @@ jobs:
160160
161161
- name: Upload artifact directory to action - avoid double-zip
162162
uses: actions/upload-artifact@v3
163-
with:
163+
with:
164164
name: ${{ env.ARTIFACT }}
165165
path: Firmware/RTK_Everywhere/build/esp32.esp32.esp32/${{ env.ARTIFACT }}
166166
retention-days: 7

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ SparkFun RTK Everywhere Firmware
44
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:
55

66
<table class="table table-hover table-striped table-bordered">
7-
<tr align="center">
8-
<td><a href="https://www.sparkfun.com/products/25662"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
9-
<td><a href="https://www.sparkfun.com/products/24342"><img src="docs/img/SparkFun_RTK_EVK.png"></a></td>
10-
</tr>
11-
<tr align="center">
12-
<td><a href="https://www.sparkfun.com/products/25662">SparkFun RTK Torch (GPS-25662)</a></td>
13-
<td><a href="https://www.sparkfun.com/products/24342">SparkFun RTK EVK (GPS-24342)</a></td>
14-
</tr>
15-
<tr align="center">
16-
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
17-
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
18-
</tr>
7+
<tr align="center">
8+
<td><a href="https://www.sparkfun.com/products/25662"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
9+
<td><a href="https://www.sparkfun.com/products/24342"><img src="docs/img/SparkFun_RTK_EVK.png"></a></td>
10+
</tr>
11+
<tr align="center">
12+
<td><a href="https://www.sparkfun.com/products/25662">SparkFun RTK Torch (GPS-25662)</a></td>
13+
<td><a href="https://www.sparkfun.com/products/24342">SparkFun RTK EVK (GPS-24342)</a></td>
14+
</tr>
15+
<tr align="center">
16+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
17+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
18+
</tr>
1919
</table>
2020

2121
The [SparkFun RTK Torch](https://www.sparkfun.com/products/25662) 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. It supports Galileo E6 HAS and has built-in tilt compensation too!
@@ -50,7 +50,7 @@ With respect to the firmware, `main` is a branch where only changes that are app
5050

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

53-
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.
53+
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.
5454

5555
Release Process
5656
---------------

docs/accuracy_verification.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This is, admittedly, a very US-centric tutorial. We hope that it will provide so
2626

2727
This is a replication and confirmation of the procedure done by [RTKLibExplorer in 2018](https://rtklibexplorer.wordpress.com/2018/03/17/measuring-a-survey-marker-with-the-datagnss-d302-rtk/). We modified it to demonstrate a similar process but using u-blox hardware and with a few updates.
2828

29-
The process goes like this:
29+
The process goes like this:
3030

3131
* Find a local monument
3232
* Convert the coordinates
@@ -53,7 +53,7 @@ Locate a GPS monument. These are the little metal caps, placed by surveyors, emb
5353

5454
*Boulder has a large number of monuments*
5555

56-
Thankfully, in the USA the National Geodetic Survey has an incredible database of public monuments. Enter your location into the [NGS Data Explorer](https://www.ngs.noaa.gov/NGSDataExplorer/) to find the nearest monument.
56+
Thankfully, in the USA the National Geodetic Survey has an incredible database of public monuments. Enter your location into the [NGS Data Explorer](https://www.ngs.noaa.gov/NGSDataExplorer/) to find the nearest monument.
5757

5858
![Boulder's GPS monuments](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%202%20Boulder%20GPS%20Sites.jpg)
5959

@@ -83,7 +83,7 @@ The SparkFun example monument is at:
8383

8484
### Convert NAD83 to Today
8585

86-
So we know the NAD83 Lat/Long of our monument, right? Not quite.
86+
So we know the NAD83 Lat/Long of our monument, right? Not quite.
8787

8888
![Plate movement map](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%206%20Plate%20Movements.jpg)
8989

@@ -163,17 +163,17 @@ We can see the approximate location of the monument in the above location.
163163

164164
*Screenshot of a point in time*
165165

166-
Note the 8 decimal places on the Lat/Long.
166+
Note the 8 decimal places on the Lat/Long.
167167

168168
Screenshots are an easy way to record lat/long/alt but SW Maps (and other GIS software) allows the averaging of a position. Choose your own adventure. For our example, we took screenshots/snapshots of the location. Some surveyors hold a position for multiple minutes to get a point; we can do the same in under a second.
169169

170170
![Comparison of three RTK correction sources](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2013%20Compare%20Points.jpg)
171171

172172
*Comparison of three RTK correction sources*
173173

174-
Off the shelf, we regularly see 300 down to 150mm horizontal positional accuracy using any RTK product with a good L1/L2 antenna. This is shown in the picture above as the circle with 'No Corrections'.
174+
Off the shelf, we regularly see 300 down to 150mm horizontal positional accuracy using any RTK product with a good L1/L2 antenna. This is shown in the picture above as the circle with 'No Corrections'.
175175

176-
With corrections turned on, the benefit of an RTK fix is obvious. The two surveyed points overlap each other so closely they are nearly indistinguishable. The SparkFun base station is documented [here](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) and has a location accuracy of approximately 8.4mm. Using a base station is more accurate (as we will see) but L-Band corrections will also get you *incredibly* similar accuracy with a lot less hassle.
176+
With corrections turned on, the benefit of an RTK fix is obvious. The two surveyed points overlap each other so closely they are nearly indistinguishable. The SparkFun base station is documented [here](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) and has a location accuracy of approximately 8.4mm. Using a base station is more accurate (as we will see) but L-Band corrections will also get you *incredibly* similar accuracy with a lot less hassle.
177177

178178
## Why doesn’t it match the image?
179179

@@ -205,7 +205,7 @@ Feel free to look at and make a copy of the [SparkFun example](https://docs.goog
205205

206206
* Use the best equipment. Our mechanical setup was rickety and cheap. Use a surveyor’s bipod setup, with a bubble level, and a prism pole to accurately level the RTK receiver and measure the distance to the monument.
207207
* Use an antenna that is NGS calibrated to obtain accurate ARPs. The [SparkFun TOP106 antenna](https://www.sparkfun.com/products/17751) has been calibrated and we are in the process of calibrating the RTK Facet and RTK Facet L-Band.
208-
* Use an accurate base. A temporary or ‘survey-in’ base will not be accurate. The base needs 24 hours of logging with a [PPP analysis](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station/all#gather-raw-gnss-data).
208+
* Use an accurate base. A temporary or ‘survey-in’ base will not be accurate. The base needs 24 hours of logging with a [PPP analysis](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station/all#gather-raw-gnss-data).
209209
* Be within 10km of your base. A baseline that is more than 10km will introduce inaccuracies to the RTK fix readings.
210210
* Correction services are not as accurate as a fixed base. While services such as Skylark and PointPerfect are *convenient*, they use models to estimate the overall isotropic disturbance. A local, fixed base will outperform a correction service.
211211
* Take an average of points. All the points taken in this example were single snapshots. Average a few seconds' worth of readings.

docs/configure_with_bluetooth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Bluetooth can also be used to view system status and output. Simply exit the con
4848

4949
## Exit Bluetooth Echo Mode
5050

51-
To exit Bluetooth Echo Mode simply disconnect Bluetooth. In the Bluetooth Serial Terminal app, this is done by pressing the 'two plugs' icon in the upper right corner.
51+
To exit Bluetooth Echo Mode simply disconnect Bluetooth. In the Bluetooth Serial Terminal app, this is done by pressing the 'two plugs' icon in the upper right corner.
5252

5353
![Exiting Bluetooth Echo Mode](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Exit%20BEM.png)
5454

0 commit comments

Comments
 (0)