-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Push Initial Tutorial to GitHub Pages and Update Revised u-blox Docum…
…ents
- Loading branch information
Showing
73 changed files
with
15,428 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Run mkdocs | ||
on: | ||
push: | ||
branches: | ||
- main | ||
permissions: | ||
contents: write | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python runtime | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.x | ||
|
||
- name: Install Python dependencies | ||
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 | ||
|
||
- name: Set up build cache | ||
uses: actions/cache@v2 | ||
with: | ||
key: ${{ github.ref }} | ||
path: .cache | ||
|
||
- name: Install Insiders build | ||
env: | ||
GH_TOKEN: ${{ secrets.GH_TOKEN }} | ||
run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git | ||
- run: mkdocs gh-deploy --force |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
Now that we have our library and board add-on installed, we can get start experimenting with the breakout board. For the scope of this tutorial, we will highlight one of the examples to get started. From there we will be able to build our own custom code to integrate the development board into a project. | ||
|
||
|
||
|
||
### Example 1: NAV-SIG | ||
|
||
This example shows how to configure the NEO-F10N GNSS for L5 band and overriding the health status. The output will indicate the type of signals that the NEO-F10N is receiving. Head to the example in the **NEO-10N** folder (located in **File** **Examples** > **SparkFun u-blox GNSS V3** > **NEO-F10N** > **Example1_NAV-SIG**). | ||
|
||
If you have not already, select your Board (in this case the **SparkFun ESP32 IoT RedBoard**), and associated COM port. Upload the code to the board and set the [Arduino Serial Monitor](https://learn.sparkfun.com/tutorials/terminal-basics/all#arduino-serial-monitor-windows-mac-linux) to **115200** baud. Give the NEO-F10N a few minutes to get a satellite lock. The signals available will be output in the Serial Monitor. If everything goes well, you should see some L5 signals (highlighted in red). | ||
|
||
<div style="text-align: center;"> | ||
<table> | ||
<tr style="vertical-align:middle;"> | ||
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/Arduino_NEO-F10N_IoT_RedBoard_ESP32_Output_Satellites_Highlighted.JPG"><img src="../assets/img/Arduino_NEO-F10N_IoT_RedBoard_ESP32_Output_Satellites_Highlighted.JPG" width="600px" height="600px" alt="NEO-F10N Signals and Health Status; L5 Highlighted"></a></td> | ||
</tr> | ||
</table> | ||
</div> | ||
|
||
|
||
|
||
### More Examples! | ||
|
||
Now that you got it up and running, check out the other examples located in the ZED-F10N folder! | ||
|
||
<div style="text-align: center"><a href="https://github.com/sparkfun/SparkFun_u-blox_GNSS_v3/tree/main/examples/NEO-F10N" target="github_gnss_v3" class="md-button">SparkFun_u-blox_GNSS_v3 > examples > NEO-F10N</a></div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
!!! arduino | ||
This example assumes you are using the latest version of the Arduino IDE on your desktop. If this is your first time using the Arduino IDE, library, or board add-on, please review the following tutorials. | ||
|
||
- [Installing the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-arduino-ide) | ||
- [Installing Board Definitions in the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-board-definitions-in-the-arduino-ide) | ||
- [Installing an Arduino Library](https://learn.sparkfun.com/tutorials/installing-an-arduino-library) | ||
|
||
!!! note | ||
If you've never connected an CH340 device to your computer before, you may need to install drivers for the USB-to-serial converter. Check out our section on "[How to Install CH340 Drivers](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers)" for help with the installation. | ||
|
||
- [How to Install CH340 Drivers](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all) | ||
|
||
SparkFun has written a library to work with the u-blox NEO-F10N. You can obtain this library through the Arduino Library Manager by searching for "**SparkFun u-blox GNSS v3**". Find the one written by SparkFun Electronics and install the latest version. Users who prefer to manually install the library can get it from the [GitHub Repository](https://github.com/sparkfun/SparkFun_u-blox_GNSS_v3) or download the .ZIP by clicking the button below: | ||
|
||
<div style="text-align: center"><a href="https://github.com/sparkfun/SparkFun_u-blox_GNSS_v3/archive/refs/heads/main.zip" class="md-button">SparkFun u-blox GNSS Arduino Library - v3 | ||
(ZIP)</a></div> | ||
|
||
Once you have the library installed checkout the various examples! There are several examples in the library that cover more than just the NEO-F10N. Note that some examples will not apply depending on the modules features. We will be looking at the [NEO-F10N folder](https://github.com/sparkfun/SparkFun_u-blox_GNSS_v3/tree/main/examples/NEO-F10N). | ||
|
||
|
||
!!! note | ||
According to the u-blox Integration Manual for the NEO-F10N, the current firmware does not support such as geofencing and low power mode so those examples contained in the library do not apply. Remember, the NEO-F10N only supports serial UART so the examples involving I<sup>2</sup>C and SPI do not apply either. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+209 KB
docs/assets/board_files/SparkFun_GNSS_L1_L5_BreakoutNEO-F10N_Schematic_V10.pdf
Binary file not shown.
Oops, something went wrong.