Skip to content

Commit

Permalink
Update Control Panel Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreQuebriac committed Feb 27, 2024
1 parent 6f1a80a commit d96493e
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
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.
5 changes: 5 additions & 0 deletions docs/sources/control_panel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,8 @@ The 3LawsRobotics Team is available to answer your question.
:maxdepth: 2

launch/index

.. toctree::
:maxdepth: 2

usage/index
31 changes: 31 additions & 0 deletions docs/sources/control_panel/usage/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Use the Control Panel
===============

The control panel is meant to be user friendly and safe explanatory.
However some detail might be useful to know.

Here is a picture of the control panel:

.. image:: data/Base_Info_Configuration.png
:width: 960px
:alt: Control Panel without any configuration

The control panel is divided in 3 parts:

- The Navigation bar, where you can find the main pages, a Ros Bridge WebSocket status indicator and a WebSocket parameter button.
- The main page, where you can find the configuration form and the control buttons.
- The footer, where you can find the version number and the 3LawsRobotics website link and a link to the update pages.


In order to use this control panel at its best, you need to configure the Ros Bridge WebSocket parameters.
To do so, click on the WebSocket parameter button in the navigation bar and fill the form with the correct parameters.

By default, the control panel is configured to connect to a Ros Bridge WebSocket running on the same machine, on the port 9090.
More information on the Ros Bridge WebSocket can be found following this link: `Ros Bridge WebSocket <http://wiki.ros.org/rosbridge_suite>`_.

.. image:: data/Valid_Ros_WS_params.png
:width: 960px
:alt: Control Panel with connected Ros Bridge WebSocket

A successful connection to the Ros Bridge WebSocket will be indicated by a green status indicator in the navigation bar.

0 comments on commit d96493e

Please sign in to comment.