Skip to content

Commit 47edf1d

Browse files
committed
Add comments to examples
1 parent 797ab7b commit 47edf1d

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

examples/Example11_UsbNMEA/Example11_UsbNMEA.ino

+6-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
Date: October 2nd, 2023
66
License: MIT. Please see LICENSE.md for more information.
77
8-
This sketch turns on all the major NMEA setences at 2Hz and prints the
9-
incoming serial out the Serial port. This is useful for viewing the GNSS
8+
This sketch turns on all the major NMEA sentences at 2Hz and prints the
9+
messages over the USB C port (COM1 on the UM980). This is useful for viewing the GNSS
1010
data in a program like u-center.
1111
These examples are targeted for an ESP32 platform but any platform that has multiple
1212
serial UARTs should be compatible.
@@ -16,9 +16,13 @@
1616
SparkFun Triband GNSS RTK Breakout - UM980 (GPS-23286) https://www.sparkfun.com/products/23286
1717
1818
Hardware Connections:
19+
Connect a USB C cable to the UM980 breakout board
1920
Connect RX2 of the UM980 to pin 4 on the ESP32
2021
Connect TX2 of the UM980 to pin 13 on the ESP32
2122
To make this easier, a 4-pin locking JST cable can be purchased here: https://www.sparkfun.com/products/17240
23+
Open a terminal on the CH340 COM port at 115200bps
24+
NMEA will be displayed at 2Hz
25+
2226
Note: Almost any ESP32 pins can be used for serial.
2327
Connect a dual or triband GNSS antenna: https://www.sparkfun.com/products/21801
2428
*/

examples/Example16_PollForValidRTCMMessages/Example16_PollForValidRTCMMessages.ino

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
The documentation for the UM980 does not explicitly state which RTCM messages are supported
99
but by sending the enable command to the module we can insinuate which are supported.
1010
This sketch sends the 'RTCMxxxx' command and looks for an OK.
11+
The messages that successfully receive an OK will be reported at the completion of the sketch.
1112
These examples are targeted for an ESP32 platform but any platform that has multiple
1213
serial UARTs should be compatible.
1314
@@ -48,7 +49,7 @@ void setup()
4849
//We must start the serial port before using it in the library
4950
SerialGNSS.begin(115200, SERIAL_8N1, pin_UART1_RX, pin_UART1_TX);
5051

51-
myGNSS.enableDebugging(); // Print all debug to Serial
52+
// myGNSS.enableDebugging(); // Print all debug to Serial
5253

5354
if (myGNSS.begin(SerialGNSS) == false) //Give the serial port over to the library
5455
{

0 commit comments

Comments
 (0)