Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/_static/shutdown/shutdown_GUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/shutdown/turnedOffRaspberry.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 89 additions & 1 deletion docs/driving/connecting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,32 @@ Example:

|


.. .. important::
Comment thread
paemlaban marked this conversation as resolved.

.. This step will cause the terminal to become unresponsive.
.. This is expected behavior, as the connection is switching from the robot's Wi-Fi network to the local network.

.. You may safely close the terminal once it stops responding.

.. .. note::

.. This step will cause the terminal to become unresponsive.
.. This is expected behavior, as the connection is switching from the robot's Wi-Fi network to the local network.

.. You may safely close the terminal once it stops responding.

.. tip::

If the robot cannot find your local network, first list nearby Wi-Fi networks from the robot:

.. code-block:: bash

nmcli device wifi list

If your local Wi-Fi (SSID) does not appear in the list, restart the robot and try the connection process again.


3. Find the robot's new IP address on your router (hostname: ``ubiquityrobotXXXX``).

You can find the robot's IP address in two ways:
Expand All @@ -144,7 +170,11 @@ You can find the robot's IP address in two ways:

a. **Method 1 - Router Settings**

If you know your router credentials, first determine your default gateway by running the following command in a local terminal:
If you know your router credentials, first determine your default gateway.

**For Linux/Mac:**

Run the following command in a local terminal:

.. code-block:: bash

Expand All @@ -156,6 +186,18 @@ You should see an output similar to:

default via 192.168.1.1

**For Windows:**

Open PowerShell or Command Prompt and run:

.. code-block:: bash

ipconfig

Look for ``Default Gateway`` under your active network adapter.

**For all platforms:**

The IP address shown is your default gateway.
Enter this IP into your web browser to open the router login page.

Expand All @@ -173,6 +215,8 @@ For reference, our connected devices sections looks like this (your interface ma

b. **Method 2 - Using** ``nmap``

**For Linux/Mac:**

First, install ``nmap``:

.. code-block:: bash
Expand Down Expand Up @@ -205,6 +249,50 @@ Run the following command:

nmap -sn <IP>/<MASK>

**For Windows:**

First, download and install ``nmap`` from `nmap.org <https://nmap.org/download.html>`_.

**Step 1: Find your network information**

Open PowerShell or Command Prompt and run:

.. code-block:: bash

ipconfig

Look for your active network adapter (usually Ethernet or Wi-Fi) with the following information:

- **IPv4 Address:** Your computer's IP on the network (e.g., ``192.168.1.100``)
- **Subnet Mask:** Defines the network range (e.g., ``255.255.255.0``)

**Step 2: Convert the subnet mask to CIDR notation**

The subnet mask ``255.255.255.0`` corresponds to ``/24`` in CIDR notation. Here's a quick reference:

- ``255.255.255.0`` = ``/24`` (most common)
- ``255.255.0.0`` = ``/16``
- ``255.0.0.0`` = ``/8``

**Step 3: Calculate your network address**

For a typical ``/24`` network, replace the last number in your IP address with ``.0``:

- Your IP: ``192.168.1.100``
- Network address: ``192.168.1.0/24``

**Step 4: Run nmap**

Now scan your network to find connected devices:

.. code-block:: bash

nmap -sn 192.168.1.0/24

Replace ``192.168.1.0/24`` with your actual network address calculated in Step 3.

**For all platforms:**

This scans your network and returns a list of connected devices along with their IP addresses.
Look for the hostname ``ubiquityrobotXXXXX``.

Expand Down
44 changes: 44 additions & 0 deletions docs/driving/shutdown.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Shutting Down the Robot
=======================

Step 1: Choose Shutdown Method
##############################

You can shut down the robot either from the GUI or from a terminal session connected to the robot.

Method 1: Shutdown from GUI
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Comment thread
paemlaban marked this conversation as resolved.

.. image:: /_static/shutdown/shutdown_GUI.png
:alt: Shutdown from GUI
:width: 600px
:align: center

|
Method 2: Shutdown from Terminal
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Comment thread
paemlaban marked this conversation as resolved.

Open a terminal session connected to the robot (see :doc:`./connecting` for details) and run:

.. code-block:: bash
sudo shutdown -h now
Step 2: Wait for Shutdown Complete
###################################

After issuing the shutdown command or selecting the shutdown option from the GUI, wait until the Raspberry Pi LED turns red.
This indicates the system has fully shut down and all data has been safely written.

.. image:: /_static/shutdown/turnedOffRaspberry.jpg
:alt: Raspberry Pi LED turned red (shutdown complete)
:width: 600px
:align: center

|
Step 3: Power Off the Robot
############################

Once the Raspberry Pi LED is red, turn the robot off using the on/off switch.
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ Sections
driving/connecting
driving/teleop
driving/ez_map_simple_drive
driving/shutdown


.. _ez_map:
Expand Down Expand Up @@ -118,6 +119,7 @@ Sections
:maxdepth: 2
:caption: Let's get Technical

troubleshooting/quick_tips
troubleshooting/hardware/lidars
troubleshooting/hardware/rpi
troubleshooting/hardware/pi_camera
Expand Down
33 changes: 33 additions & 0 deletions docs/troubleshooting/quick_tips.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Quick Troubleshooting Tips
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like having a quick troubleshooting section. However, for now we only added specific troubleshooting steps inside the explanation pages.

Do you think having a separate troubleshooting section with drop-downs should be added?
If yes, then I wouldn't use raw html here. "Sphinx" - the documentation library that we are using, already has an extension called "sphinx-design" that does this>

Here is how it looks by default:

Image

When it is opened:

Image

I can add this for you guys in the next PR, and then we can discuss how we would like to use it.

Copy link
Copy Markdown
Collaborator

@Paveljolak Paveljolak Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And the code is pretty simple:

.. dropdown:: **On/off switch is not working**

   The issue may be caused by an intermittent internal hardware contact.
   Try pressing the switch firmly, or give the switch area a light tap.

So you would mitigate all of this raw html stuff.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think troubleshooting section would be useful.

==========================

If you run into common startup or connectivity issues, try the following quick fixes.

Magni 6 Mini
############

.. raw:: html

<details>
<summary><strong>On/off switch is not working</strong></summary>
<p>The issue may be caused by an intermittent internal hardware contact. Try pressing the switch firmly, or give the switch area a light tap.</p>
</details>

.. raw:: html

<details>
<summary><strong>Motors/robot are not moving</strong></summary>
<p>Restart the robot and test movement again.</p>
Comment thread
paemlaban marked this conversation as resolved.
</details>

General
#######

.. raw:: html

<details>
<summary><strong>Robot cannot find the local network</strong></summary>
<p>First, list nearby Wi-Fi networks from the robot:</p>
<pre><code>nmcli device wifi list</code></pre>
<p>If your local Wi-Fi (SSID) does not appear in the list, restart the robot and try connecting again.</p>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this really work? What if it doesn't?

There are few steps that you can do to set up the NetworkManager of the robot to look for certain wifi's. I would add these steps.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was working for me. Can you add these another steps? I am not experienced with NetworkManager on Linux.

</details>