Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
45569e6
Adding Zenoh Setup to the workstation.
Paveljolak Dec 17, 2025
f865ad4
Added some questions and todos.
Paveljolak Dec 17, 2025
de501ca
doc: Update Zenoh Setup with ROS_DOMAIN_ID and remove redundant insta…
michael545 Dec 24, 2025
119daf1
Merge pull request #46 from UbiquityRobotics/feature/jazzy-devel-addi…
michael545 Dec 24, 2025
cee16da
Adding Open RMF documentation to Jazzy Devel.
Paveljolak Feb 1, 2026
b043f99
quick rever of the conf.py
Paveljolak Feb 1, 2026
a7d165d
Merge pull request #47 from UbiquityRobotics/feature/jazzy-devel-open…
ATemova Feb 1, 2026
8068fdd
Adding the README, conf.py, and conf.py.orig changes from main. (#49)
Paveljolak Feb 2, 2026
18e1a34
Fixing headers, adding connecting and teleop updates from jazzy to ja…
Paveljolak Feb 12, 2026
8dee389
Feature/jazzy devel updating teleop command and connecting info (#53)
Paveljolak Mar 22, 2026
bb8e0f0
Changing Open-RMF stuff to OdinFleet.
Paveljolak Mar 22, 2026
3593eb7
Additional clean-up forgotten from the previous commit.
Paveljolak Mar 22, 2026
d2d20bc
Updated odinfleet documentation to follow our software and not be vague.
Paveljolak Apr 14, 2026
a68112f
Fixed inaccurate links to OpenRMF and OpenRMF Docs.
Paveljolak Apr 14, 2026
2d76292
docs: add Magni 6 MIDI unboxing guide with battery safety and install…
michael545 Apr 15, 2026
603e7b8
Merge pull request #61 from UbiquityRobotics/feature/unboxing-midi-docs
michael545 Apr 15, 2026
a9c7e27
docs: add note about FASTON terminal sizes to unboxing guides
michael545 Apr 17, 2026
534c7dc
Merge pull request #62 from UbiquityRobotics/feature/unboxing-midi-docs
michael545 Apr 17, 2026
3acb669
Merge pull request #60 from UbiquityRobotics/feature/jazzy-devel-upda…
ATemova Apr 19, 2026
143d683
Feature/jazzy devel updating odinfleet documentation (#64)
Paveljolak Apr 20, 2026
b2a1e58
General docs update (#65)
paemlaban Apr 21, 2026
625de1a
Merge branch 'jazzy' into jazzy-devel
davecrawley Apr 23, 2026
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
5 changes: 2 additions & 3 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,15 @@ The site hosts technical documentation for Ubiquity Robotics robots, covering ha

The documentation is built and deployed automatically using GitHub Actions. The latest version is available at:

<!-- TODO: Change this to the actual website when the repo is switched. -->
**[https://paveljolak.github.io/learn2/](https://paveljolak.github.io/learn2/)**
**[https://learn2.ubiquityrobotics.com/jazzy/](https://learn2.ubiquityrobotics.com/jazzy/)**

## Local Development

To build and run the documentation locally:

<!-- TODO: Add the right links and names for cloning the repository. -->
```bash
git clone https://github.com/Paveljolak/learn2.git
git clone https://github.com/UbiquityRobotics/learn2.git
cd learn2
git fetch --all
git branch -a
Expand Down
Binary file added docs/_static/odin_fleet/config_page.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/odin_fleet/dashboard_page.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/odin_fleet/deleting_queued_tasks.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/odin_fleet/diagnostics_page.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/odin_fleet/dispatching_task.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/odin_fleet/feedback_page.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/odin_fleet/map_visualization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/odin_fleet/robot_card_idle.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/odin_fleet/robot_card_in_transit.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/odin_fleet/robot_decomission.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/odin_fleet/robots_list.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/odin_fleet/task_cancelation.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/odin_fleet/task_delivery.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/odin_fleet/task_dispatched.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/odin_fleet/task_gotoplace.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/odin_fleet/task_patrol.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/odin_fleet/task_queue_bin.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/odin_fleet/tasks_list.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/odin_fleet/tasks_queue.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/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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/unboxing/battery_bay_brackets.jpg
Binary file added docs/_static/unboxing/battery_type.jpg
Binary file added docs/_static/unboxing/snapshot_1773415303723.jpg
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
# -- General configuration ---------------------------------------------------
extensions = [
'sphinx_rtd_theme',
'sphinx_design',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]
Expand Down Expand Up @@ -84,8 +85,13 @@

# project_name = project.replace(' ', '_')

# IMPORTANT:
# ---------------------------------------------------------------------------------------------
# This part gives error that language does not exists and set it to "None" in the local build process
# DO NOT CHANGE IT: you will break the version management for the deployed documentation
html_context['current_language'] = ''
html_context['language'] = ''
# ---------------------------------------------------------------------------------------------

# -- "Edit on GitHub" links --------------------------------------------------
html_context['display_github'] = True
Expand Down
29 changes: 23 additions & 6 deletions docs/conf.py.orig
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sys.path.insert(0, os.path.abspath('../src'))
# -- Project information -----------------------------------------------------
project = 'Ubiquity Robotics Documentation'
copyright = '2025, Ubiquity Robotics'
author = 'Pavel for now'
author = 'Paveljolak'
version = ''
release = '1.0.0'

Expand All @@ -36,6 +36,14 @@ pygments_style = None
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']

html_logo = "_static/logos/UbiquityRobotics_Logo_Full_White.png"

html_css_files = [
'custom.css'
]

html_js_files = ['custom.js']

# -- RTD lower-left menu setup -----------------------------------------------
try:
html_context
Expand All @@ -45,7 +53,8 @@ except NameError:
html_context['display_lower_left'] = True

# Repo and environment info
REPO_NAME = os.environ.get('REPO_NAME', '')
full_repo = os.environ.get('GITHUB_REPOSITORY', '')
REPO_NAME = full_repo.split('/')[-1]
OWNER = os.environ.get('OWNER', '')

# Use ALL_VERSIONS from workflow environment
Expand All @@ -56,10 +65,19 @@ current_version = os.environ.get('CURRENT_BRANCH') or (ALL_VERSIONS[0] if ALL_VE
html_context['current_version'] = current_version
html_context['version'] = current_version


# Base URL for GitHub Pages
GITHUB_PAGES_BASE = f"https://{OWNER}.github.io/{REPO_NAME}"

# Set versions for selector with absolute URLs
# Get the custom domain
CUSTOM_DOMAIN = os.environ.get("CUSTOM_DOMAIN", "")

# If the DOMAIN exists in the workflow then use it
if CUSTOM_DOMAIN:
GITHUB_PAGES_BASE = f"https://{REPO_NAME}.{CUSTOM_DOMAIN}"
else:
GITHUB_PAGES_BASE = f"https://{OWNER}.github.io/{REPO_NAME}"# Set versions for selector with absolute URLs

# Build the absolute URLs for each version
html_context['versions'] = [
(v, f"{GITHUB_PAGES_BASE}/{v}/") for v in ALL_VERSIONS
]
Expand All @@ -71,8 +89,7 @@ html_context['language'] = ''

# -- "Edit on GitHub" links --------------------------------------------------
html_context['display_github'] = True
html_context['github_user'] = ''
html_context['github_user'] = OWNER
html_context['github_repo'] = REPO_NAME
html_context['github_version'] = f'{current_version}/docs/'


9 changes: 9 additions & 0 deletions docs/driving/connecting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,15 @@ Example:

|

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

.. .. important::

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 Robot 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

|

Method 2: Shutdown from Terminal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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.
15 changes: 15 additions & 0 deletions docs/ez_map/ez_map_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,25 @@ The EZ-Map interface is available on the following webpage:

http://<ROBOT-IP>:3000

Alternatively, you can use the robot's hostname (where ``XXXX`` is your robot's unique ID):

.. code-block:: bash

http://ubiquityrobotXXXX.local:3000

.. note::

This ``ROBOT-IP`` is the same IP that you used to connect to the robot.
If you followed the :doc:`../driving/connecting` properly then you should have this IP.
The hostname method may or may not work depending on your network's DNS or mDNS configuration.


.. danger::

**CHECK YOUR BROWSER ADDRESS BAR!**

Modern browsers (like Chrome or Safari) often automatically force an ``https://`` connection.
EZ-Map **requires** ``http://`` to function. If the page does not load, or you see a "Connection Refused" error, manually change the ``https://`` back to ``http://`` in your address bar.


.. warning::
Expand Down
29 changes: 26 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,19 @@ Sections

|

- `Driving the Robot <driving_>`_: Learn how to operate your robot in the most basic way possible. How to drive it through Teleop and through our custom sofware EZ-Map.
- `Driving the Robot <driving_>`_: Learn how to operate your robot in the most basic way possible. How to drive it through Teleop and through our custom sofware EZ-Map. This section also includes advanced motor parameter configuration.

|

- `EZ-Map <ez_map_>`_: Our custom SLAM software for automating your robot. Includes installation, setup, and usage instructions.

|

- `Troubleshooting <troubleshooting_>`_: Solutions to common hardware and software issues. Your first stop if you encounter problems.
- `OdinFleet <odin_fleet_>`_: Our custom OdinFleet software for managing fleets through a web dashboard, build on top of Open-RMF.

|

- `Let's get technical <troubleshooting_>`_: Solutions to common hardware and software issues. Your first stop if you encounter problems.

----

Expand Down Expand Up @@ -85,6 +89,7 @@ Sections
driving/connecting
driving/teleop
driving/ez_map_simple_drive
driving/shutdown


.. _ez_map:
Expand All @@ -96,14 +101,32 @@ Sections
ez_map/ez_map_intro
ez_map/ez_map_guide


.. _odin_fleet:

.. toctree::
:maxdepth: 2
:caption: OdinFleet

odin_fleet/odin_fleet_intro
odin_fleet/odin_fleet_guide


.. _troubleshooting:

.. toctree::
:maxdepth: 2
:caption: Troubleshooting
:caption: Let's get Technical

troubleshooting/hardware/lidars
troubleshooting/hardware/rpi
troubleshooting/hardware/pi_camera
troubleshooting/hardware/motor_parameters

.. _troubleshooting_tips:

.. toctree::
:maxdepth: 2
:caption: Troubleshooting

troubleshooting/troubleshooting_tips
Loading
Loading