Skip to content

Commit 26a9753

Browse files
nseidlenseidle
authored
Merge branch 'main' into release_candidate
2 parents dd18d2d + 5f7a57c commit 26a9753

File tree

109 files changed

+5981
-2179
lines changed

Some content is hidden

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

109 files changed

+5981
-2179
lines changed

‎.github/workflows/build_documentation.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Build Documentation
2+
3+
# Allows you to run this workflow manually from the Actions tab
4+
# on:
5+
# workflow_dispatch:
6+
# branches: ["main"]
7+
8+
# Run workflow on every commit
9+
on:
10+
push:
11+
branches:
12+
- main
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
15+
permissions:
16+
contents: write
17+
18+
19+
jobs:
20+
deploy:
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 0
28+
29+
- name: Instal pgnquant for optimize plugin
30+
run: sudo apt-get install pngquant
31+
32+
- name: Set up Python runtime
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: 3.x
36+
37+
- name: Install Python dependencies
38+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
39+
40+
- name: Set up build cache
41+
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
42+
- uses: actions/cache@v4
43+
with:
44+
key: mkdocs-material-${{ env.cache_id }}
45+
path: .cache
46+
restore-keys: |
47+
mkdocs-material-
48+
49+
- name: Install Insiders build
50+
env:
51+
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
52+
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
53+
- 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

@@ -149,7 +149,7 @@ jobs:
149149
- name: Compile Sketch
150150
run: arduino-cli compile --fqbn "esp32:esp32:esp32":DebugLevel=${{ env.DEBUG_LEVEL }},PSRAM=enabled ./Firmware/RTK_Everywhere/RTK_Everywhere.ino
151151
--build-property build.partitions=RTKEverywhere
152-
--build-property upload.maximum_size=4055040
152+
--build-property upload.maximum_size=4055040
153153
--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 }}\""
154154
--export-binaries
155155

@@ -160,11 +160,11 @@ jobs:
160160
161161
- name: Upload binary to action
162162
uses: actions/upload-artifact@v4
163-
with:
163+
with:
164164
name: ${{ env.FILENAME_PREFIX }}${{ env.FILE_ENDING_UNDERSCORE }}
165165
path: ./Firmware/RTK_Everywhere/build/esp32.esp32.esp32/${{ env.FILENAME_PREFIX }}${{ env.FILE_ENDING_UNDERSCORE }}.bin
166166

167-
167+
168168
- name: Push binary to Binaries Repo
169169
# uses: dmnemec/copy_file_to_another_repo_action #Workaround for Issue: https://github.com/orgs/community/discussions/55820#discussioncomment-5946136
170170
uses: Jason2866/copy_file_to_another_repo_action@http408_fix

‎.github/workflows/mkdocs.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

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

Lines changed: 4 additions & 4 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

@@ -162,7 +162,7 @@ jobs:
162162
163163
- name: Upload artifact directory to action - avoid double-zip
164164
uses: actions/upload-artifact@v3
165-
with:
165+
with:
166166
name: ${{ env.ARTIFACT }}
167167
path: Firmware/RTK_Everywhere/build/esp32.esp32.esp32/${{ env.ARTIFACT }}
168168
retention-days: 7

‎Firmware/RTK_Everywhere/Begin.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1461,6 +1461,9 @@ void beginI2C()
14611461
{
14621462
// Display is on standard Wire bus
14631463
i2cDisplay = i2c_0;
1464+
1465+
// Display splash screen for at least 1 second
1466+
minSplashFor = 1000;
14641467
}
14651468

14661469
if (present.display_i2c1 == true)

‎Firmware/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
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.
44

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

88
## Compilation Instructions
99

‎Issue_Template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
Describe your issue here. Additionally, screenshots are easy to paste into github.
33

44
### Your workbench
5-
* What version of RTK firmware are you running? This can be found when the serial menu is opened (also in the settings.txt file, and in the serial output at power up).
6-
* What radios are you using: Bluetooth, WiFi, and/or ESP-Now? What app are you using to connect over Bluetooth? Are you transmitting NTRIP back to the device?
7-
* Are there any additional details that may help us help you?
5+
- What version of RTK firmware are you running? This can be found when the serial menu is opened (also in the settings.txt file, and in the serial output at power up).
6+
- What radios are you using: Bluetooth, WiFi, and/or ESP-Now? What app are you using to connect over Bluetooth? Are you transmitting NTRIP back to the device?
7+
- Are there any additional details that may help us help you?
88

99
### Steps to reproduce
1010
Tell us how to reproduce this issue. Please post any log files from serial output that may have been generated.

‎README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,29 @@ 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/catalog/product/view/id/25662"><img src="docs/img/SparkFun_RTK_Torch.png"></a></td>
9+
<td><a href="https://www.sparkfun.com/catalog/product/view/id/24342"><img src="docs/img/SparkFun_RTK_EVK.png"></a></td>
10+
<td><a href="https://www.sparkfun.com/catalog/product/view/id/26916"><img src="docs/img/SparkFun_RTK_Postcard_Small.png"></a></td>
11+
</tr>
12+
<tr align="center">
13+
<td><a href="https://www.sparkfun.com/catalog/product/view/id/25662">SparkFun RTK Torch (GPS-25662)</a></td>
14+
<td><a href="https://www.sparkfun.com/catalog/product/view/id/24342">SparkFun RTK EVK (GPS-24342)</a></td>
15+
<td><a href="https://www.sparkfun.com/catalog/product/view/id/26919">SparkFun RTK Postcard (GPS-26916)</a></td>
16+
</tr>
17+
<tr align="center">
18+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
19+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
20+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Postcard/">Hookup Guide</a></td>
21+
</tr>
1922
</table>
2023

2124
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!
2225

2326
The [SparkFun RTK EVK](https://www.sparkfun.com/products/24342) 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!
2427

28+
The [SparkFun RTK Postcard](https://www.sparkfun.com/products/26916) is a scalable DIY RTK device capable of running the RTK Everywhere Firmware. The LG290P RTK module lives at the heart of the RTK Postcard providing 10mm accuracy and L1/L2/L5 reception. Add the [Portability Shield](https://www.sparkfun.com/sparkfun-portability-shield.html) to add a display, battery charging and logging.
29+
2530
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:
2631

2732
* [SparkFun RTK Torch](https://www.sparkfun.com/products/25662)
@@ -50,7 +55,7 @@ With respect to the firmware, `main` is a branch where only changes that are app
5055

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

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.
58+
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.
5459

5560
Release Process
5661
---------------

0 commit comments

Comments
 (0)