Skip to content

Commit b747a7d

Browse files
authored
Merge pull request #433 from sparkfun/EVK_docs
Add configure_with_ethernet
2 parents d509372 + cb3204a commit b747a7d

File tree

4 files changed

+70
-3
lines changed

4 files changed

+70
-3
lines changed

docs/configure_with_ethernet.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Configure with Ethernet
2+
3+
Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
4+
5+
![SparkFun RTK WiFi Configuration Interface](<img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png>)
6+
7+
*SparkFun RTK WiFi Configuration Interface*
8+
9+
During Ethernet configuration, the RTK device will present a webpage that is viewable from a desktop/laptop connected to the local network.
10+
11+
![Desktop vs Phone display size configuration](<img/WiFi Config/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg>)
12+
13+
*Desktop vs Phone display size configuration*
14+
15+
## RTK EVK
16+
17+
To get into Ethernet configuration follow these steps:
18+
19+
1. Power on the RTK EVK and connect it to your Ethernet network using the supplied cable
20+
2. Once the device has started, put the RTK EVK into Ethernet 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 Eth** is highlighted, then do a quick double-click to select it. Note that it is only possible to put the EVK into this mode via the Mode button, requiring physical access to the EVK. Remote configuration is only possible after putting the EVK into this mode.
21+
22+
![SparkFun RTK EVK Mode Menu](<img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
23+
24+
*SparkFun RTK EVK Mode Menu*
25+
26+
3. The RTK EVK will reboot into a dedicated Configure-Via-Ethernet mode
27+
4. By default, the RTK EVK uses DHCP, obtaining its IP address from your DHCP server. The IP address is displayed on the OLED display. You can use a fixed IP address if desired; see [Ethernet Menu](menu_ethernet.md) for more details.
28+
5. Open a browser (Chrome is preferred) on your computer and type the EVK's IP address into the address bar. The web config page will open.
29+
30+
![Browser with rtk.local address](<img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png>)
31+
32+
*Browser with rtk.local*
33+
34+
## File Manager
35+
36+
![List of files in file manager](<img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png>)
37+
38+
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. And files may be uploaded to the SD card if needed.
39+
40+
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
41+
42+
## Saving and Exit
43+
44+
![Save and Exit buttons](<img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png>)
45+
46+
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 to Rover Mode’ at which point the unit will exit WiFi configuration and reboot into standard Rover mode.

docs/configure_with_wifi.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,27 @@ To get into WiFi configuration follow these steps:
2626

2727
*Browser with rtk.local*
2828

29+
Continue with [Connecting to WiFi network](#connecting-to-wifi-network).
30+
31+
## RTK EVK
32+
33+
To get into WiFi configuration follow these steps:
34+
35+
1. Ensure the WiFi / Bluetooth antenna is attached, then connect the RTK EVK to a power source.
36+
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.
37+
38+
![SparkFun RTK EVK Mode Menu](<img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
39+
40+
*SparkFun RTK EVK Mode Menu*
41+
42+
3. The display will change, showing that the EVK is in WiFi configuration mode.
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+
![Browser with rtk.local address](<img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png>)
47+
48+
*Browser with rtk.local*
49+
2950
## Connecting to WiFi Network
3051

3152
![Discovered WiFi networks](<img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Networks.jpg>)

docs/quickstart-evk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Are you using [Android](#android) or [iOS](#ios)?
4343

4444
5. Once paired, open SW Maps. Select ‘New Project’ and give your project a name like ‘RTK Project’.
4545

46-
6. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the ‘EVK Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom left corner (Figure 4). SW Maps will show a warning that the instrument height is 0m. That’s ok.
46+
6. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the ‘EVK Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom right corner (Figure 4). SW Maps will show a warning that the instrument height is 0m. That’s ok.
4747

4848
![SW Map list of Bluetooth devices](<img/QuickStart/SparkFun Torch - SW Maps Bluetooth Small.png>)
4949

@@ -172,4 +172,4 @@ After the reboot, the device will connect to WiFi using your credentials. If you
172172

173173
* The location reported by the RTK device is the location of the antenna element. Lat and Long are fairly easy to obtain but if you're capturing altitude be sure to do additional reading on ARPs (antenna reference points) and how to account for the antenna height in your data collection software.
174174

175-
* An internet connection is required for most types of RTK. RTCM corrections can be transmitted over other types of connections (such as serial telemetry radios). The RTK EVK also supports PointPerfect L-Band through the built-in NEO-D9S corrections receiver. The L-Band corrections are encrypted and keys are required but, once your unit has them, corrections will be available for up to eight weeks. See [Correction Transport](correction_transport.md) for more details.
175+
* An internet connection is required for most types of RTK. RTCM corrections can be transmitted over other types of connections (such as serial telemetry radios). The RTK EVK also supports PointPerfect L-Band geostationary satellite corrections through the built-in NEO-D9S corrections receiver. The L-Band corrections are encrypted and keys are required but, once your unit has them, corrections will be available for up to eight weeks. See [Correction Transport](correction_transport.md) for more details.

docs/quickstart-torch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Are you using [Android](#android) or [iOS](#ios)?
3636

3737
6. Once paired, open SW Maps. Select ‘New Project’ and give your project a name like ‘RTK Project’.
3838

39-
7. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the ‘Torch Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom left corner (Figure 4). SW Maps will show a warning that the instrument height is 0m. That’s ok.
39+
7. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the ‘Torch Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom right corner (Figure 4). SW Maps will show a warning that the instrument height is 0m. That’s ok.
4040

4141
![SW Map list of Bluetooth devices](<img/QuickStart/SparkFun Torch - SW Maps Bluetooth Small.png>)
4242

0 commit comments

Comments
 (0)