forked from ArduPilot/ardupilot
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ensure we only have to document the instructions in one place
- Loading branch information
1 parent
867ca05
commit d8122f1
Showing
1 changed file
with
1 addition
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,5 @@ | ||
| # Vagrant for SITL and ardupilot development | ||
|
|
||
| We support a vagrant container for _easily_ running SITL (software in the loop simulator) and compling Ardupilot code. | ||
| This README is mean't to be the instructions on how to run this. | ||
|
|
||
| ## Install vagrant for your platform | ||
|
|
||
| Windows, OS-X and Linux are supported. [Download](https://www.vagrantup.com/downloads.html) and install per their instructions. | ||
|
|
||
| If you are on Windows you will want to [install](https://www.virtualbox.org/wiki/Downloads) VirtualBox prior to installing Vagrant. | ||
|
|
||
| ## Start a vagrant instance | ||
|
|
||
| * Change the current directory to be any directory inside this source tree and run "vagrant up". It will start running the instance | ||
| in a VM (the initial time you run this command it will likely need to fetch many things). All the files in this directory tree will | ||
| magically appear inside the running instance at /vagrant. | ||
|
|
||
| ## Start running SITL | ||
|
|
||
| In your vagrant shell run: | ||
| <pre> | ||
| vagrant ssh -c "sim_vehicle.sh -j 2" | ||
| </pre> | ||
| This will build the Ardupilot code if needed and then run the simulator. The mavlink prompt allows you to monitor vehicle state. To exit | ||
| the simulation just press control-d to exit the mavlink shell. | ||
|
|
||
| ## Run mission planner or mavproxy in your main OS | ||
|
|
||
| You can now connect to the running simulator from your main OS. Just connect to UDP port 14550, either from mission planner or mavproxy. | ||
| The mavproxy command is "mavproxy.py --master=127.0.0.1:14550" | ||
|
|
||
| ## Shutting down the simulator | ||
|
|
||
| * When you are done with the simulator, just press ctrl-d in the vagrant ssh window to exit the special mavproxy that is gluing everything together. | ||
| * Run "vagrant suspend" to stop the running VM. When you need it again just run "vagrant up" to resume. | ||
|
|
||
| Instructions for how to install and run this vagrant container are provided on the ArduPilot dev wiki in: [Setting up SITL using Vagrant](http://dev.ardupilot.com/wiki/simulation-2/sitl-simulator-software-in-the-loop/setting-up-sitl-using-vagrant/). |