Skip to content

Commit 6281eed

Browse files
Fix/apply settings (#40)
* Explicitly call out that you need to use `Apply Settings` from the main menu before quitting to actually apply the settings.
1 parent 8502e8d commit 6281eed

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

setup/basic.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ In your SSH session, run the [TurtleBot 4 setup tool](../software/turtlebot4_set
120120
turtlebot4-setup
121121
```
122122

123-
This will start the TurtleBot 4 setup tool. Navigate to the "Wi-Fi Setup" menu and configure your connection. When you have finished, save and apply the settings.
123+
This will start the TurtleBot 4 setup tool. Navigate to the "Wi-Fi Setup" menu and configure your connection. When you have finished, save the wifi settings, then
124+
return to the main menu. Select `Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.
124125

125126
<figure class="aligncenter">
126127
<img src="media/wifi_setup.gif" alt="Wi-Fi setup" style="width: 100%"/>
@@ -140,7 +141,8 @@ In your SSH session, run the [TurtleBot 4 setup tool](../software/turtlebot4_set
140141
turtlebot4-setup
141142
```
142143

143-
This will start the TurtleBot 4 setup tool. Navigate to the "Wi-Fi Setup" menu and configure your connection. When you have finished, save and apply the settings.
144+
This will start the TurtleBot 4 setup tool. Navigate to the "Wi-Fi Setup" menu and configure your connection. When you have finished, save the wifi settings, then
145+
return to the main menu. Select `Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.
144146

145147
<figure class="aligncenter">
146148
<img src="media/wifi_setup.gif" alt="Wi-Fi setup" style="width: 100%"/>
@@ -365,7 +367,8 @@ SSH into the Raspberry Pi and run the [TurtleBot 4 setup tool](../software/turtl
365367
turtlebot4-setup
366368
```
367369

368-
Go to <b>Wi-Fi Setup</b> and select <b>Apply Defaults</b>. Optionally you can set your own SSID and password before saving and applying the new settings.
370+
Go to <b>Wi-Fi Setup</b> and select <b>Apply Defaults</b>. Optionally you can set your own SSID and password before saving. Return to the main menu and select
371+
`Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.
369372

370373
{% endtab %}
371374
{% tab ap jazzy %}
@@ -376,7 +379,8 @@ SSH into the Raspberry Pi and run the [TurtleBot 4 setup tool](../software/turtl
376379
turtlebot4-setup
377380
```
378381

379-
Go to <b>Wi-Fi Setup</b> and select <b>Apply Defaults</b>. Optionally you can set your own SSID and password before saving and applying the new settings.
382+
Go to <b>Wi-Fi Setup</b> and select <b>Apply Defaults</b>. Optionally you can set your own SSID and password before saving. Return to the main menu and select
383+
`Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.
380384

381385
{% endtab %}
382386
{% endtabs %}

software/turtlebot4_setup.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,10 @@ You will be greeted by a menu with several submenus. From here you can navigate
246246
<br/>
247247
<u><b style="font-size: 20px;">Usage</b></u>
248248

249+
```warning
250+
You _must_ select the `Apply Settings` option and press `Enter` before quitting to apply any changes you have made to the robot. Quitting without applying the settings will discard any changes you have staged.
251+
```
252+
249253
You can navigate up and down between the menus by using the `up` and `down` arrow keys, or `j` and `k`. To select a menu,
250254
press `Enter`. To return or exit from a menu, you can press `q`, `Esc`, or `CTRL+C`. Some menus may only be exited with `CTRL+C`.
251255

@@ -573,6 +577,10 @@ You will be greeted by a menu with several submenus. From here you can navigate
573577
<br/>
574578
<u><b style="font-size: 20px;">Usage</b></u>
575579

580+
```warning
581+
You _must_ select the `Apply Settings` option and press `Enter` before quitting to apply any changes you have made to the robot. Quitting without applying the settings will discard any changes you have staged.
582+
```
583+
576584
You can navigate up and down between the menus by using the `up` and `down` arrow keys, or `j` and `k`. To select a menu,
577585
press `Enter`. To return or exit from a menu, you can press `q`, `Esc`, or `CTRL+C`. Some menus may only be exited with `CTRL+C`.
578586

0 commit comments

Comments
 (0)