Skip to content

Commit d89c95e

Browse files
Fix Lists
Fix indentations Fix ordered lists. Replace `)` with `.` Replace `*` with `-` to provide clearer distinction from list beginning with bolded text Remove blank lines (carriage returns)
1 parent 70c3d54 commit d89c95e

38 files changed

+419
-483
lines changed

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.

docs/accuracy_verification.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ This is a replication and confirmation of the procedure done by [RTKLibExplorer
3131

3232
The process goes like this:
3333

34-
* Find a local monument
35-
* Convert the coordinates
36-
* Take measurements
37-
* Calculate differences
34+
- Find a local monument
35+
- Convert the coordinates
36+
- Take measurements
37+
- Calculate differences
3838

3939
## Get Used to RTK
4040

@@ -98,9 +98,9 @@ My respect for the surveying industry grows daily, but that doesn't mean they ar
9898

9999
The SparkFun example monument is at:
100100

101-
* Latitude: 40 05 14.86880 (NAD83 in 2012)
102-
* Longitude: -105 09 01.68689 (NAD83 in 2012)
103-
* Elliptical Height: 1613.737 meters (NAD83 in 2012)
101+
- Latitude: 40 05 14.86880 (NAD83 in 2012)
102+
- Longitude: -105 09 01.68689 (NAD83 in 2012)
103+
- Elliptical Height: 1613.737 meters (NAD83 in 2012)
104104

105105
### Convert NAD83 to Today
106106

@@ -135,15 +135,15 @@ Once we enter all the pertinent data, we receive a nice output showing us our mo
135135

136136
The SparkFun example monument is at:
137137

138-
* Latitude: 40 05 14.88667 (WGS84 in 2022)
139-
* Longitude: -105 09 01.74023 (WGS84 in 2022)
140-
* Elliptical Height: 1612.873 meters (WGS84 in 2022)
138+
- Latitude: 40 05 14.88667 (WGS84 in 2022)
139+
- Longitude: -105 09 01.74023 (WGS84 in 2022)
140+
- Elliptical Height: 1612.873 meters (WGS84 in 2022)
141141

142142
And in ECEF (this will be handy in a minute):
143143

144-
* X: -1277423.441 m (ECEF in 2022)
145-
* Y: -4717810.159 m (ECEF in 2022)
146-
* Z: 4086459.331 m (ECEF in 2022)
144+
- X: -1277423.441 m (ECEF in 2022)
145+
- Y: -4717810.159 m (ECEF in 2022)
146+
- Z: 4086459.331 m (ECEF in 2022)
147147

148148
### Convert from HH:MM:SS to Decimal
149149

@@ -158,9 +158,9 @@ The NGS coordinates are in the hour/minute/second format (ie, 40 05 14.86880). W
158158

159159
The SparkFun example monument is at:
160160

161-
* Latitude: 40.08746852 (WGS84 in 2022)
162-
* Longitude: -105.15048340 (WGS84 in 2022)
163-
* Elliptical Height: 1613.737 meters (WGS84 in 2022)
161+
- Latitude: 40.08746852 (WGS84 in 2022)
162+
- Longitude: -105.15048340 (WGS84 in 2022)
163+
- Elliptical Height: 1613.737 meters (WGS84 in 2022)
164164

165165
These are the coordinates we hope to see using SW Maps once we get out into the field. Write down your monument coordinates so that you have some idea of how close your unit is to the ideal in real-time.
166166

@@ -261,11 +261,11 @@ Feel free to look at and make a copy of the [SparkFun example](https://docs.goog
261261

262262
## How do I get 14mm?!
263263

264-
* Use the best equipment. Our mechanical setup was rickety and cheap. Use a surveyor’s bipod setup, with a bubble level, and a prism pole to accurately level the RTK receiver and measure the distance to the monument.
265-
* Use an antenna that is NGS calibrated to obtain accurate ARPs. The [SparkFun TOP106 antenna](https://www.sparkfun.com/products/17751) has been calibrated and we are in the process of calibrating the RTK Facet and RTK Facet L-Band.
266-
* Use an accurate base. A temporary or ‘survey-in’ base will not be accurate. The base needs 24 hours of logging with a [PPP analysis](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station/all#gather-raw-gnss-data).
267-
* Be within 10km of your base. A baseline that is more than 10km will introduce inaccuracies to the RTK fix readings.
268-
* Correction services are not as accurate as a fixed base. While services such as Skylark and PointPerfect are *convenient*, they use models to estimate the overall isotropic disturbance. A local, fixed base will outperform a correction service.
269-
* Take an average of points. All the points taken in this example were single snapshots. Average a few seconds' worth of readings.
264+
- Use the best equipment. Our mechanical setup was rickety and cheap. Use a surveyor’s bipod setup, with a bubble level, and a prism pole to accurately level the RTK receiver and measure the distance to the monument.
265+
- Use an antenna that is NGS calibrated to obtain accurate ARPs. The [SparkFun TOP106 antenna](https://www.sparkfun.com/products/17751) has been calibrated and we are in the process of calibrating the RTK Facet and RTK Facet L-Band.
266+
- Use an accurate base. A temporary or ‘survey-in’ base will not be accurate. The base needs 24 hours of logging with a [PPP analysis](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station/all#gather-raw-gnss-data).
267+
- Be within 10km of your base. A baseline that is more than 10km will introduce inaccuracies to the RTK fix readings.
268+
- Correction services are not as accurate as a fixed base. While services such as Skylark and PointPerfect are *convenient*, they use models to estimate the overall isotropic disturbance. A local, fixed base will outperform a correction service.
269+
- Take an average of points. All the points taken in this example were single snapshots. Average a few seconds' worth of readings.
270270

271271
This was a lot of fun and a good excuse to get outdoors. We hope you enjoy finding some new points in your world.

docs/configure_with_cli.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,11 +170,11 @@ If the receiver is unable to carry out the action, the following error message i
170170

171171
The following actions shall be implemented.
172172

173-
* APPLY: applies the currently stored settings, rebooting if necessary.
174-
* SAVE: Saves current settings to NVM
175-
* EXIT: Exits the command interface
176-
* REBOOT: Restarts the receiver firmware without applying settings.
177-
* LIST: List all firmware configuration fields.
173+
- **`APPLY`**: applies the currently stored settings, rebooting if necessary.
174+
- **`SAVE`**: Saves current settings to NVM
175+
- **`EXIT`**: Exits the command interface
176+
- **`REBOOT`**: Restarts the receiver firmware without applying settings.
177+
- **`LIST`**: List all firmware configuration fields.
178178

179179
## LIST Action
180180

docs/configure_with_serial.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,21 @@ Terminal showing System Status
9292

9393
> $GNTXT,01,01,05,202447.00,270522,0.380,29,40.090355193,-105.184764700,1560.56,3,0,86*7 1
9494

95-
* $GNTXT : Start of custom NMEA sentence
96-
* 01 : Number of sentences
97-
* 01 : Sentence number
98-
* 05 : Sentence type ID (5 is for System Status messages)
99-
* 202447.00 : Current hour, minute, second, milliseconds
100-
* 270522 : Current day, month, year
101-
* 0.380 : Current horizontal positional accuracy (m)
102-
* 29 : Satellites in view
103-
* 40.090355193 : Latitude
104-
* -105.184764700 : Longitude
105-
* 1560.56 : Altitude
106-
* 3 : Fix type (0 = no fix, 2 = 2D fix, 3 = 3D fix, 4 = 3D + Dead Reackoning, 5 = Time)
107-
* 0 : Carrier solution (0 = No RTK, 1 = RTK Float, 2 = RTK Fix)
108-
* 86 : Battery level (% remaining)
109-
* *71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
95+
- $GNTXT : Start of custom NMEA sentence
96+
- 01 : Number of sentences
97+
- 01 : Sentence number
98+
- 05 : Sentence type ID (5 is for System Status messages)
99+
- 202447.00 : Current hour, minute, second, milliseconds
100+
- 270522 : Current day, month, year
101+
- 0.380 : Current horizontal positional accuracy (m)
102+
- 29 : Satellites in view
103+
- 40.090355193 : Latitude
104+
- -105.184764700 : Longitude
105+
- 1560.56 : Altitude
106+
- 3 : Fix type (0 = no fix, 2 = 2D fix, 3 = 3D fix, 4 = 3D + Dead Reackoning, 5 = Time)
107+
- 0 : Carrier solution (0 = No RTK, 1 = RTK Float, 2 = RTK Fix)
108+
- 86 : Battery level (% remaining)
109+
- *71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
110110

111111
!!! note
112112
This is a custom NMEA sentence, can vary in length, and may exceed the [maximum permitted sentence length](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) of 61 characters.

docs/configure_with_settings_file.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ All system configuration can be done by editing the *SFE_[Platform]_Settings_0.t
3232

3333
Keep in mind:
3434

35-
* Not all devices have an SD card slot (ie, RTK Torch) and therefore do not support this configuration method.
36-
* The settings file contains hundreds of settings.
37-
* The SD card file "SFE_EVK_Settings_0.txt" is used for Profile 1, SD card file "SFE_EVK_Settings_1.txt" is used for Profile 2, etc.
35+
- Not all devices have an SD card slot (ie, RTK Torch) and therefore do not support this configuration method.
36+
- The settings file contains hundreds of settings.
37+
- The SD card file "SFE_EVK_Settings_0.txt" is used for Profile 1, SD card file "SFE_EVK_Settings_1.txt" is used for Profile 2, etc.
3838

3939
!!! note
4040
The `Settings_0` is for **Profile 1**, `Settings_1` is for **Profile 2**, `Settings_2` is for **Profile 3**...
4141

42-
* When switching to a new profile, the settings file on the SD card with all settings will be created or updated. The internal settings will not be updated until you switch to the profile. Additionally, the file for a particular profile will not be created on the SD card until you switch to that profile.
43-
* It is not necessary that the settings file on the SD card have all of the settings.
42+
- When switching to a new profile, the settings file on the SD card with all settings will be created or updated. The internal settings will not be updated until you switch to the profile. Additionally, the file for a particular profile will not be created on the SD card until you switch to that profile.
43+
- It is not necessary that the settings file on the SD card have all of the settings.
4444

4545
!!! example
4646
For example, if you only wanted to set up two wireless networks for **Profile 2**, you could create a file named `SFE_Express_Settings_1.txt` that only contained the following settings:

docs/configure_with_wifi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ To get into WiFi configuration follow these steps:
6969
4. Connect to WiFi network named ‘RTK Config’.
7070
5. You should be automatically re-directed to the config page but if you are not, open a browser (Chrome is preferred) and type **rtk.local** into the address bar.
7171

72-
<figure markdown>
73-
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
74-
<figcaption markdown>
75-
Browser with rtk.local
76-
</figcaption>
77-
</figure>
72+
<figure markdown>
73+
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
74+
<figcaption markdown>
75+
Browser with rtk.local
76+
</figcaption>
77+
</figure>
7878

7979

8080
## Connecting to WiFi Network

docs/connecting_bluetooth.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,53 +53,53 @@ Before proceeding, it is recommended to have the mock location provider app alre
5353

5454
To enable **Mock Locations**, *Developer Mode* in Android must be enabled. It is best to google the [most recent procedure for this](https://www.google.com/search?q=how+to+allow+mock+location+on+android) but the following procedure should work:
5555

56-
1) Open Android settings
56+
1. Open Android settings
5757

5858
<figure markdown>
5959
![alt text](./img/MockLocation/SparkFun RTK Mock Location - Settings.png)
6060
<figcaption markdown>
6161
</figcaption>
6262
</figure>
6363

64-
2) Open *About phone*
64+
2. Open *About phone*
6565

6666
<figure markdown>
6767
![Build Number box](./img/MockLocation/SparkFun RTK Mock Location - Build Number.png)
6868
<figcaption markdown>
6969
</figcaption>
7070
</figure>
7171

72-
3) Scroll to the bottom and click on *Build number* five or more times. The device will prompt as more taps are required.
72+
3. Scroll to the bottom and click on *Build number* five or more times. The device will prompt as more taps are required.
7373

7474
Once Developer Mode is enabled:
7575

76-
1) Open Android settings
76+
1. Open Android settings
7777

7878
<figure markdown>
7979
![alt text](./img/MockLocation/SparkFun RTK Mock Location - Settings.png)
8080
<figcaption markdown>
8181
</figcaption>
8282
</figure>
8383

84-
2) Open *System*
84+
2. Open *System*
8585

8686
<figure markdown>
8787
![Develop options menu](./img/MockLocation/SparkFun RTK Mock Location - Developer Options.png)
8888
<figcaption markdown>
8989
</figcaption>
9090
</figure>
9191

92-
3) Open *Developer options*
92+
3. Open *Developer options*
9393

9494
<figure markdown>
9595
![Mock Location button](./img/MockLocation/SparkFun RTK Mock Location - Select Mock Location App.png)
9696
<figcaption markdown>
9797
</figcaption>
9898
</figure>
9999

100-
4) Scroll all the way to the bottom of a very long list of developer options.
100+
4. Scroll all the way to the bottom of a very long list of developer options.
101101

102-
5) Select the app to use for Mock Location. This is usually [Lefebure](gis_software_android.md/#lefebure) or [GNSS Master](gis_software_android.md/#gnss-master) but can be tailored as needed.
102+
5. Select the app to use for Mock Location. This is usually [Lefebure](gis_software_android.md/#lefebure) or [GNSS Master](gis_software_android.md/#gnss-master) but can be tailored as needed.
103103

104104
## Apple iOS
105105

docs/correction_sources.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ To get millimeter accuracy we need to provide the RTK unit with correction value
2222

2323
These companies set up a large number of reference stations that cover entire regions and countries, but charge a monthly fee. They are often easy to use but can be expensive.
2424

25-
* [PointPerfect](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/#pointperfect-corrections) ($8/month) - US, EU, as well as parts of Australia, Brazil, and South Korea.
25+
- [PointPerfect](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/#pointperfect-corrections) ($8/month) - US, EU, as well as parts of Australia, Brazil, and South Korea.
2626

2727
!!! note
2828
This is an SSR service.
2929

30-
* [Onocoy](https://console.onocoy.com/explorer) ($25/month) - US, EU, Australia, and many other partial areas
31-
* [PointOneNav](https://app.pointonenav.com/trial?src=sparkfun) ($50/month) - US, EU, Australia, South Korea
32-
* [Skylark](https://www.swiftnav.com/skylark) ($29 to $69/month) - US, EU, Japan, Australia
33-
* [SensorCloud RTK](https://rtk.sensorcloud.com/pricing/) ($100/month) partial US, EU
34-
* [Premium Positioning](https://www.premium-positioning.com) (~$315/month) partial EU
35-
* [KeyNetGPS](https://www.keypre.com/KeynetGPS) ($375/month) North Eastern US
36-
* [Hexagon/Leica](https://hxgnsmartnet.com/en-US) ($500/month) - partial US, EU
30+
- [Onocoy](https://console.onocoy.com/explorer) ($25/month) - US, EU, Australia, and many other partial areas
31+
- [PointOneNav](https://app.pointonenav.com/trial?src=sparkfun) ($50/month) - US, EU, Australia, South Korea
32+
- [Skylark](https://www.swiftnav.com/skylark) ($29 to $69/month) - US, EU, Japan, Australia
33+
- [SensorCloud RTK](https://rtk.sensorcloud.com/pricing/) ($100/month) partial US, EU
34+
- [Premium Positioning](https://www.premium-positioning.com) (~$315/month) partial EU
35+
- [KeyNetGPS](https://www.keypre.com/KeynetGPS) ($375/month) North Eastern US
36+
- [Hexagon/Leica](https://hxgnsmartnet.com/en-US) ($500/month) - partial US, EU
3737

3838
## Public Reference Stations
3939

docs/correction_transport.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ Compatibility Icons
9191

9292
The RTK EVK has built-in cellular via a u-blox LARA-R6001D. However, the RTK Everywhere firmware does not yet support cellular. Adding it is on our roadmap. Stay tuned for updates! Meanwhile, we do have a stand-alone EVK code example which will connect to PointPerfect localized distribution via cellular:
9393

94-
* [EVK example 8_5_PointPerfect_MQTT](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_5_PointPerfect_MQTT)
95-
* [EVK example 8_6_PointPerfect_MQTT_WiFi_ETH_Cellular](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_6_PointPerfect_MQTT_WiFi_ETH_Cellular)
94+
- [EVK example 8_5_PointPerfect_MQTT](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_5_PointPerfect_MQTT)
95+
- [EVK example 8_6_PointPerfect_MQTT_WiFi_ETH_Cellular](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_6_PointPerfect_MQTT_WiFi_ETH_Cellular)
9696

9797
## L-Band
9898

0 commit comments

Comments
 (0)