зеркало из https://github.com/microsoft/AirSim.git
add faq
This commit is contained in:
Родитель
9dd8d34c05
Коммит
5b6428e838
53
README.md
53
README.md
|
@ -1,20 +1,24 @@
|
|||
# Welcome to AirSim
|
||||
|
||||
AirSim is a simulator for drones (and soon other vehicles) built on Unreal Engine. It is open-source, cross platform and supports hardware-in-loop with popular flight controllers such as Pixhawk for physically and visually realistic simulations. It is developed as an Unreal plugin that can simply be dropped in to any Unreal environment you want.
|
||||
AirSim is a simulator for drones (and soon other vehicles) built on Unreal Engine. It is open-source, cross platform and supports hardware-in-loop
|
||||
with popular flight controllers such as Pixhawk for physically and visually realistic simulations. It is developed as an Unreal plugin that can
|
||||
simply be dropped in to any Unreal environment you want.
|
||||
|
||||
Our goal is to develop AirSim as a platform for AI research to experiment with deep learning, computer vision and reinforcement learning algorithms for autonomous vehicles. For this purpose, AirSim also exposes APIs to retrieve data and control vehicles in a platform independent way.
|
||||
Our goal is to develop AirSim as a platform for AI research to experiment with deep learning, computer vision and reinforcement learning algorithms
|
||||
for autonomous vehicles. For this purpose, AirSim also exposes APIs to retrieve data and control vehicles in a platform independent way.
|
||||
|
||||
**Check out the quick 1.5 minute demo**
|
||||
|
||||
[![AirSim Demo Video](docs/images/demo_video.png)](https://youtu.be/-WfTr1-OBGQ)
|
||||
|
||||
# Development Status
|
||||
|
||||
This project is under heavy development. While we are working through our backlog of new features and known issues, we welcome contributions! Our current release is in beta and our APIs are subject to change.
|
||||
This project is under active development. While we are working through our backlog of new features and known issues, we welcome contributions!
|
||||
Our current release is in beta and our APIs are subject to change.
|
||||
|
||||
# How to Get It
|
||||
## Prerequisites
|
||||
To get the best experience you will need Pixhawk or compatible device and a RC controller. This enables the "hardware-in-loop simulation" for more realistic experience. [Follow these instructions](docs/prereq.md) on how to get it, set it up and other alternatives.
|
||||
To get the best experience you will need Pixhawk or compatible device and a RC controller. This enables the "hardware-in-loop simulation" for
|
||||
more realistic experience. [Follow these instructions](docs/prereq.md) on how to get it, set it up and other alternatives.
|
||||
|
||||
## Windows
|
||||
There are two ways to get AirSim working on your machine. Click on below links and follow the instructions.
|
||||
|
@ -23,12 +27,16 @@ There are two ways to get AirSim working on your machine. Click on below links a
|
|||
2. [Use the precompiled binaries](docs/use_precompiled.md)
|
||||
|
||||
## Linux
|
||||
The official Linux build is expected to arrive in about a couple of weeks. All our current code is cross-platform and CMake enabled so please feel free to play around on other operating systems and [report any issues](https://github.com/Microsoft/AirSim/issues). We would love to make AirSim available on other platforms as well.
|
||||
The official Linux build is expected to arrive in about a couple of weeks. All our current code is cross-platform and CMake enabled so please
|
||||
feel free to play around on other operating systems and [report any issues](https://github.com/Microsoft/AirSim/issues). We would love to make
|
||||
AirSim available on other platforms as well.
|
||||
|
||||
# How to Use It
|
||||
|
||||
## Manual flights
|
||||
Follow the steps above to build and set up the Unreal environment. Plugin your Pixhawk (or compatible device) in your USB port, turn on the RC and press the Play button in Unreal. You should be able to control the drones in the simulator with the RC and fly around. Press F1 key to view several available keyboard shortcuts.
|
||||
Follow the steps above to build and set up the Unreal environment. Plugin your Pixhawk (or compatible device) in your USB port, turn on the RC
|
||||
and press the Play button in Unreal. You should be able to control the drones in the simulator with the RC and fly around. Press F1 key to view
|
||||
several available keyboard shortcuts.
|
||||
|
||||
![record screenshot](docs/images/DroneGIF-03.gif)
|
||||
|
||||
|
@ -37,24 +45,31 @@ See [Walkthoguth Demo Video](https://youtu.be/HNWdYrtw3f0).
|
|||
[More details](docs/manual_flight.md)
|
||||
|
||||
## Gathering training data
|
||||
There are two ways you can generate training data from AirSim for deep learning. The easiest way is to simply press the record button on the lower right corner. This will start writing pose and images for each frame.
|
||||
There are two ways you can generate training data from AirSim for deep learning. The easiest way is to simply press the record button on the lower right corner.
|
||||
This will start writing pose and images for each frame.
|
||||
|
||||
![record screenshot](docs/images/record_data.png)
|
||||
|
||||
There is a [Log Viewer](docs/log_viewer.md) provided that can visualize the streams of data that are published by the simulator (and your drone).
|
||||
|
||||
If you would like more data logging capabilities and other features, [file a feature request](https://github.com/Microsoft/AirSim/issues) or contribute changes. The data logging code is pretty simple and you can modify it to your heart's desire.
|
||||
If you would like more data logging capabilities and other features, [file a feature request](https://github.com/Microsoft/AirSim/issues) or contribute changes.
|
||||
The data logging code is pretty simple and you can modify it to your heart's desire.
|
||||
|
||||
A more complex way to generate training data is by writing client code that uses our APIs. This allows you to be in full control of how, what, where and when you want to log data. See the next section for more details.
|
||||
A more complex way to generate training data is by writing client code that uses our APIs. This allows you to be in full control of how, what, where and when
|
||||
you want to log data. See the next section for more details.
|
||||
|
||||
## Programmatic control
|
||||
The AirSim exposes easy to use APIs in order to retrieve data from the drones that includes ground truth, sensor data as well as various images. It also exposes APIs to control the drones in a platform independent way. This allows you to use your code to control different drones platforms, for example, Pixhawk or DJI Matrice, without making changes as well as without having to learn internal protocols details.
|
||||
The AirSim exposes easy to use APIs in order to retrieve data from the drones that includes ground truth, sensor data as well as various images. It also exposes
|
||||
APIs to control the drones in a platform independent way. This allows you to use your code to control different drones platforms, for example, Pixhawk or DJI Matrice,
|
||||
without making changes as well as without having to learn internal protocols details.
|
||||
|
||||
These APIs are also available as a part of a separate independent cross-platform library so you can deploy them on an offboard computer on your vehicle. This way you can write and test your code in simulator and later execute it on the real drones. Transfer learning and related research is one of our focus areas.
|
||||
These APIs are also available as a part of a separate independent cross-platform library so you can deploy them on an offboard computer on your vehicle.
|
||||
This way you can write and test your code in simulator and later execute it on the real drones. Transfer learning and related research is one of our focus areas.
|
||||
|
||||
[More details](docs/apis.md)
|
||||
|
||||
# Paper
|
||||
# Participate
|
||||
## Paper
|
||||
You can get additional technical details in [our paper (work in progress)](https://www.microsoft.com/en-us/research/wp-content/uploads/2017/02/aerial-informatics-robotics-TR.pdf). Please cite this as:
|
||||
```
|
||||
@techreport{MSR-TR-2017-9,
|
||||
|
@ -66,15 +81,19 @@ You can get additional technical details in [our paper (work in progress)](https
|
|||
}
|
||||
```
|
||||
|
||||
# Contribute
|
||||
## Contribute
|
||||
We welcome contributions to help advance research frontiers.
|
||||
|
||||
- [More on our design](docs/design.md)
|
||||
- [More on our code structure](docs/code_structure.md)
|
||||
- [Contibution Guidelines](docs/contributing.md)
|
||||
|
||||
# Contact
|
||||
Joing the [AirSim group at Facebook](https://www.facebook.com/groups/1225832467530667/) to stay up to date or ask any questions.
|
||||
## Contact
|
||||
Join the [AirSim group at Facebook](https://www.facebook.com/groups/1225832467530667/) to stay up to date or ask any questions.
|
||||
|
||||
# License
|
||||
## FAQ
|
||||
|
||||
If you run into problems, check the [FAQ](docs/faq.md) and feel free to post issues on the [AirSim github](https://github.com/Microsoft/AirSim/issues).
|
||||
|
||||
## License
|
||||
This project is released under MIT License. Please review [License file](LICENSE) for more details.
|
||||
|
|
|
@ -34,7 +34,7 @@ To run the simulator, you need an environment and its very easy to create one! [
|
|||
![Unreal folder structure](images/unreal_folders.png)
|
||||
|
||||
### Enable plugin for your Unreal project
|
||||
In your Unreal project's .uproject file, add Plugins section and key *"AdditionalDependencies"* so your project file looks like this:
|
||||
In your Unreal project's .uproject file, add `Plugins` section and key `AdditionalDependencies` so your project file looks like this:
|
||||
```
|
||||
{
|
||||
"FileVersion": 3,
|
||||
|
@ -72,4 +72,6 @@ You are all ready to go now!
|
|||
|
||||
Congratulations! You are now running AirSim in your own Unreal environment.
|
||||
|
||||
Note: if you have any trouble getting drone to fly, check your [hard drive performance](hard_drive.md).
|
||||
### FAQ
|
||||
|
||||
If you run into problems, check the [FAQ](faq.md) and feel free to post issues on the [AirSim github](https://github.com/Microsoft/AirSim/issues).
|
|
@ -0,0 +1,16 @@
|
|||
|
||||
# FAQ
|
||||
|
||||
### <font color='#00007c'>Unreal editor is slow when it is not the active window</font>
|
||||
|
||||
Go to Edit/Editor Preferences, select "All Settings" and type "CPU" in the sarch box.
|
||||
It should find the setting titled "Use Less CPU when in Background", and you want to uncheck this checkbox.
|
||||
|
||||
### <font color='#00007c'>Drone doesn't fly properly, it just goes crazy</font>
|
||||
|
||||
This can be a machine performance issue, check your [hard drive performance](hard_drive.md).
|
||||
|
||||
### <font color='#00007c'>How to get cmake to use GCC 6 without making GCC 6 my default</font>
|
||||
|
||||
Add these to your cmake command line `-D CMAKE_C_COMPILER=gcc-6 -D CMAKE_CXX_COMPILER=g++-6`.
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
# Coming Soon
|
||||
Unreal Environments are highly detailed and generates very large files. We are still trying to figure out the best strategy to host these big binaries. If you would like to contribute or have any suggestions, [let us know](https://github.com/Microsoft/AirSim/issues).
|
||||
Unreal Environments are highly detailed and generates very large files. We are still trying to figure out the best strategy to host these big binaries.
|
||||
If you would like to contribute or have any suggestions, [let us know](https://github.com/Microsoft/AirSim/issues).
|
||||
|
||||
We *might* make be able to make binaries available through private channels as a one-off item to select individuals. Due to licensing restrictions, we cannot make some of our environments available as source code.
|
||||
We *might* be able to make binaries available through private channels as a one-off item to select individuals. Due to licensing
|
||||
restrictions, we cannot make some of our environments available as source code.
|
||||
|
|
Загрузка…
Ссылка в новой задаче