forked from microsoft/AirSim
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] see full commit msg for details
- move all remaining docs to docs/ folder - index them in mkdocs/nav - move mkdocs.yml to root folder to fix nested docs/ dir issue - add ros, mavlinkcom, mavlinkcom mocap, domain randomization, mesh vertex buffer, infrared cam, unity to gh.io page - fix srv / msg links in airsim_ros_pkgs readme
- Loading branch information
Showing
34 changed files
with
876 additions
and
919 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,116 +1,3 @@ | ||
| # What's new | ||
| # Changelog | ||
|
|
||
| Below is summarized list of important changes. This does not include minor/less important changes or bug fixes or documentation update. This list updated every few months. For complete detailed changes, please review [commit history](https://github.com/Microsoft/AirSim/commits/master). | ||
|
|
||
| ### March 2020 | ||
| * Upgraded to Unreal Engine 4.24 | ||
|
|
||
| ### November, 2018 | ||
| * Added Weather Effects and [APIs](docs/apis.md#weather-apis) | ||
| * Added [Time of Day API](docs/apis.md#time-of-day-api) | ||
| * An experimental integration of [AirSim on Unity](https://github.com/Microsoft/AirSim/tree/master/Unity) is now available. Learn more in [Unity blog post](https://blogs.unity3d.com/2018/11/14/airsim-on-unity-experiment-with-autonomous-vehicle-simulation). | ||
| * [New environments](https://github.com/Microsoft/AirSim/releases/tag/v1.2.1): Forest, Plains (windmill farm), TalkingHeads (human head simulation), TrapCam (animal detection via camera) | ||
| * Highly efficient [NoDisplay view mode](https://github.com/Microsoft/AirSim/blob/master/docs/settings.md#viewmode) to turn off main screen rendering so you can capture images at high rate | ||
| * [Enable/disable sensors](https://github.com/Microsoft/AirSim/pull/1479) via settings | ||
| * [Lidar Sensor](docs/lidar.md) | ||
| * [Support for Flysky FS-SM100 RC](https://github.com/Microsoft/AirSim/commit/474214364676b6631c01b3ed79d00c83ba5bccf5) USB adapter | ||
| * Case Study: [Formula Student Technion Driverless](https://github.com/Microsoft/AirSim/wiki/technion) | ||
| * [Multi-Vehicle Capability](docs/multi_vehicle.md) | ||
| * [Custom speed units](https://github.com/Microsoft/AirSim/pull/1181) | ||
| * [ROS publisher](https://github.com/Microsoft/AirSim/pull/1135) | ||
| * [simSetObjectPose API](https://github.com/Microsoft/AirSim/pull/1161) | ||
| * [Character Control APIs](https://github.com/Microsoft/AirSim/blob/master/PythonClient/airsim/client.py#L137) (works on TalkingHeads binaries in release) | ||
| * [Arducopter Solo Support](https://github.com/Microsoft/AirSim/pull/1387) | ||
| * [Linux install without sudo access](https://github.com/Microsoft/AirSim/pull/1434) | ||
| * [Kinect like ROS publisher](https://github.com/Microsoft/AirSim/pull/1298) | ||
|
|
||
|
|
||
| ### June, 2018 | ||
| * Development workflow doc | ||
| * Better Python 2 compatibility | ||
| * OSX setup fixes | ||
| * Almost complete rewrite of our APIs with new threading model, merging old APIs and creating few newer ones | ||
|
|
||
| ### April, 2018 | ||
| * Upgraded to Unreal Engine 4.18 and Visual Studio 2017 | ||
| * API framework refactoring to support world-level APIs | ||
| * Latest PX4 firmware now supported | ||
| * CarState with more information | ||
| * ThrustMaster wheel support | ||
| * pause and continueForTime APIs for drone as well as car | ||
| * Allow drone simulation run at higher clock rate without any degradation | ||
| * Forward-only mode fully functional for drone (do orbits while looking at center) | ||
| * Better PID tuning to reduce wobble for drones | ||
| * Ability to set arbitrary vehicle blueprint for drone as well as car | ||
| * gimbal stabilization via settings | ||
| * Ability to segment skinned and skeletal meshes by their name | ||
| * moveByAngleThrottle API | ||
| * Car physics tuning for better maneuverability | ||
| * Configure additional cameras via settings | ||
| * Time of day with geographically computed sun position | ||
| * Better car steering via keyboard | ||
| * Added MeshNamingMethod in segmentation setting | ||
| * gimbal API | ||
| * getCameraParameters API | ||
| * Ability turn off main rendering to save GPU resources | ||
| * Projection mode for capture settings | ||
| * getRCData, setRCData APIs | ||
| * Ability to turn off segmentation using negative IDs | ||
| * OSX build improvements | ||
| * Segmentation working for very large environments with initial IDs | ||
| * Better and extensible hash calculation for segmentation IDs | ||
| * Extensible PID controller for custom integration methods | ||
| * Sensor architecture now enables renderer specific features like ray casting | ||
| * Laser altimeter sensor | ||
|
|
||
|
|
||
| ### Jan 2018 | ||
| * Config system rewrite, enable flexible config we are targeting in future | ||
| * Multi-Vehicle support Phase 1, core infrastructure changes | ||
| * MacOS support | ||
| * Infrared view | ||
| * 5 types of noise and interference for cameras | ||
| * WYSIWIG capture settings for cameras, preview recording settings in main view | ||
| * Azure support Phase 1, enable configurability of instances for headless mode | ||
| * Full kinematics APIs, ability to get pose, linear and angular velocities + accelerations via APIs | ||
| * Record multiple images from multiple cameras | ||
| * New segmentation APIs, ability to set configure object IDs, search via regex | ||
| * New object pose APIs, ability to get pose of objects (like animals) in environment | ||
| * Camera infrastructure enhancements, ability to add new image types like IR with just few lines | ||
| * Clock speed APIs for drone as well as car, simulation can be run with speed factor of 0 < x < infinity | ||
| * Support for Logitech G920 wheel | ||
| * Physics tuning of the car, Car doesn’t roll over, responds to steering with better curve, releasing gas paddle behavior more realistic | ||
| * Debugging APIs | ||
| * Stress tested to 24+ hours of continuous runs | ||
| * Support for Landscape and sky segmentation | ||
| * Manual navigation with accelerated controls in CV mode, user can explore environment much more easily | ||
| * Collison APIs | ||
| * Recording enhancements, log several new data points including ground truth, multiple images, controls state | ||
| * Planner and Perspective Depth views | ||
| * Disparity view | ||
| * New Image APIs supports float, png or numpy formats | ||
| * 6 config settings for image capture, ability to set auto-exposure, motion blur, gamma etc | ||
| * Full multi-camera support through out including sub-windows, recording, APIs etc | ||
| * Command line script to build all environments in one shot | ||
| * Remove submodules, use rpclib as download | ||
|
|
||
| ### Nov 2017 | ||
| * We now have the [car model](docs/using_car.md). | ||
| * No need to build the code. Just download [binaries](https://github.com/Microsoft/AirSim/releases) and you are good to go! | ||
| * The [reinforcement learning example](docs/reinforcement_learning.md) with AirSim | ||
| * New built-in flight controller called [simple_flight](docs/simple_flight.md) that "just works" without any additional setup. It is also now *default*. | ||
| * AirSim now also generates [depth as well as disparity images](docs/image_apis.md) that is in camera plan. | ||
| * We also have official Linux build now! | ||
|
|
||
| ## Sep 2017 | ||
| - We have added [car model](docs/using_car.md)! | ||
|
|
||
| ## Aug 2017 | ||
| - [simple_flight](docs/simple_flight.md) is now default flight controller for drones. If you want to use PX4, you will need to modify settings.json as per [PX4 setup doc](docs/px4_setup.md). | ||
| - Linux build is official and currently uses Unreal 4.17 due to various bug fixes required | ||
| - ImageType enum has breaking changes with several new additions and clarifying existing ones | ||
| - SubWindows are now configurable from settings.json | ||
| - PythonClient is now complete and has parity with C++ APIs. Some of these would have breaking changes. | ||
|
|
||
| ## Feb 2017 | ||
| - First release! | ||
| This page has moved [here](https://github.com/microsoft/AirSim/blob/master/docs/CHANGELOG.md). |
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,17 +1,3 @@ | ||
| # Contributing | ||
|
|
||
| ## Quick Start | ||
| - Please read our [short and sweet coding guidelines](docs/coding_guidelines.md). | ||
| - For big changes such as adding new feature or refactoring, [file an issue first](https://github.com/Microsoft/AirSim/issues). | ||
| - Use our [recommended development workflow](docs/dev_workflow.md) to make changes and test it. | ||
| - Use [usual steps](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) to make contributions just like other GitHub projects. If you are not familiar with Git Branch-Rebase-Merge workflow, please [read this first](http://shitalshah.com/p/git-workflow-branch-rebase-squash-merge/). | ||
|
|
||
| ## Checklist | ||
| - Use same style and formatting as rest of code even if it's not your preferred one. | ||
| - Change any documentation that goes with code changes. | ||
| - Do not include OS specific header files or new 3rd party dependencies. | ||
| - Keep your pull request small, ideally under 10 files. | ||
| - Make sure you don't include large binary files. | ||
| - When adding new includes, make dependency is absolutely necessary. | ||
| - Rebase your branch frequently with master (once every 2-3 days is ideal). | ||
| - Make sure your code would compile on Windows, Linux and OSX. | ||
| This page has moved [here](https://github.com/microsoft/AirSim/blob/master/docs/CONTRIBUTING.md). |
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,30 +1,3 @@ | ||
| # Welcome to MavLinkMoCap | ||
|
|
||
| This folder contains the MavLinkMoCap library which connects to a OptiTrack camera system | ||
| for accurate indoor location. | ||
|
|
||
| ## Dependencies: | ||
| * [OptiTrack Motive](http://www.optitrack.com/products/motive/). | ||
| * [MavLinkCom](../MavLinkCom). | ||
|
|
||
| ### Setup RigidBody | ||
|
|
||
| First you need to define a RigidBody named 'Quadrocopter' using Motive. | ||
| See [Rigid_Body_Tracking](http://wiki.optitrack.com/index.php?title=Rigid_Body_Tracking). | ||
|
|
||
| ### MavLinkTest | ||
|
|
||
| Use MavLinkTest to talk to your PX4 drone, with "-server:addr:port", for example, when connected | ||
| to drone wifi use: | ||
|
|
||
| MavLinkMoCap -server:10.42.0.228:14590 "-project:D:\OptiTrack\Motive Project 2016-12-19 04.09.42 PM.ttp" | ||
|
|
||
| This publishes the ATT_POS_MOCAP messages and you can proxy those through to the PX4 by running | ||
| MavLinkTest on the dronebrain using: | ||
|
|
||
| MavLinkTest -serial:/dev/ttyACM0,115200 -proxy:10.42.0.228:14590 | ||
|
|
||
| Now the drone will get the ATT_POS_MOCAP and you should see the light turn green meaning it is | ||
| now has a home position and is ready to fly. | ||
|
|
||
|
|
||
| This page has moved [here](https://github.com/microsoft/AirSim/blob/master/docs/mavlinkcom_mocap.md). |
Oops, something went wrong.