Skip to content

Commit

Permalink
Merge 829eab2 into 1b34580
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabien-B committed Jan 23, 2024
2 parents 1b34580 + 829eab2 commit 61957c5
Show file tree
Hide file tree
Showing 36 changed files with 4,993 additions and 511 deletions.
38 changes: 38 additions & 0 deletions doc/sphinx/source/getting_started/first_simulation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.. quickstart first_simu
======================
Flight Simulation
======================

Launch the simulation
=====================

- In the paparazzi center, select the **conf_example.xml** set (top right), then the **Bixler** aircraft (top left).
- Go to the **Configuration** tab, select the **nps** target, and click the *Build* button (gear icon).
- Go to the Operation tab, select the **Simulation** session and launch it with the *Start session* button (play icon).
- This aircraft have two simulation target, *sim* and *nps*. Since you just build for *nps*, choose this simulator if asked for.

A new window opens, this is the GCS (Ground Control Station).

.. image:: pprzgcs.png

The GCS layout can be changed, but in this layout:

- The map is largest widget. Buttons opening others widgets are overlayed on the left and right side of the map.
- On the top right, this is the strip panel. Each aircraft have its own strip, which displays the state of the aircraft.
Some icons are buttons changing displayed data. E.g. the altitude can be displayed relative to the ground or sea level.
The arrow down button below the aircraft color displays another widget: the **command widget**.
- On the bottom right, this is the flight plan widget.

Now, lets launch the drone:

- In the flight plan, wait for the drone to be in the *Holding point* block, then put it the *Takeoff* block.
You can also do it from the *commands* widget.
- In real life, we would now launch the drone. In simulation, there is a magic button to do so in the *commands* widget.
Open the *commands* widget by clicking on the arrow-down button on the bottom left of the strip, and launch the drone with the *Launch* button (top left).

The drone should now move, and the current block will change to "Standby".

You can observe the status of the drone in the strip.


Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. quickstart index_quick_start
.. quickstart index_getting_started
=================
Quick Start
=================
===============
Getting Started
===============

Welcome to the Paparazzi UAV user guide!

Expand All @@ -17,6 +17,5 @@ To start, go to the :doc:`install` page!
system_overview
paparazzi_center_tour
first_simulation
gcs_tour
first_flight

Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. quickstart install
======================
Quick Install
======================
============
Installation
============

Paparazzi runs best on **Ubuntu 16.04 or higher**, so this quick installation guide is for Ubuntu users. I you have an other OS or if you want more detailled installation, see the :doc:`../installation/index_installation` page.
Paparazzi runs best on **Ubuntu 16.04 or higher**, so this quick installation guide is for Ubuntu users.

Open a terminal and execute each lines below. If one fails, ask for help on gitter.

Expand Down
82 changes: 82 additions & 0 deletions doc/sphinx/source/getting_started/paparazzi_center_tour.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
.. quickstart paparazzi_center_tour
.. _paparazzicenter:

=================
Paparazzi Center
=================

The Paparazzi Center is a graphical interface for configuring the drones and managing
the various paparazzi tools.

The drop-down on the top right corner select which set of aircrafts will be used.

Current aircraft is choosen via the top left drop-down.
The *id* on the left of the aircraft name is the **uniq** identifier of the aircraft among the set, between 0 and 255.


.. image:: pprz_center_conf.svg


Configuration tab
==================

The left side of this tab is dedicated to the configuration of the aircraft.

An aircraft is composed of an airframe, a flight plan, some settings, a radio and a telemetry configuration file. These concepts are explained later.

For now, remember that you can select other files, or edit the current file with the button.

.. note::

The ``Edit`` button open the file with *gedit* by default. You can change it via ``File->Edit Settings->Text Editor``.


Once the aircraft is configured, the firmware can be build for a target.

Some usual targets are:

- **sim**: The basic fixedwing simulator written in OCaml without IMU simulation or any sensor models (noise, bias, etc) and mainly intended to validate your flight plan logic.
- **nps**: NPS is a more advanced rotorcraft and fixedwing simulator with sensor models and commonly uses JSBSim as FDM (Flight Dynamic Model).
- **ap**: This is for a *real* autopilot.


If the selected target is not a simulator, you can choose how you want to upload the
firmware to your autopilot, then flash it.

Compilation output is shown in the console zone.



Operation tab
=============

.. image:: pprz_center_operation.png

Sessions are a collection of tools with their arguments.
Sessions are saved in ``.*control_panel.xml`` files.
The left side drop-down select which control panel you are using.

Once a session is launched, the tools are listed below.
Each tool can be stopped/restarted, and removed from the list.

The buttons above the tools list apply to all tools.

Tools can be added to the current session with the *Add tools* button.
Don't forget to save the session if you want to keep this tool for next time!

The output of the tools is shown in the text area below.




Console panel
==============



Now, lets launch a :doc:`first_simulation`!




0 comments on commit 61957c5

Please sign in to comment.