Skip to content

Commit

Permalink
Initial Push Tutorial to GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
bboyho committed Jun 30, 2024
1 parent a80b2d9 commit 670081a
Show file tree
Hide file tree
Showing 61 changed files with 2,324 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Run mkdocs
on:
push:
branches:
- main

permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Python runtime
uses: actions/setup-python@v4
with:
python-version: 3.11

- name: Install Python dependencies
run: pip install mkdocs-monorepo-plugin mkdocs-redirects 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
64 changes: 64 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Individual files - e.g. compiled binaries or local batch files - can be added to .git/info/exclude

partitions.csv
*.bin
*.elf
*.map

tokens.h
.vscode/*

# Windows image file caches
Thumbs.db
ehthumbs.db

#Eagle Backup files
*.s#?
*.b#?
*.l#?
*.lck

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# =========================
# Operating System Files
# =========================

# OSX
# =========================

.DS_Store
.AppleDouble
.LSOverride

# Icon must ends with two \r.
Icon


# Thumbnails
._*

# Files that might appear on external disk
.Spotlight-V100
.Trashes

# =========================
# Linux Files
# =========================

Compare
NMEA_Client
Read_Map_File
RTK_Reset
Split_Messages
X.509_crt_bundle_bin_to_c
Binary file added Firmware/Old Firmware/UM980_GSP10110.pkg
Binary file not shown.
Binary file added Firmware/UM980_R4.10Build11833.pkg
Binary file not shown.
55 changes: 55 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
SparkFun License Information
============================

SparkFun uses two different licenses for our files — one for hardware and one for code.

Hardware
---------

**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**

Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).

You are free to:

Share — copy and redistribute the material in any medium or format
Adapt — remix, transform, and build upon the material
for any purpose, even commercially.
The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:

Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
Notices:

You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.


Code
--------

**SparkFun code, firmware, and software is released under the [MIT License](http://opensource.org/licenses/MIT).**

The MIT License (MIT)

Copyright (c) 2016 SparkFun Electronics

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Binary file added Software/UPrecise V1.0.639.exe
Binary file not shown.
Binary file added Software/uprecise-v2-0.exe
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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.
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 docs/assets/img/RTK-Torch_Buttons_Back.png
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.
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 docs/assets/img/UPrecise_Software_English.JPG
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.
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 docs/assets/img/UPrecise_Software_Language.JPG
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.
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.
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.
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.
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 docs/assets/sfe_favicon.png
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 docs/assets/sfe_logo_sm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/ch340_drivers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
If you've never connected a USB-to-serial converter to your computer before, you may need to install drivers. The drivers will depend on your USB-to-serial converter. In this case, the SparkFun RTK Torch is populated with the CH34X and a RedBoard IoT Development Board (ESP32) used to connect to a UM980 is populated with the CH340.

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/sparkfun-serial-basic-ch340c-hookup-guide#drivers-if-you-need-them)" for help with the installation.

<div class="grid cards" style="width:500px; margin: 0 auto;" markdown>
<!-- ----------WHITE SPACE BETWEEN GRID CARDS---------- -->
- <a href="https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all">
<figure markdown>
<img src="https://cdn.sparkfun.com/assets/learn_tutorials/9/0/8/USB-to-serial_converter_CH340-closeup.jpg"style="width:264px; height:148px; object-fit:contain;" alt="How to Install CH340 Drivers">
</figure>
</a>

---

<a href="https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all">
<b>How to Install CH340 Drivers</b>
</a>
<!-- ----------WHITE SPACE BETWEEN GRID CARDS---------- -->
</div>
99 changes: 99 additions & 0 deletions docs/firmware_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
!!! note
The following instructions were taken from the UPrecise User Manual: 2.2.11 Receiver Upgrade. For more information about how to use UPrecise software, make sure to check out the user manual.

!!! note
At the time of writing, UPrecise Version 2.0 was used. Note that the GUI appearance and features may change upon future releases.

You can update your firmware (they call this a firmware upgrade in the manual) using Unicore's UPrecise software. Make sure to check [Unicore's UM980 product page](https://en.unicorecomm.com/products/detail/26), [download center](https://en.unicore.com/download-center/), or contact Unicore Communications for any firmware releases.

We'll assume that you have the firmware downloaded at this point and connected to the UM980. With UPrecise open, click on the menu with the triple bar (**&equiv;**) near the upper left of the window to expand the menu.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_COM_Port_Connected.JPG"><img src="../assets/img/UPrecise_Software_COM_Port_Connected.JPG" width="600px" height="600px" alt="UPrecise Software: COM Port Connected"></a></td>
</tr>
</table>
</div>

The menu should expand with text next to each icon.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_Expand_Menu_Connected.JPG"><img src="../assets/img/UPrecise_Software_Expand_Menu_Connected.JPG" width="600px" height="600px" alt="UPrecise Software: Menu Expanded"></a></td>
</tr>
</table>
</div>

Click on the **Receiver Upgrade** button. The following window should open up.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_Receiver_Upgrade.JPG"><img src="../assets/img/UPrecise_Software_Receiver_Upgrade.JPG" width="600px" height="600px" alt="UPrecise Software: Receiver Upgrade"></a></td>
</tr>
</table>
</div>

Click the **Select upgrade file** button. Head to the folder where you downloaded the firmware and select the file. The extension should be a **&#42;pkg** file. In this case, there was a copy of the firmware in the [Update Firmware Unicore GNSS Receiver Repo](https://github.com/sparkfun/SparkFun_UM980_Triband_GNSS_RTK_Breakout/tree/main/Firmware) named "_UM980_R4.10Build11833.pkg_". Older firmware versions that were used SparkFun products were moved to the **Old Firmware** folder.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_Select_File.JPG"><img src="../assets/img/UPrecise_Software_Select_File.JPG" width="600px" height="600px" alt="UPrecise Software: Select File"></a></td>
</tr>
</table>
</div>

<!--
NO OPTION FOR DOUBLE BACKUP...
If necessary, you can select the "Double backup" checkbox. Once the module has finished updating, the main partition makes a backup in the backup partition. If the main partition fails, the module will boot from the backup partition.
<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/"><img src="../assets/img/" width="600px" height="600px" alt=""></a></td>
</tr>
</table>
</div>
-->

Select the GNSS receiver that will be receiving the firmware update. In this case it was **Receiver1**. While we are at it, select either the "**Soft reset**" or "**Hard reset**". While updating, the module will need to be reset and this selection will determine the reset method. Let's select the "**Soft Reset**" and have UPrecise reset the module.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_Select_Receiver_Reset_Method.JPG"><img src="../assets/img/UPrecise_Software_Select_Receiver_Reset_Method.JPG" width="600px" height="600px" alt="UPrecise Software: Select Receiver and Reset Method"></a></td>
</tr>
</table>
</div>

When ready, hit the "Start" button!

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_Firmware_Updating_Soft_Reset.JPG"><img src="../assets/img/UPrecise_Software_Firmware_Updating_Soft_Reset.JPG" width="600px" height="600px" alt="UPrecise Software: Firmware Update in Progress with Soft Reset Method"></a></td>
</tr>
</table>
</div>

!!! warning
Make sure to pay attention to the progress bar! You'll want to avoid any interruptions while the firmware is updating as this will cause the upgrade to fail.

!!! note
If you have issues updating the software with the reset method chosen, try exiting the Receiver Upgrade menu by hitting the "x" button. Then disconnect and reconnect the module by selecting the "Connect" button. You will then need to open the **Receiver Upgrade** window again before hitting the "Start" button.

Once the firmware has been updated, you will notice that the progress bar is at 100% and a message indicating that the firmware upgrade succeeded and finished. You can exit out of the window by clicking on the "**x**" button.

<div style="text-align: center;">
<table>
<tr style="vertical-align:middle;">
<td style="text-align: center; vertical-align: middle;"><a href="../assets/img/UPrecise_Software_Receiver_Upgrade_Finished.JPG"><img src="../assets/img/UPrecise_Software_Receiver_Upgrade_Finished.JPG" width="600px" height="600px" alt="UPrecise Software: Receiver Upgrade Finished"></a></td>
</tr>
</table>
</div>
33 changes: 33 additions & 0 deletions docs/github/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contribute: Help Fix our Mistake!
Spot something wrong? Feel free to contribute our open-source design and documentation. <a href="https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/Update_Firmware_Unicore_GNSS_Receiver.svg" /></a>

## Improve our Documentation
All of this documentation can be modified by you! Please help us make it better.

* These pages are contained in the [`docs` folder of the Update Firmware Unicore GNSS Receiver repository](https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/tree/main/docs).

### Submit a Correction
1. Fork this repo
2. Add your corrections or improvements to the markdown file
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the documentation specialist will automatically be notified.
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.

## Improve our Hardware Design
All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the `Hardware` folder of the respective hardware repositories.

### Submit a Design Improvement
1. Fork this repo
2. Add your design improvements
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the engineer in charge of the original design will automatically be notified.
* We will review your suggested improvements, if they are within our board design standards and meet our product design requirements, we will flag these changes for our next board revision. *(Please note, that even if your suggestion is accepted, these changes may not be immediate. We may have to cycle through our current product inventory first.)*

## Contributors
Let's provided some recognition to the contributors for this project!

![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/Update_Firmware_Unicore_GNSS_Receiver/)
<br>
<a href="https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/Update_Firmware_Unicore_GNSS_Receiver.svg" /></a>
47 changes: 47 additions & 0 deletions docs/github/file_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Did we make a mistake?

Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/Update_Firmware_Unicore_GNSS_Receiver.svg" /></a>

!!! attention
This is not where customers should seek assistance on a product. If you require technical assistance or have questions about a product that is not working as expected, please head over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistance) page for some initial troubleshooting.
<center>
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
</center>

If you can't find what you need there, you'll need a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to search product forums and post questions.

## Discrepancies in the Documentation

All of this documentation can be modified by you! Please help us make it better.

* The documentation files for these pages are contained in the [`docs` folder of the Update Firmware Unicore GNSS Receiver repository](https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/tree/main/docs).

### Spot something wrong?
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/issues) and let us know.

### Do you have a suggested correction?
1. With a GitHub account, fork this repo
2. Add your correction(s) or improvement(s) to the markdown file(s)
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the documentation specialist will automatically be notified.
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.

## Problems in the Hardware Design

All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder of the Update Firmware Unicore GNSS Receiver repository](https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/tree/main/Hardware).

### Does something not make sense?
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/issues) and let us know.

### Did we forget to include an important function of the board?
* Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements. *(For example, our Qwiic Micro boards are intended to fit on a small board layout and only use I<sup>2</sup>C communication; therefore, we may not have the SPI and interrupt pins available for users.)*
* If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/Update_Firmware_Unicore_GNSS_Receiver/issues) and file a feature request.

### Do you wish to contribute directly to improving the board design?
1. With a GitHub account, Fork this repo
2. Add your design improvement(s)
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the engineer in charge of the original design will automatically be notified.
* We will review your suggested improvement(s), if they are within our board design standards and meet our product design requirements, we will flag these changes for our next board revision. *(Please note, that even if your suggestion is accepted, these changes may not be immediate. We may have to cycle through our current product inventory first.)*
9 changes: 9 additions & 0 deletions docs/hard_copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
icon: material/book-open-variant
---

Need to download or print our hookup guide?

* [Print :fontawesome-solid-print:](../single_page) (Single-Page View)
* To save as a `*.pdf` file, select the **Printer** or **Destination** labeled ++"Save as PDF"++. *(Instructions will vary based on the browser)*
<!-- * [Download :fontawesome-regular-file-pdf:](../hookup_guide.pdf) *(Beta - demonstration only)* -->
Loading

0 comments on commit 670081a

Please sign in to comment.