From 30e7014aac8d68380b1f59c7e7fee64dd241a4cb Mon Sep 17 00:00:00 2001 From: Shital Shah Date: Mon, 13 Nov 2017 00:07:26 -0800 Subject: [PATCH] coordinates system update, ref to Jim's video, how to rebuild --- PythonClient/PythonClient.pyproj | 2 +- README.md | 11 ++++++++--- docs/apis.md | 3 +++ docs/unreal_custenv.md | 12 ++++++++++-- 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/PythonClient/PythonClient.pyproj b/PythonClient/PythonClient.pyproj index 7b298ae4ee..f827b93c67 100644 --- a/PythonClient/PythonClient.pyproj +++ b/PythonClient/PythonClient.pyproj @@ -5,7 +5,7 @@ 2.0 e2049e20-b6dd-474e-8bca-1c8dc54725aa . - drive_straight.py + hello_car.py . diff --git a/README.md b/README.md index 10b9667030..1e636474e3 100644 --- a/README.md +++ b/README.md @@ -89,14 +89,19 @@ We welcome contributions to help advance research frontiers. * [More on code structure](docs/code_structure.md) * [Contribution Guidelines](docs/contributing.md) -### Contact + +### Who is Using AirSim? + +We are [maintaining list](docs/who_is_using.md) of few projects, people and groups that we are aware of. If you had like to be featured in this list please [add request here](https://github.com/microsoft/airsim/issues). + +## Contact Join the [AirSim group at Facebook](https://www.facebook.com/groups/1225832467530667/) to stay up to date or ask any questions. -### FAQ +## 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 +## License This project is released under MIT License. Please review [License file](LICENSE) for more details. diff --git a/docs/apis.md b/docs/apis.md index 1a7b6218bb..8b88f85bed 100644 --- a/docs/apis.md +++ b/docs/apis.md @@ -96,6 +96,9 @@ More on [image APIs and Computer Vision mode](image_apis.md). * `isApiControlEnabled`: Returns true if API control is established. If false (which is default) then API calls would be ignored. After a successful call to `enableApiControl`, the `isApiControlEnabled` should return true. * `ping`: If connection is established then this call will return true otherwise it will be blocked until timeout. +### Coordinate System +All AirSim API uses NED coordinate system, i.e., +X is North, +Y is East and +Z is Down. All units are in SI system. Please note that this is different from coordinate system used internally by Unreal Engine. In Unreal Engine, +Z is up instead of down and length unit is in centimeters instead of meters. AirSim APIs takes care of the appropriate conversions. The starting point of the vehicle is always coordinates (0, 0, 0) in NED system. Thus when converting from Unreal coordinates to NED, we first subtract the starting offset and then scale by 100 for cm to m conversion. + ### APIs for Car Car has followings APIs available: diff --git a/docs/unreal_custenv.md b/docs/unreal_custenv.md index 47b184b9dd..32a5ee5111 100644 --- a/docs/unreal_custenv.md +++ b/docs/unreal_custenv.md @@ -1,5 +1,7 @@ # Creating and Setting Up Unreal Environment -This page contains the complete instructions start to finish for setting up Unreal environment with AirSim. For demonstration, we will use a freely downloadable environment from [Unreal Marketplace](https://www.unrealengine.com/marketplace) called Landscape Mountain but the steps are same for any other environments. You can also view these steps performed in [Unreal AirSim Setup Video](https://youtu.be/1oY8Qu5maQQ). +This page contains the complete instructions start to finish for setting up Unreal environment with AirSim. The Unreal Marketplace has [several environment](https://www.unrealengine.com/marketplace/content-cat/assets/environments) available that you can start using in just few minutes. It is also possible to use environments available on websites such as [turbosquid.com](https://www.turbosquid.com/) or [cgitrader.com](https://www.cgtrader.com/) with bit more effort (here's [tutorial video](https://www.youtube.com/watch?v=y09VbdQWvQY&feature)). + +Below we will use a freely downloadable environment from Unreal Marketplace called Landscape Mountain but the steps are same for any other environments. You can also view these steps performed in [Unreal AirSim Setup Video](https://youtu.be/1oY8Qu5maQQ). ## Note for Linux Users There is no `Epic Games Launcher` for Linux which means that if you need to create custom environment, you will need Windows machine to do that. Once you have Unreal project folder, just copy it over to your Linux machine. @@ -41,7 +43,6 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea "MacNoEditor", "WindowsNoEditor" ], - "EpicSampleNameHash": "1226740271", "Plugins": [ { "Name": "AirSim", @@ -76,6 +77,13 @@ Congratulations! You are now running AirSim in your own Unreal environment. ## Chosing Your Vehicle: Car or Multirotor By default AirSim spawns multirotor. You can easily change this to car and use all of AirSim goodies. Please see [using car](using_car.md) guide. +## Updating Your Environment to Latest Version of AirSim +Once you have your environment using above instructions, you should frequently update your local AirSim code to latest version from GitHub. Below are the instructions to do this: + +1. First put [clean.bat](https://github.com/Microsoft/AirSim/blob/master/Unreal/Environments/Blocks/clean.bat) (or [clean.sh](https://github.com/Microsoft/AirSim/blob/master/Unreal/Environments/Blocks/clean.sh) for Linux users) in the root folder of your environment. Run this file to clean up all intermediate files in your Unreal project. +2. Do `git pull` in your AirSim repo followed by `build.cmd` (or `./build.sh` for Linux users). +3. Replace [your project]/Plugins folder with AirSim/Unreal/Plugins folder. +4. Right click on your .uproject file and chose "Generate Visual Studio project files" option. This is not required for Linux. ## FAQ