Skip to content

Commit f46c02f

Browse files
committed
Docs: Rework Configure with Browser
1 parent befcde4 commit f46c02f

8 files changed

+202
-155
lines changed

docs/configure_with_browser.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# Configure with Browser
2+
3+
<!--
4+
Compatibility Icons
5+
====================================================================================
6+
7+
:material-radiobox-marked:{ .support-full title="Feature Supported" }
8+
:material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
9+
:material-radiobox-blank:{ .support-none title="Feature Not Supported" }
10+
-->
11+
12+
<div class="grid cards fill" markdown>
13+
14+
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
15+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
16+
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
17+
18+
</div>
19+
20+
<figure markdown>
21+
![SparkFun RTK WiFi Configuration Interface](./img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png)
22+
<figcaption markdown>
23+
SparkFun RTK WiFi Configuration Interface
24+
</figcaption>
25+
</figure>
26+
27+
During browser configuration, the RTK device will present a webpage that is viewable from a desktop, laptop, or cell phone. This is available over WiFi for all devices and ethernet for some (RTK EVK only). For advanced configurations, a desktop is recommended. For quick in-field changes, a cell phone works great.
28+
29+
<figure markdown>
30+
![Desktop vs Phone display size configuration](./img/WiFi Config/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg)
31+
<figcaption markdown>
32+
Desktop vs Phone display size configuration
33+
</figcaption>
34+
</figure>
35+
36+
## RTK EVK
37+
38+
To get into browser configuration follow these steps:
39+
40+
1. Ensure that an ethernet cable is plugged in and/or the WiFi / Bluetooth antenna is attached, then connect the RTK EVK to a power source.
41+
42+
<figure markdown>
43+
![SparkFun RTK EVK Mode Menu](./img/Displays/SparkFun_RTK_Postcard_Config.png)
44+
<figcaption markdown>
45+
SparkFun RTK EVK Mode Menu
46+
</figcaption>
47+
</figure>
48+
49+
2. Once the device has started, put the RTK EVK into WiFi config mode by clicking the Mode button on the front panel. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Config** is highlighted, then do a quick double-click to select it.
50+
51+
3. The display will change, showing that the EVK is in configuration mode.
52+
53+
4. If connecting over ethernet, open a browser and connect to the IP address shown on the display.
54+
55+
<figure markdown>
56+
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
57+
<figcaption markdown>
58+
Browser with rtk.local
59+
</figcaption>
60+
</figure>
61+
62+
5. If connecting over WiFi, then connect to WiFi network named ‘RTK Config’. 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.
63+
64+
!!! note
65+
Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
66+
67+
## RTK Postcard
68+
69+
To get into browser configuration follow these steps:
70+
71+
1. Connect the RTK Postcard to a power source.
72+
73+
<figure markdown>
74+
![SparkFun RTK EVK Mode Menu](./img/Displays/SparkFun_RTK_Postcard_Config.png)
75+
<figcaption markdown>
76+
SparkFun RTK EVK Mode Menu
77+
</figcaption>
78+
</figure>
79+
80+
2. Once the device has started, put the RTK Postcard into browser config mode by clicking down on the directional pad. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Config** is highlighted, then press the center of the directional pad to select it.
81+
82+
3. The display will change, showing that the device is in configuration mode.
83+
84+
4. Connect to the WiFi network named ‘RTK Config’.
85+
86+
!!! note
87+
Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
88+
89+
90+
<figure markdown>
91+
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
92+
<figcaption markdown>
93+
Browser with rtk.local
94+
</figcaption>
95+
</figure>
96+
97+
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.
98+
99+
## RTK Torch
100+
101+
To get into browser configuration follow these steps:
102+
103+
1. Power on the RTK Torch
104+
2. Once the device has started press the Power Button twice within 1 second (double tap).
105+
3. The device will beep twice indicating it is waiting for incoming connections.
106+
107+
4. Connect to WiFi network named ‘RTK Config’.
108+
109+
!!! note
110+
Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
111+
112+
<figure markdown>
113+
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
114+
<figcaption markdown>
115+
Browser with rtk.local
116+
</figcaption>
117+
</figure>
118+
119+
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.
120+
121+
Continue with [Connecting to WiFi network](#connecting-to-wifi-network).
122+
123+
## Connecting to WiFi Network
124+
125+
<figure markdown>
126+
![Discovered WiFi networks](./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Networks.jpg)
127+
<figcaption markdown>
128+
The WiFi network RTK Config as seen from a cellphone
129+
</figcaption>
130+
</figure>
131+
132+
!!! note
133+
Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
134+
135+
<figure markdown>
136+
![Webpage showing the RTK Configuration options](./img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png)
137+
<figcaption markdown>
138+
Connected to the RTK WiFi Setup Page
139+
</figcaption>
140+
</figure>
141+
142+
Clicking on the category tab will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section.
143+
144+
<figure markdown>
145+
![Firmware highlighted](./img/WiFi Config/SparkFun RTK WiFi Config - Header Firmware Version.png)
146+
<figcaption markdown>
147+
This unit has firmware version 1.0 and a UM980 GNSS receiver
148+
</figcaption>
149+
</figure>
150+
151+
The firmware for the RTK device and the firmware for the GNSS receiver is shown at the top of the page. This can be helpful when troubleshooting or requesting new features.
152+
153+
## File Manager
154+
155+
<figure markdown>
156+
![List of files in file manager](./img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png)
157+
<figcaption markdown>
158+
</figcaption>
159+
</figure>
160+
161+
On devices that support an external SD card, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. Files may be uploaded to the SD card if needed.
162+
163+
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
164+
165+
## Saving and Exit
166+
167+
<figure markdown>
168+
![Save and Exit buttons](./img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png)
169+
<figcaption markdown>
170+
</figcaption>
171+
</figure>
172+
173+
Once settings are input, please press ‘Save Configuration’. This will validate any settings, show any errors that need adjustment, and send the settings to the unit. The page will remain active until the user presses ‘Exit and Reset’ at which point the unit will exit WiFi configuration and return to whichever mode was selected in the **System Configuration** tab **System Initial State** drop-down (Base, Rover or NTP).

docs/configure_with_wifi.md

Lines changed: 1 addition & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -1,156 +1,3 @@
11
# Configure with WiFi
22

3-
<!--
4-
Compatibility Icons
5-
====================================================================================
6-
7-
:material-radiobox-marked:{ .support-full title="Feature Supported" }
8-
:material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
9-
:material-radiobox-blank:{ .support-none title="Feature Not Supported" }
10-
-->
11-
12-
<div class="grid cards fill" markdown>
13-
14-
- EVK: :material-radiobox-marked:{ .support-full title="Feature Supported" }
15-
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
16-
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
17-
18-
</div>
19-
20-
<figure markdown>
21-
![SparkFun RTK WiFi Configuration Interface](./img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png)
22-
<figcaption markdown>
23-
SparkFun RTK WiFi Configuration Interface
24-
</figcaption>
25-
</figure>
26-
27-
During WiFi configuration, the RTK device will present a webpage that is viewable from either a desktop/laptop with WiFi or a cell phone. For advanced configurations, a desktop is recommended. For quick in-field changes, a cell phone works great.
28-
29-
<figure markdown>
30-
![Desktop vs Phone display size configuration](./img/WiFi Config/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg)
31-
<figcaption markdown>
32-
Desktop vs Phone display size configuration
33-
</figcaption>
34-
</figure>
35-
36-
## RTK Torch
37-
38-
To get into WiFi configuration follow these steps:
39-
40-
1. Power on the RTK Torch
41-
2. Once the device has started press the Power Button twice within 1 second (double tap).
42-
3. The display will beep twice indicating it is waiting for incoming connections.
43-
4. Connect to WiFi network named ‘RTK Config’.
44-
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.
45-
46-
<figure markdown>
47-
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
48-
<figcaption markdown>
49-
Browser with rtk.local
50-
</figcaption>
51-
</figure>
52-
53-
Continue with [Connecting to WiFi network](#connecting-to-wifi-network).
54-
55-
## RTK EVK
56-
57-
To get into WiFi configuration follow these steps:
58-
59-
1. Ensure the WiFi / Bluetooth antenna is attached, then connect the RTK EVK to a power source.
60-
2. Once the device has started, put the RTK EVK into WiFi config mode by clicking the Mode button on the front panel. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Cfg WiFi** is highlighted, then do a quick double-click to select it.
61-
62-
<figure markdown>
63-
![SparkFun RTK EVK Mode Menu](./img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif)
64-
<figcaption markdown>
65-
SparkFun RTK EVK Mode Menu
66-
</figcaption>
67-
</figure>
68-
69-
3. The display will change, showing that the EVK is in WiFi configuration mode.
70-
4. Connect to WiFi network named ‘RTK Config’.
71-
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.
72-
73-
<figure markdown>
74-
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
75-
<figcaption markdown>
76-
Browser with rtk.local
77-
</figcaption>
78-
</figure>
79-
80-
## RTK Postcard
81-
82-
To get into WiFi configuration follow these steps:
83-
84-
1. Connect the RTK Postcard to a power source.
85-
2. Once the device has started, put the RTK Postcard into WiFi config mode by clicking down on the directional pad. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Cfg WiFi** is highlighted, then press the center of the directional pad to select it.
86-
87-
<figure markdown>
88-
![SparkFun RTK EVK Mode Menu](./img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif)
89-
<figcaption markdown>
90-
SparkFun RTK EVK Mode Menu
91-
</figcaption>
92-
</figure>
93-
94-
3. The display will change, showing that the device is in WiFi configuration mode.
95-
4. Connect to WiFi network named ‘RTK Config’.
96-
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.
97-
98-
<figure markdown>
99-
![Browser with rtk.local address](./img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png)
100-
<figcaption markdown>
101-
Browser with rtk.local
102-
</figcaption>
103-
</figure>
104-
105-
## Connecting to WiFi Network
106-
107-
<figure markdown>
108-
![Discovered WiFi networks](./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Networks.jpg)
109-
<figcaption markdown>
110-
The WiFi network RTK Config as seen from a cellphone
111-
</figcaption>
112-
</figure>
113-
114-
!!! note
115-
Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
116-
117-
<figure markdown>
118-
![Webpage showing the RTK Configuration options](./img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png)
119-
<figcaption markdown>
120-
Connected to the RTK WiFi Setup Page
121-
</figcaption>
122-
</figure>
123-
124-
Clicking on the category tab will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section.
125-
126-
<figure markdown>
127-
![Firmware highlighted](./img/WiFi Config/SparkFun RTK WiFi Config - Header Firmware Version.png)
128-
<figcaption markdown>
129-
This unit has firmware version 1.0 and a UM980 GNSS receiver
130-
</figcaption>
131-
</figure>
132-
133-
!!! note
134-
The firmware for the RTK device and the firmware for the GNSS receiver is shown at the top of the page. This can be helpful when troubleshooting or requesting new features.
135-
136-
## File Manager
137-
138-
<figure markdown>
139-
![List of files in file manager](./img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png)
140-
<figcaption markdown>
141-
</figcaption>
142-
</figure>
143-
144-
On devices that support an external SD card, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. Files may be uploaded to the SD card if needed.
145-
146-
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
147-
148-
## Saving and Exit
149-
150-
<figure markdown>
151-
![Save and Exit buttons](./img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png)
152-
<figcaption markdown>
153-
</figcaption>
154-
</figure>
155-
156-
Once settings are input, please press ‘Save Configuration’. This will validate any settings, show any errors that need adjustment, and send the settings to the unit. The page will remain active until the user presses ‘Exit and Reset’ at which point the unit will exit WiFi configuration and return to whichever mode was selected in the **System Configuration** tab **System Initial State** drop-down (Base, Rover or NTP).
3+
This has been renamed and updated. Please see [Configure with Browser](configure_with_browser.md) for the latest.
91.6 KB
Loading
112 KB
Loading
111 KB
Loading
28.1 KB
Loading

docs/menu_base.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,33 @@ These coordinate formats are automatically detected and converted as needed. The
174174

175175
For more information about coordinate formats, check out this [online converter](https://www.earthpoint.us/convert.aspx).
176176

177+
## Base Cast
178+
179+
<figure markdown>
180+
![SparkFun RTK EVK Mode Menu](./img/Displays/SparkFun_RTK_Postcard_BaseCasting.png)
181+
<figcaption markdown>
182+
SparkFun RTK EVK Mode Menu
183+
</figcaption>
184+
</figure>
185+
186+
Base Cast mode enables the following settings:
187+
188+
* Enables Base mode
189+
* Enables NTRIP Caster mode
190+
* Enables TCP on port 2101
191+
* Enables WiFi AP mode on IP 192.168.4.1
192+
193+
This is helpful when using the RTK device in conjunction with a drone controller that expects connectivity to a near by Base over WiFi. All of these settings can be set manually; Base Cast mode just provides an easy and quick way to put the RTK device into the default mode compatible with most drone controllers.
194+
195+
<figure markdown>
196+
![SparkFun RTK EVK Mode Menu](./img/Displays/SparkFun_RTK_Postcard_BaseCast.png)
197+
<figcaption markdown>
198+
SparkFun RTK EVK Mode Menu
199+
</figcaption>
200+
</figure>
201+
202+
This mode can be entered from the [System Menu](menu_system.md), using the display menu (if a display is attached), or by setting the *System Initial State* to **BaseCast* via [Browser Config](configure_with_browswer).
203+
177204
## Assisted Base
178205

179206
An Assisted Base is where a temporary base is set up to Survey-In its location but is simultaneously provided RTCM corrections so that its Survey-In is done with very precise readings. An assisted base running a Survey-In removes much of the relative inaccuracies from a Rover-Base system. We've found an Assisted Base varies as little as 50mm RMS between intra-day tests, with accuracy within 65mm of a PPP of the same location, same day.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,12 +413,12 @@ nav:
413413
- gis_software_windows.md
414414
- Configuration Methods:
415415
- configure_with_bluetooth.md
416+
- configure_with_browser.md
416417
- configure_with_cli.md
417418
- configure_with_ethernet.md
418419
- configure_with_serial.md
419420
- configure_with_settings_file.md
420421
- configure_with_ucenter.md
421-
- configure_with_wifi.md
422422
- Configuration Menus:
423423
- menu_base.md
424424
- menu_corrections_priorities.md

0 commit comments

Comments
 (0)