Skip to content

Commit 3df0bbd

Browse files
authored
Merge pull request #434 from sparkfun/EVK_docs
EVK docs
2 parents 3498888 + e99b9e4 commit 3df0bbd

6 files changed

+21
-18
lines changed

docs/configure_with_ethernet.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22

33
Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png)
44

5-
![SparkFun RTK WiFi Configuration Interface](<img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png>)
6-
7-
*SparkFun RTK WiFi Configuration Interface*
8-
95
During Ethernet configuration, the RTK device will present a webpage that is viewable from a desktop/laptop connected to the local network.
106

11-
![Desktop vs Phone display size configuration](<img/WiFi Config/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg>)
7+
![SparkFun RTK Ethernet Configuration Interface](<img/WiFi Config/SparkFun RTK Ethernet Config - Main Interface.png>)
128

13-
*Desktop vs Phone display size configuration*
9+
*SparkFun RTK Ethernet Configuration Interface*
1410

1511
## RTK EVK
1612

@@ -19,28 +15,35 @@ To get into Ethernet configuration follow these steps:
1915
1. Power on the RTK EVK and connect it to your Ethernet network using the supplied cable
2016
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.
2117

22-
![SparkFun RTK EVK Mode Menu](<img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
18+
![SparkFun RTK EVK Mode Menu](<img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
2319

2420
*SparkFun RTK EVK Mode Menu*
2521

2622
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.
23+
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.
24+
25+
![SparkFun RTK EVK Config Ethernet](<img/Displays/SparkFun RTK EVK Ethernet Config.png>)
26+
27+
*SparkFun RTK EVK Config Ethernet*
28+
2829
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.
2930

30-
![Browser with rtk.local address](<img/WiFi Config/SparkFun RTK WiFi Config - Browser rtk local.png>)
31+
![SparkFun RTK Ethernet Configuration Interface](<img/WiFi Config/SparkFun RTK Ethernet Config - Main Interface.png>)
3132

32-
*Browser with rtk.local*
33+
*SparkFun RTK Ethernet Configuration Interface*
3334

3435
## File Manager
3536

3637
![List of files in file manager](<img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png>)
3738

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+
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.
3940

4041
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
4142

4243
## Saving and Exit
4344

4445
![Save and Exit buttons](<img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png>)
4546

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.
47+
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 Ethernet configuration and return to whichever mode was selected in the **System Configuration** tab **System Initial State** drop-down (Base, Rover or NTP).
48+
49+
It is also possible to exit Configure-Via-Ethernet mode by: clicking the Mode button on the front panel; or by opening the serial menu and selecting 'r'.

docs/configure_with_wifi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To get into WiFi configuration follow these steps:
3535
1. Ensure the WiFi / Bluetooth antenna is attached, then connect the RTK EVK to a power source.
3636
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.
3737

38-
![SparkFun RTK EVK Mode Menu](<img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
38+
![SparkFun RTK EVK Mode Menu](<img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
3939

4040
*SparkFun RTK EVK Mode Menu*
4141

@@ -59,7 +59,7 @@ Note: Upon connecting, your phone may warn you that this WiFi network has no int
5959

6060
*Connected to the RTK WiFi Setup Page*
6161

62-
Clicking on the category 'carrot' will open or close that section. Clicking on an ‘i’ will give you a brief description of the options within that section.
62+
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.
6363

6464
![Firmware highlighted](<img/WiFi Config/SparkFun RTK WiFi Config - Header Firmware Version.png>)
6565

@@ -71,12 +71,12 @@ Please note that the firmware for the RTK device and the firmware for the GNSS r
7171

7272
![List of files in file manager](<img/WiFi Config/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png>)
7373

74-
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.
74+
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.
7575

7676
Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
7777

7878
## Saving and Exit
7979

8080
![Save and Exit buttons](<img/WiFi Config/SparkFun RTK WiFi Config - Save Steps.png>)
8181

82-
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 return to standard Rover mode.
82+
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).
99.3 KB
Loading
44.9 KB
Loading

docs/quickstart-evk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,15 +124,15 @@ One of the great features of the RTK EVK is that it has the ability to get corre
124124

125125
*PointPerfect Coverage map including L-Band and IP delivery methods*
126126

127-
The PointPerfect IP service is available for various areas of the globe including the contiguous US, EU, South Korea, as well as parts of Brazil, Australia, and Canada. See the [coverage map](https://www.u-blox.com/en/pointperfect-service-coverage) for specifics; the RTK EVK is compatible with all areas as it supports both L-Band and IP coverage).
127+
The PointPerfect IP service is available for various areas of the globe including the contiguous US, EU, South Korea, as well as parts of Brazil, Australia, and Canada. See the [coverage map](https://www.u-blox.com/en/pointperfect-service-coverage) for specifics; the RTK EVK is compatible with all areas as it supports both L-Band and IP coverage.
128128

129129
Steps to use PointPerfect:
130130

131131
1. [Register](https://www.sparkfun.com/rtk_evk_registration) the device with SparkFun by entering the device ID (this is the ID seen on the [printed stickers](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#registration) included in the kit). It can take up to two business days for registration to complete.
132132

133133
2. 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.
134134

135-
![SparkFun RTK EVK Mode Menu](<img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
135+
![SparkFun RTK EVK Mode Menu](<img/Displays/24342-RTK-EVK-Action-Screen_GIF_750ms.gif>)
136136

137137
*SparkFun RTK EVK Mode Menu*
138138

0 commit comments

Comments
 (0)