Skip to content

Commit 59799bf

Browse files
committed
2 parents 2509235 + 0c0b367 commit 59799bf

File tree

2 files changed

+47
-28
lines changed

2 files changed

+47
-28
lines changed

docs/getting_started.rst

Lines changed: 46 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,31 @@
11
Getting Started
22
===============
33

4-
The best way to prototype apps for drones is to use a simulated vehicle. APM provides a Software-In-The-Loop (SITL) environment, which simulates a copter or plane, in Linux.
4+
On-board apps for drones typically run on a Linux-based "companion computer" that communicates with the autopilot via a serial port. However, you may find it easier to first prototype your app on a standard Mac, Windows, or Linux
5+
computer using a simulated autopilot, a process called "Software in the Loop Simulation" (SITL). This document will show you how to do both of these.
56

6-
If you want to test your app in real life, you should also grab a ready to fly copter from the `3D Robotics Store <http://store.3drobotics.com>`_.
7+
Supported Companion Computers
8+
-----------------------------
79

10+
RaspberryPi
11+
~~~~~~~~~~~
12+
* `Communicating with Raspberry Pi via MAVLink <http://dev.ardupilot.com/wiki/companion-computers/raspberry-pi-via-mavlink/>`_
13+
* `Making a Mavlink WiFi bridge using the Raspberry Pi <http://dev.ardupilot.com/wiki/companion-computers/raspberry-pi-via-mavlink/making-a-mavlink-wifi-bridge-using-the-raspberry-pi/>`_
814

9-
Set up a simulated vehicle
10-
--------------------------
11-
12-
13-
Dependencies
15+
Intel Edison
1416
~~~~~~~~~~~~
17+
* `Edison for drones <http://dev.ardupilot.com/wiki/companion-computers/edison-for-drones/>`_
1518

16-
If you are using Mac OSX or Windows, you need to set up a virtual Linux machine to run SITL.
17-
18-
A popular virtual machine manager for running SITL is `Virtual Box <https://www.virtualbox.org/>`_. A virtual machine running Ubuntu Linux 13.04 or later works great.
19-
20-
21-
Set up SITL on Linux
22-
~~~~~~~~~~~~~~~~~~~~
23-
24-
Please see `instructions here <http://dev.ardupilot.com/wiki/setting-up-sitl-on-linux/>`_ to set up SITL on Ubuntu.
19+
BeagleBoneBlack
20+
~~~~~~~~~~~~~~~~
21+
* `BeaglePilot <http://dev.ardupilot.com/wiki/companion-computers/beaglepilot/>`_
2522

26-
Once you have the simulated vehicle running, enter the following commands. (You only have to do this once)
23+
Odroid
24+
~~~~~~
25+
* `Communicating with ODroid via MAVLink <http://dev.ardupilot.com/wiki/companion-computers/odroid-via-mavlink/>`_
26+
* `ODroid Wifi Access Point for sharing files via Samba <http://dev.ardupilot.com/wiki/companion-computers/odroid-via-mavlink/odroid-wifi-access-point-for-sharing-files-via-samba/>`_
2727

28-
1. Load a default set of parameters
29-
2. Disable the arming check
3028

31-
::
32-
33-
STABILIZE>param load ../Tools/autotest/copter_params.parm
34-
STABILIZE>param set ARMING_CHECK 0
3529

3630

3731
Installing DroneKit
@@ -118,12 +112,36 @@ The DroneKit library is available on the public pypi repository. You can use the
118112
pip install droneapi
119113

120114

121-
Setting up DroneKit on a companion computer
122-
-------------------------------------------
123115

124-
A companion computer can augment the processing power and flexibility of the autopilot, allowing you to perform tasks like computer vision and directly control the drone through a low latency link with the flight controller.
116+
Set up a simulated vehicle
117+
--------------------------
118+
The best way to prototype apps for drones is to use a simulated vehicle. APM provides a Software-In-The-Loop (SITL) environment, which simulates a copter or plane, in Linux.
119+
120+
If you want to test your app in real life, you should also grab a ready to fly copter from the `3D Robotics Store <http://store.3drobotics.com>`_.
121+
122+
123+
124+
Dependencies
125+
~~~~~~~~~~~~
126+
127+
If you are using Mac OSX or Windows, you need to set up a virtual Linux machine to run SITL.
128+
129+
A popular virtual machine manager for running SITL is `Virtual Box <https://www.virtualbox.org/>`_. A virtual machine running Ubuntu Linux 13.04 or later works great.
130+
131+
132+
Set up SITL on Linux
133+
~~~~~~~~~~~~~~~~~~~~
125134

126-
You can see `instructions here <http://dev.ardupilot.com/wiki/companion-computers/>`_ for how to set up your companion computer.
135+
Please see `instructions here <http://dev.ardupilot.com/wiki/setting-up-sitl-on-linux/>`_ to set up SITL on Ubuntu.
127136

128-
Congrats! You've set up DroneKit on your computer. Next we'll look at running your first app.
137+
Once you have the simulated vehicle running, enter the following commands. (You only have to do this once)
138+
139+
1. Load a default set of parameters
140+
2. Disable the arming check
141+
142+
::
143+
144+
STABILIZE>param load ../Tools/autotest/copter_params.parm
145+
STABILIZE>param set ARMING_CHECK 0
129146

147+
Congrats! You've set up DroneKit and a simulator on your computer. Next we'll look at running your first app.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Contents:
1818
:maxdepth: 2
1919

2020
getting_started
21+
Supported Companion Computers <http://dev.ardupilot.com/wiki/companion-computers>
2122
first_app
2223
example_1
2324
example_2

0 commit comments

Comments
 (0)