You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@ If you'd like to contribute, start by searching through the [issues](../../issue
6
6
7
7
If you are adding a feature to this library, please create a PR and follow these best practices:
8
8
9
-
* If you've added a new feature document it with a simple example sketch. This serves both as a test of your PR and as a quick way for users to quickly learn how to use your new feature.
10
-
* If you add new functions also add them to keywords.txt so that they are properly highlighted in Arduino. [Read more](https://www.arduino.cc/en/Hacking/libraryTutorial).
11
-
* PRs should change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
9
+
- If you've added a new feature document it with a simple example sketch. This serves both as a test of your PR and as a quick way for users to quickly learn how to use your new feature.
10
+
- If you add new functions also add them to keywords.txt so that they are properly highlighted in Arduino. [Read more](https://www.arduino.cc/en/Hacking/libraryTutorial).
11
+
- PRs should change as little as possible. Do not submit a PR that changes 100 lines of whitespace. Break up into multiple PRs if necessary.
Copy file name to clipboardExpand all lines: README.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,13 @@ The mosaic-T is a superb GNSS module designed for highly accurate timing applica
16
16
Documentation
17
17
--------------
18
18
19
-
***[Product Manual](http://docs.sparkfun.com/SparkFun_GNSSDO/)** - Product manual for the GNSSDO hosted by GitHub pages.<br>
19
+
-**[Product Manual](http://docs.sparkfun.com/SparkFun_GNSSDO/)** - Product manual for the GNSSDO hosted by GitHub pages.<br>
20
20
[](https://squidfunk.github.io/mkdocs-material/)[](https://github.com/sparkfun/SparkFun_GNSSDO/actions/workflows/mkdocs.yml)
21
21
22
22
23
23
*Need to download or print our hookup guide?*
24
24
25
-
*[Print *(Print to PDF)* from Single-Page View](http://docs.sparkfun.com/SparkFun_GNSSDO/print_view)
25
+
-[Print *(Print to PDF)* from Single-Page View](http://docs.sparkfun.com/SparkFun_GNSSDO/print_view)
26
26
27
27
Firmware Update
28
28
-------------------
@@ -34,30 +34,30 @@ You can update or reload the firmware using the [SparkFun RTK Firmware Uploader]
34
34
Repository Contents
35
35
-------------------
36
36
37
-
***[/docs](/docs/)** - Online documentation files
38
-
*[assets](/docs/assets/) - Assets files
39
-
*[board_files](/docs/assets/board_files/) - Files for the product design
All of this documentation can be modified by you! Please help us make it better.
6
6
7
-
* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/docs) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
7
+
- These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/docs) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
8
8
9
9
<!-- ### :material-source-pull: Submit a Correction -->
10
10
### Submit a Correction
11
11
12
12
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_GNSSDO/fork).
13
13
2. Add your corrections or improvements to the markdown file.
14
14
3. File a pull request with your changes, and enjoy making the ~~words~~~~worlds~~ world a better place.
15
-
* Once received, the documentation specialist will automatically be notified.
16
-
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.
15
+
- Once received, the documentation specialist will automatically be notified.
16
+
- We will review your suggested improvements to make sure they are correct and fit within our documentation standards.
All of our designs are open-source! Please help us make it better.
20
20
21
-
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/Hardware) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
21
+
- Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/Hardware) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
22
22
23
23
<!-- ### :material-source-pull: Submit a Design Enhancement -->
Copy file name to clipboardExpand all lines: docs/github/file_issue.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/S
20
20
21
21
All of our documentation can be modified by you! Please help us make it better.
22
22
23
-
* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/docs) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
23
+
- The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/docs) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
24
24
25
25
### 🔍 Spot something wrong?
26
26
@@ -31,14 +31,14 @@ If a section of the documentation is incorrect, please [open an issue](https://g
31
31
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_GNSSDO/fork).
32
32
2. Add your correction(s) or improvement(s) to the markdown file(s)
33
33
3. File a pull request with your changes, and enjoy making the ~~words~~~~worlds~~ world a better place.
34
-
* Once received, the documentation specialist will automatically be notified.
35
-
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.
34
+
- Once received, the documentation specialist will automatically be notified.
35
+
- We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.
36
36
37
37
## Problems in the Hardware Design
38
38
39
39
All of our designs are open-source! Please help us make it better.
40
40
41
-
* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/Hardware) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
41
+
- Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_GNSSDO/tree/main/Hardware) of the [SparkFun GNSSDO repository](https://github.com/sparkfun/SparkFun_GNSSDO).
42
42
43
43
### Does something not make sense? 🤔
44
44
@@ -51,7 +51,7 @@ If part of the board's functionality is missing, please [open an issue](https://
51
51
!!! tip "Design Considerations"
52
52
Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements.
53
53
54
-
* *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.*
54
+
- *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.*
55
55
56
56
57
57
### Do you wish to contribute directly to improving the board design?
Copy file name to clipboardExpand all lines: docs/hardware_assembly.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,7 +91,7 @@ There is a single ethernet jack on the GNSSDO, which can be used to provide netw
91
91
92
92
The jack to the mosaic-T allows users to provide internet access and power; it supports [PoE](https://en.wikipedia.org/wiki/Power_over_Ethernet"Power over Ethernet"). To provide network access, users should connect the GNSSDO from the `ETHERNET (PoE)` jack to their local network with the (CAT-6) ethernet cable provided in the kit.
93
93
94
-
* To power the device, a PoE network switch or PoE injector should be installed in between the network connection to the GNSSDO.
94
+
- To power the device, a PoE network switch or PoE injector should be installed in between the network connection to the GNSSDO.
95
95
96
96
<figuremarkdown>
97
97
[{ width="400" }](./assets/img/hookup_guide/assembly-ethernet-mosaic.jpg"Click to enlarge")
@@ -150,10 +150,10 @@ An µSD card slot is available for users to log and store data, locally on
150
150
??? tip "Button Operation"
151
151
There are multiple ways to configure and enable data logging to an SD card. However, the simplest method is with the ++"LOG"++ button. Once the stream is defined,
152
152
153
-
* Pressing the ++"LOG"++ button *(< 5s)* toggles data logging to the SD card on and off.
154
-
* Holding the ++"LOG"++ button for more than 5 seconds *(> 5s)* and then releasing it, will force the board to:
155
-
* Unmount the SD card if it was mounted
156
-
* Mount the SD card if it was unmounted
153
+
- Pressing the ++"LOG"++ button *(< 5s)* toggles data logging to the SD card on and off.
154
+
- Holding the ++"LOG"++ button for more than 5 seconds *(> 5s)* and then releasing it, will force the board to:
155
+
- Unmount the SD card if it was mounted
156
+
- Mount the SD card if it was unmounted
157
157
158
158
For more information, please reference the [SD Card Slot](../hardware_overview/#sd-card-slot) section.
0 commit comments