### Create and Start Scripted Animation (sphinx-cli)

Source: https://developer.parrot.com/docs/sphinx/precise_motion

Demonstrates how to create and start a scripted animation using the `sphinx-cli` command-line tool. It defines a script to spawn a drone and then initiates the animation.

```Bash
script=$(cat << EOT
[
  {
    "stop_condition_expr": "step_time > 10",
    "first_pose": {
      "x_expr": "0",
      "y_expr": "0",
      "z_expr": "2",
      "roll_expr": "0",
      "pitch_expr": "0",
      "yaw_expr": "0"
    }
  }
]
EOT
)

sphinx-cli param handling/userscript script "${script}"
sphinx-cli action handling/userscript start

```

--------------------------------

### Install Parrot Sphinx Core Application

Source: https://developer.parrot.com/docs/sphinx/installation

Installs the core Parrot Sphinx application, responsible for drone modeling and simulation. This command requires root privileges and should be followed by a logout/relogin.

```bash
$ sudo apt install parrot-sphinx

```

--------------------------------

### Create and Start Scripted Animation (pysphinx)

Source: https://developer.parrot.com/docs/sphinx/precise_motion

Shows how to create and start a scripted animation using the `pysphinx` Python library. It involves initializing the Sphinx object, defining the script, and triggering the animation.

```Python
import pysphinx

sphinx = pysphinx.Sphinx()

handling_script = """
[
  {
    "stop_condition_expr": "step_time > 10",
    "first_pose": {
      "x_expr": "0",
      "y_expr": "0",
      "z_expr": "2",
      "roll_expr": "0",
      "pitch_expr": "0",
      "yaw_expr": "0"
    }
  }
]"""

handling = sphinx.get_component("anafi_ai", "userscript", "handling")
handling.set_param("script", handling_script)
handling.trig_action("start")

```

--------------------------------

### List Available Parrot UE4 Applications

Source: https://developer.parrot.com/docs/sphinx/installation

Updates the package list and searches for available Parrot UE4 applications. This helps in identifying which Unreal Engine 4 projects are available for installation.

```bash
$ sudo apt update
$ apt-cache search parrot-ue4

```

--------------------------------

### Mount Bind Configuration Example

Source: https://developer.parrot.com/docs/sphinx/launcher_api

An example demonstrating the use of the 'mountbind' parameter in a .drone file. This parameter allows a directory on the host system to be mounted within the simulated drone's filesystem.

```xml
<mountbind>/home/user/mission:/mnt/mission</mountbind>
```

--------------------------------

### Install Parrot Sphinx SDK

Source: https://developer.parrot.com/docs/sphinx/sdk_introduction

Installs the Parrot Sphinx SDK using the apt package manager. This is the first step in setting up the SDK for Unreal Engine application development.

```bash
$ sudo apt install parrot-ue-sdk

```

--------------------------------

### Register Parrot Sphinx PPA

Source: https://developer.parrot.com/docs/sphinx/installation

These commands set up your system to accept packages from the Parrot server by adding the GPG key and the repository source list. Requires root privileges for writing to system directories.

```bash
$ curl --fail --silent --show-error --location https://debian.parrot.com/gpg | gpg --dearmor | sudo tee /usr/share/keyrings/debian.parrot.com.gpg > /dev/null
$ echo "deb [signed-by=/usr/share/keyrings/debian.parrot.com.gpg] https://debian.parrot.com/ $(lsb_release -cs) main generic" | sudo tee /etc/apt/sources.list.d/debian.parrot.com.list
$ sudo apt update

```

--------------------------------

### Install Smallest Parrot UE4 Application

Source: https://developer.parrot.com/docs/sphinx/installation

Installs the 'parrot-ue4-empty' application, which is the simplest and smallest UE4 application available. This command requires root privileges.

```bash
$ sudo apt install parrot-ue4-empty

```

--------------------------------

### Firmware Actions

Source: https://developer.parrot.com/docs/sphinx/params_iplink

Provides actions to control the firmware instance, such as resetting or starting it.

```APIDOC
## POST /websites/developer_parrot_sphinx/actions/reset_firmware

### Description
Resets the firmware instance.

### Method
POST

### Endpoint
/websites/developer_parrot_sphinx/actions/reset_firmware

### Parameters
#### Query Parameters
- **fw_reset_running** (boolean) - Optional - If `true` the firmware instance is being reset, `false` otherwise (read-only).

### Request Example
```json
{
  "fw_reset_running": true
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the reset operation.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /websites/developer_parrot_sphinx/actions/start_firmware

### Description
Starts the firmware instance.

### Method
POST

### Endpoint
/websites/developer_parrot_sphinx/actions/start_firmware

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the start operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Start Simulation with Specific Level

Source: https://developer.parrot.com/docs/sphinx/launcher_api

Launch the UE4 application and start the simulation by selecting a specific world level. This command specifies the desired level using the '-level' argument.

```bash
$ parrot-ue4-forest -level=sparse
```

--------------------------------

### Configure and Start Camera Recording via sphinx-cli

Source: https://developer.parrot.com/docs/sphinx/record_and_visualize_cameras

This describes how to configure and start camera recording using the `sphinx-cli` tool. It involves executing a series of `param` subcommands to set the output path and enable recording, similar to the Web dashboard configuration. This method is noted as less efficient than `sphinx-cli camera`.

```bash
# Example of setting parameters via sphinx-cli (actual commands may vary)
# sphinx-cli param set recording/path /path/to/output
# sphinx-cli param set recording/enable true

```

--------------------------------

### Directly Start Firmwared Daemon

Source: https://developer.parrot.com/docs/sphinx/firmwared

Command to start the `firmwared` daemon directly from the shell. This is an alternative to using `systemd` and is suitable for manual control or debugging.

```bash
$ sudo firmwared

```

--------------------------------

### Verify Wi-Fi Network Interface (Linux)

Source: https://developer.parrot.com/docs/sphinx/wifi_setup

This command verifies the creation of the new Wi-Fi network interface after configuring a drone as a Wi-Fi adapter. It filters the output of 'ip a' to show interfaces containing 'sphx'.

```bash
ip a | grep sphx
```

--------------------------------

### Start Firmwares After Parameter Modification

Source: https://developer.parrot.com/docs/sphinx/reset_reboot

Starts the firmware by sending the 'start_firmwares' action to the 'fwman' world component. This is typically used after modifying runtime parameters when the simulation was started with the firmware paused.

```bash
sphinx-cli action -m world fwman start_firmwares
```

--------------------------------

### Start and Restart Firmwared Service

Source: https://developer.parrot.com/docs/sphinx/firmwared

Instructions for starting and restarting the `firmwared` service using `systemctl`. This ensures the firmware management daemon is running or reloaded with new configurations.

```bash
$ sudo systemctl start firmwared.service

```

```bash
$ sudo systemctl restart firmwared.service

```

--------------------------------

### Build and Install Parrot UE Editor

Source: https://developer.parrot.com/docs/sphinx/build_ue_editor

Builds and installs the Parrot-customized UE editor from the source code. The editor is installed into a mandatory directory, `/opt/parrot-ue4-editor`. This process can take a significant amount of time.

```bash
$ parrot-ue-build-editor --install $(pwd)
```

--------------------------------

### Set Spawn Point by Name

Source: https://developer.parrot.com/docs/sphinx/launcher_api

Start the simulation with the drone placed at a predefined spawn point specified by name. This uses the 'pose' parameter with the spawn point's name.

```bash
$ sphinx <my.drone>::pose=Lake
```

--------------------------------

### World Firmware Actions

Source: https://developer.parrot.com/docs/sphinx/params_fwman

Provides actions to manage all firmware instances within the world, including resetting, starting, and controlling world reset states.

```APIDOC
## POST /fman/reset_firmwares

### Description
Resets all firmware instances attached to drones in the world.

### Method
POST

### Endpoint
/fman/reset_firmwares

### Parameters
#### Query Parameters
- **all_drones_ready** (boolean) - Optional - `true` if all drones drones are ready to be used, `false` otherwise (read-only).
- **objects_to_hide** (string) - Optional - Names of objects to hide in the UE4 application. Names are separated by commas. Names must be exactly the same as in the UE4 application, apart from vehicles and pedestrians.
- **rt_percent** (floating-point number) - Optional - Target real-time factor expressed in percent.
- **scene_altitude** (floating-point number) - Optional - DEPRECATED. The altitude above sea level of the current scene (in meters). Taken into account after world reset.
- **world_reset_running** (boolean) - Optional - `true` if a world reset is in progress, `false` otherwise (read-only).
- **wpo_factor** (floating-point number) - Optional - If set to zero, freezes all animations such as the ones from foliages, and hides particles. If higher than one, increases animation speed and magnitude. If lower than one, reduces them.

### Request Example
```json
{
  "all_drones_ready": true,
  "objects_to_hide": "object1,object2",
  "rt_percent": 100.0,
  "scene_altitude": 100.0,
  "world_reset_running": false,
  "wpo_factor": 1.0
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the reset operation.

#### Response Example
```json
{
  "status": "All firmware instances reset."
}
```

## POST /fman/start_firmwares

### Description
Starts all firmware instances attached to drones in the world.

### Method
POST

### Endpoint
/fman/start_firmwares

### Parameters
#### Query Parameters
- **all_drones_ready** (boolean) - Optional - `true` if all drones drones are ready to be used, `false` otherwise (read-only).
- **objects_to_hide** (string) - Optional - Names of objects to hide in the UE4 application. Names are separated by commas. Names must be exactly the same as in the UE4 application, apart from vehicles and pedestrians.
- **rt_percent** (floating-point number) - Optional - Target real-time factor expressed in percent.
- **scene_altitude** (floating-point number) - Optional - DEPRECATED. The altitude above sea level of the current scene (in meters). Taken into account after world reset.
- **world_reset_running** (boolean) - Optional - `true` if a world reset is in progress, `false` otherwise (read-only).
- **wpo_factor** (floating-point number) - Optional - If set to zero, freezes all animations such as the ones from foliages, and hides particles. If higher than one, increases animation speed and magnitude. If lower than one, reduces them.

### Request Example
```json
{
  "all_drones_ready": true,
  "objects_to_hide": "object1,object2",
  "rt_percent": 100.0,
  "scene_altitude": 100.0,
  "world_reset_running": false,
  "wpo_factor": 1.0
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the start operation.

#### Response Example
```json
{
  "status": "All firmware instances started."
}
```

## POST /fman/world_reset_all

### Description
Resets all firmware instances, time, and object poses in the world.

### Method
POST

### Endpoint
/fman/world_reset_all

### Parameters
#### Query Parameters
- **all_drones_ready** (boolean) - Optional - `true` if all drones drones are ready to be used, `false` otherwise (read-only).
- **objects_to_hide** (string) - Optional - Names of objects to hide in the UE4 application. Names are separated by commas. Names must be exactly the same as in the UE4 application, apart from vehicles and pedestrians.
- **rt_percent** (floating-point number) - Optional - Target real-time factor expressed in percent.
- **scene_altitude** (floating-point number) - Optional - DEPRECATED. The altitude above sea level of the current scene (in meters). Taken into account after world reset.
- **world_reset_running** (boolean) - Optional - `true` if a world reset is in progress, `false` otherwise (read-only).
- **wpo_factor** (floating-point number) - Optional - If set to zero, freezes all animations such as the ones from foliages, and hides particles. If higher than one, increases animation speed and magnitude. If lower than one, reduces them.

### Request Example
```json
{
  "all_drones_ready": true,
  "objects_to_hide": "object1,object2",
  "rt_percent": 100.0,
  "scene_altitude": 100.0,
  "world_reset_running": false,
  "wpo_factor": 1.0
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the world reset operation.

#### Response Example
```json
{
  "status": "World reset completed."
}
```
```

--------------------------------

### Configure Firmwared with Custom Settings

Source: https://developer.parrot.com/docs/sphinx/firmwared

Example configuration for `firmwared.conf` to enable extra logging. This file should be placed in `/etc` and allows customization of daemon behavior, such as verbose logging.

```lua
-- lua language syntax

FIRMWARED_DUMP_PROFILE = "y"
FIRMWARED_VERBOSE_HOOK_SCRIPTS = "y"

```

--------------------------------

### Start Sphinx with Wi-Fi Interface Auto-Detection

Source: https://developer.parrot.com/docs/sphinx/remote_controllers

This command starts the Parrot Sphinx simulator, automatically detecting and configuring the Wi-Fi interface for drone communication. It's a foundational step for Wi-Fi based drone control.

```bash
$ sphinx my.drone::wifi_iface=auto

```

--------------------------------

### Drone Firmware Actions

Source: https://developer.parrot.com/docs/sphinx/params_fwman

Provides actions to manage individual firmware instances attached to a drone, such as resetting or starting them.

```APIDOC
## POST /fman/reset_firmware

### Description
Resets a specific firmware instance.

### Method
POST

### Endpoint
/fman/reset_firmware

### Parameters
#### Query Parameters
- **fw_reset_running** (boolean) - Optional - If `true` the firmware instance is being reset, `false` otherwise (read-only).
- **initial_pose** (string) - Optional - The initial pose of the drone after a world reset. Can be a 6-component vector or the name of a spawn point.
- **startup_pause** (boolean) - Optional - If `true` the firmware instance will be paused at startup, `false` otherwise.

### Request Example
```json
{
  "fw_reset_running": false,
  "initial_pose": "(0,0,0,0,0,0)",
  "startup_pause": false
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the reset operation.

#### Response Example
```json
{
  "status": "Firmware reset initiated."
}
```

## POST /fman/start_firmware

### Description
Starts a specific firmware instance.

### Method
POST

### Endpoint
/fman/start_firmware

### Parameters
#### Query Parameters
- **fw_reset_running** (boolean) - Optional - If `true` the firmware instance is being reset, `false` otherwise (read-only).
- **initial_pose** (string) - Optional - The initial pose of the drone after a world reset. Can be a 6-component vector or the name of a spawn point.
- **startup_pause** (boolean) - Optional - If `true` the firmware instance will be paused at startup, `false` otherwise.

### Request Example
```json
{
  "fw_reset_running": false,
  "initial_pose": "(0,0,0,0,0,0)",
  "startup_pause": false
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the start operation.

#### Response Example
```json
{
  "status": "Firmware started."
}
```
```

--------------------------------

### Example HDRI Configuration File

Source: https://developer.parrot.com/docs/sphinx/sky_and_light

A sample YAML configuration file defining external HDRI textures. It includes the name and file path for each HDRI image.

```yaml
Hdris:
  - Name: 'MyAwesomeHdri'
    FilePath: '/path/to/MyAwesomeHdri.png'
  - Name: 'MyEvenMoreAwesomeHdri'
    FilePath: '/path/to/MyEvenMoreAwesomeHdri.jpg'

```

--------------------------------

### List Available Spawn Points

Source: https://developer.parrot.com/docs/sphinx/launcher_api

List all available spawn points within a given world level, including those for vehicles and characters. This helps in choosing a starting location for the drone.

```bash
$ parrot-ue4-landscape-mountains -level=main -ams-path=DefaultPath,Pickup,Jasper -list-spawn-points
```

--------------------------------

### Run Parrot UE Editor

Source: https://developer.parrot.com/docs/sphinx/build_ue_editor

Launches the installed Parrot-customized UE editor. The editor must be located at `/opt/parrot-ue4-editor` for this command to work.

```bash
$ /opt/parrot-ue4-editor/Engine/Binaries/Linux/UE4Editor
```

--------------------------------

### Check Wi-Fi Device Access Point Mode (Linux)

Source: https://developer.parrot.com/docs/sphinx/wifi_setup

This command checks if a Wi-Fi device on a Linux system supports Access Point (AP) mode, which is required for Parrot Sphinx. It lists supported interface modes and is crucial for compatibility with hostapd.

```bash
iw list | grep -A20 "Supported interface modes"
```

--------------------------------

### Configure Drone as Wi-Fi Dongle (ANAFI Ai)

Source: https://developer.parrot.com/docs/sphinx/wifi_setup

This command configures Parrot Sphinx to use an ANAFI Ai drone as a Wi-Fi adapter. It requires the simulated drone model as an argument. After execution, a new network interface named 'sphx_ana_XXXX' should appear.

```bash
sphinx-drone-as-wifidongle --model=<simulated_drone_model>
```

--------------------------------

### Launch Drone Simulation and Application

Source: https://developer.parrot.com/docs/sphinx/segmentation_3dgrid

These commands initiate the drone simulation and the associated application for capturing segmentation data. The first command launches the Sphinx simulation with specified camera and firmware settings, while the second starts the UE4 application with a stencil file.

```bash
$ sphinx <path/to/anafi_ai.drone>::with_front_cam=1::firmware=<path/to/ext2.zip> &
$ parrot-ue4-<app> -stencil-file=<path/to/input.stencil>


```

--------------------------------

### Configure Drone Initial Pose - JSON

Source: https://developer.parrot.com/docs/sphinx/precise_motion

Configures the initial pose (position and orientation) for a drone step. It accepts ExprTk expressions for translation (x, y, z) and rotation (roll, pitch, yaw). It also includes parameters for relative positioning, force resetting, and collision detection.

```json
{
  "first_pose": {
    "x_expr": "val",
    "y_expr": "val",
    "z_expr": "val",
    "roll_expr": "0",
    "pitch_expr": "0",
    "yaw_expr": "val",
    "relative_position": "false",
    "reset_all_forces": "true",
    "min_collision_radius": 0,
    "max_height_above_ground": 0
  }
}
```

--------------------------------

### Get Encountered Objects (Python)

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Identifies objects encountered between a start and end position. Optional parameters include `show_debug` for visualization, `timeout` for the duration of the search, and `keep_alive` to maintain the search state. This function is designed to detect objects within a defined spatial range.

```python
def get_encountered_objects(_start_position_ , _end_position_ , _show_debug =False, _timeout =1, _keep_alive =False):
    pass
```

--------------------------------

### Display Command Line Help

Source: https://developer.parrot.com/docs/sphinx/launcher_api

Access command line help pages for parrot-ue4-<xxxxx> and sphinx. These commands provide a comprehensive list of all available command line parameters for configuration.

```bash
$ parrot-ue4-<xxxxx> -help
$ sphinx --help
```

--------------------------------

### List Available Parameters with sphinx-cli

Source: https://developer.parrot.com/docs/sphinx/interact_with_simulation

This command lists all available parameters for components within the simulation. The output is a dictionary where keys are machine identifiers or component types, and values are lists of parameter names.

```bash
$ sphinx-cli param -l

```

--------------------------------

### Start Simulation with Firmware Pause

Source: https://developer.parrot.com/docs/sphinx/reset_reboot

Starts the Parrot Sphinx simulation with the firmware paused using the -U or --pause-firmware option. This allows modification of runtime parameters before the firmware is launched. The drone path must be specified.

```bash
sphinx -U /path/to/my.drone
```

--------------------------------

### GUI Visualization Settings

Source: https://developer.parrot.com/docs/sphinx/params_ultrasound

Configure visualization parameters for the GUI.

```APIDOC
## GET /websites/developer_parrot_sphinx/ultrasound/gui

### Description
Retrieves the current GUI visualization settings.

### Method
GET

### Endpoint
/websites/developer_parrot_sphinx/ultrasound/gui

### Parameters
#### Query Parameters
- **color** (rgba) - Optional - Color of the visualization artifacts and frame panel.
- **visualize** (boolean) - Optional - If `true`, display camera orientation and FoV.
- **visualize_hdr** (boolean) - Optional - If `true`, display auto-exposition histogram.

### Response
#### Success Response (200)
- **color** (array of float) - RGBA color values [r, g, b, a].
- **visualize** (boolean) - Whether to visualize camera orientation and FoV.
- **visualize_hdr** (boolean) - Whether to visualize the auto-exposition histogram.

#### Response Example
```json
{
  "color": [1.0, 1.0, 1.0, 1.0],
  "visualize": true,
  "visualize_hdr": false
}
```
```

```APIDOC
## PUT /websites/developer_parrot_sphinx/ultrasound/gui

### Description
Updates the GUI visualization settings.

### Method
PUT

### Endpoint
/websites/developer_parrot_sphinx/ultrasound/gui

### Parameters
#### Request Body
- **color** (array of float) - Optional - RGBA color values [r, g, b, a].
- **visualize** (boolean) - Optional - If `true`, display camera orientation and FoV.
- **visualize_hdr** (boolean) - Optional - If `true`, display auto-exposition histogram.

### Request Example
```json
{
  "color": [0.5, 0.2, 0.8, 0.7],
  "visualize": false
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "GUI visualization settings updated successfully."
}
```
```

--------------------------------

### Launch Planet Application with GPS Coordinates

Source: https://developer.parrot.com/docs/sphinx/world_planet

Command-line example for launching the parrot-ue4-planet application. It demonstrates how to specify the configuration file path and provide GPS coordinates for drone spawning. It is recommended to use decimal degrees for flat surface locations.

```bash
$ parrot-ue4-planet -config-file=</path/to/file.yaml> -gps-json='{"lat_deg":<lat>, "lng_deg":<long>}'
```

--------------------------------

### ExprTk Uniform Random Function Example

Source: https://developer.parrot.com/docs/sphinx/sensors_alteration_syntax

Illustrates the use of the `randu()` function for generating uniformly distributed random numbers between 0 and 1. The example shows how to use this function to select an output based on a given probability.

```c
acceleroX_expr = (0.001 > randu()) ? val + noise() * 0.05 : val + noise() * 0.01;
```

--------------------------------

### Display 3D Grid Colors with Threshold

Source: https://developer.parrot.com/docs/sphinx/segmentation_3dgrid

This command launches the UE4 application and highlights grid units based on provided color data and a threshold. It allows visualization of captured data against expected values, with customizable display logic.

```bash
parrot-ue4-<app> -stencil-file=<input.stencil> -show-3Dgrid-colors=<input.colors>,<threshold>[+]


```

--------------------------------

### Li-Po Battery Parameters

Source: https://developer.parrot.com/docs/sphinx/params_lipo_battery

Allows you to get and set various parameters of the Li-Po battery.

```APIDOC
## GET /websites/developer_parrot_sphinx/parameters

### Description
Retrieves the current parameters of the Li-Po battery.

### Method
GET

### Endpoint
/websites/developer_parrot_sphinx/parameters

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
null
```

### Response
#### Success Response (200)
- **capacity** (number) - Battery capacity in Ah.
- **discharge_speed_factor** (integer) - Battery discharge speed factor. Defaults to 1.
- **initial_charge** (number) - Initial battery charge in Ah.

#### Response Example
```json
{
  "capacity": 5.0,
  "discharge_speed_factor": 1,
  "initial_charge": 4.5
}
```

## PUT /websites/developer_parrot_sphinx/parameters

### Description
Updates the parameters of the Li-Po battery.

### Method
PUT

### Endpoint
/websites/developer_parrot_sphinx/parameters

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **capacity** (number) - Optional. Battery capacity in Ah.
- **discharge_speed_factor** (integer) - Optional. Battery discharge speed factor. A value of 0 means the battery will not discharge. A value greater than 1 accelerates the discharge speed.
- **initial_charge** (number) - Optional. Initial battery charge in Ah.

### Request Example
```json
{
  "capacity": 5.0,
  "discharge_speed_factor": 2
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of parameter update.

#### Response Example
```json
{
  "message": "Battery parameters updated successfully."
}
```
```

--------------------------------

### Script Execution Actions

Source: https://developer.parrot.com/docs/sphinx/params_handling

Control the execution flow of a script, including starting, stopping, and pausing.

```APIDOC
## POST /execute/action

### Description
Triggers an action on the script execution.

### Method
POST

### Endpoint
/execute/action

### Parameters
#### Query Parameters
- **action** (string) - Required - The action to perform. Possible values: `start`, `stop`, `pause`, `soft_stop`.

### Request Example
```json
{
  "action": "start"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the result of the action.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### GET /world_name

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Retrieves the name of the current simulation world.

```APIDOC
## GET /world_name

### Description
Returns the world’s name.

### Method
GET

### Endpoint
/world_name

### Parameters
None

### Response
#### Success Response (200)
- **world_name** (str) - The name of the world or __undefined__.

#### Response Example
```json
"ManufacturingPlant_v3"
```
```

--------------------------------

### GET /sphinx_version

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Retrieves the version number of the Sphinx software.

```APIDOC
## GET /sphinx_version

### Description
Returns sphinx’s version number.

### Method
GET

### Endpoint
/sphinx_version

### Parameters
None

### Response
#### Success Response (200)
- **sphinx_version** (str) - Sphinx’s version number or __undefined__.

#### Response Example
```json
"2.1.0"
```
```

--------------------------------

### GET /spherical_coordinates_converter

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Returns the spherical coordinates converter object.

```APIDOC
## GET /spherical_coordinates_converter

### Description
Returns the spherical coordinates converter.

### Method
GET

### Endpoint
/spherical_coordinates_converter

### Parameters
None

### Response
#### Success Response (200)
- **converter** (`pysphinx.SphericalCoordinatesConverter`) - A pysphinx.SphericalCoordinatesConverter object on success, None otherwise.

#### Response Example
```json
{
  "type": "SphericalCoordinatesConverter"
}
```
```

--------------------------------

### GET /info

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Retrieves information about the currently running simulation.

```APIDOC
## GET /info

### Description
Returns information on the running simulation.

### Method
GET

### Endpoint
/info

### Parameters
None

### Response
#### Success Response (200)
- **simulation_info** (dict) - A dictionary object containing simulation details.

#### Response Example
```json
{
  "simulation_name": "MySimulation",
  "current_time": 1678886400,
  "status": "running"
}
```
```

--------------------------------

### List Available Cameras with sphinx-cli

Source: https://developer.parrot.com/docs/sphinx/record_and_visualize_cameras

This command lists all available simulated cameras within the Parrot Sphinx environment. It's a prerequisite for selecting a camera for visualization or recording. No specific inputs are required, and the output is a list of camera names.

```bash
$ sphinx-cli camera -l

```

--------------------------------

### Configure and Start Camera Recording via Web Dashboard

Source: https://developer.parrot.com/docs/sphinx/record_and_visualize_cameras

This section describes how to configure camera recording using the 'inspector' widget in the Web dashboard. Users can set the output directory (`recording/path`) and enable recording (`recording/enable`) by setting the parameter to `true` or `1`. Recording can be stopped by setting `recording/enable` to `false` or `0`.

```text
>   * set the directory where to store the output files in `recording/path`. If kept empty the files are going to be written into Parrot Sphinx’s current working directory.
>   * to start the recording, write `true` or `1` into the `recording/enable` parameter.
>   * to stop it, write `false` or `0`.
> 

```

--------------------------------

### Launch UE4 App with Custom AMS Config

Source: https://developer.parrot.com/docs/sphinx/populate_with_actors

This command launches the UE4 application with a specified YAML configuration file for AMS customization. The `config-file` argument points to the location of the YAML file, enabling custom paths and tags. Ensure the path to the file is correct.

```bash
$ parrot-ue4-empty -config-file=</path/to/file.yaml>
```

--------------------------------

### GET /object_param_description

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Retrieves the description of a specific parameter for an object on a given machine.

```APIDOC
## GET /object_param_description

### Description
Returns the description of an object parameter.

### Method
GET

### Endpoint
/object_param_description

### Parameters
#### Query Parameters
- **machine_name** (str) - Required - The name of the machine.
- **object_name** (str) - Required - The name of the object.
- **param** (str) - Required - The name of the parameter.

### Response
#### Success Response (200)
- **parameter_description** (str) - The description of the specified parameter.

#### Response Example
```json
"The maximum speed at which the object can move."
```
```

--------------------------------

### GET /object_param

Source: https://developer.parrot.com/docs/sphinx/pysphinxapi

Retrieves the value of a specific parameter for an object on a given machine.

```APIDOC
## GET /object_param

### Description
Returns the value of an object parameter.

### Method
GET

### Endpoint
/object_param

### Parameters
#### Query Parameters
- **machine_name** (str) - Required - The name of the machine.
- **object_name** (str) - Required - The name of the object.
- **param** (str) - Required - The name of the parameter.

### Response
#### Success Response (200)
- **parameter_value** (str) - The value of the specified parameter.

#### Response Example
```json
"1.5"
```
```

--------------------------------

### Drone Configuration XML Structure

Source: https://developer.parrot.com/docs/sphinx/launcher_api

A typical `.drone` XML file defining general settings for a simulated drone. It includes parameters for firmware, hardware, pose, Wi-Fi, and peripherals. These settings can be overridden via the command line.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<drone name="my_awesome_drone"
       firmware="https://url/to/my/anafi2-pc.ext2.zip"
       hardware="anafi2">

  <pose>default</pose>
  <wifi_iface>auto</wifi_iface>
  <wan_access>false</wan_access>
  <remote_ctrl_ip></remote_ctrl_ip>
  <ext_storage_size>8G</ext_storage_size>

  <with_front_cam>1</with_front_cam>
  <with_gimbal>1</with_gimbal>
  <with_front_stcam>1</with_front_stcam>
  <invisible_body>0</invisible_body>
</drone>
```