Skip to content

Fix/apply settings #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 14, 2025
Merged

Fix/apply settings #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
825fce2
Explicitly call out that you need to use `Apply Settings` from the ma…
civerachb-cpr Jul 31, 2025
daf668a
Remove a line-break that resulted in word concatenation
civerachb-cpr Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions setup/basic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ In your SSH session, run the [TurtleBot 4 setup tool](../software/turtlebot4_set
turtlebot4-setup
```

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.
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
return to the main menu. Select `Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.

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

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.
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
return to the main menu. Select `Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.

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

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.
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
`Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.

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

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.
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
`Apply Settings` and press `Enter` before quitting the `turtlebot4-setup` tool.

{% endtab %}
{% endtabs %}
Expand Down
8 changes: 8 additions & 0 deletions software/turtlebot4_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,10 @@ You will be greeted by a menu with several submenus. From here you can navigate
<br/>
<u><b style="font-size: 20px;">Usage</b></u>

```warning
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.
```

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,
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`.

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

```warning
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.
```

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,
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`.

Expand Down