Skip to content

Commit 92a4145

Browse files
committed
[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
1 parent 8581b8a commit 92a4145

34 files changed

+876
-919
lines changed

CHANGELOG.md

Lines changed: 2 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,3 @@
1-
# What's new
1+
# Changelog
22

3-
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).
4-
5-
### March 2020
6-
* Upgraded to Unreal Engine 4.24
7-
8-
### November, 2018
9-
* Added Weather Effects and [APIs](docs/apis.md#weather-apis)
10-
* Added [Time of Day API](docs/apis.md#time-of-day-api)
11-
* 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).
12-
* [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)
13-
* 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
14-
* [Enable/disable sensors](https://github.com/Microsoft/AirSim/pull/1479) via settings
15-
* [Lidar Sensor](docs/lidar.md)
16-
* [Support for Flysky FS-SM100 RC](https://github.com/Microsoft/AirSim/commit/474214364676b6631c01b3ed79d00c83ba5bccf5) USB adapter
17-
* Case Study: [Formula Student Technion Driverless](https://github.com/Microsoft/AirSim/wiki/technion)
18-
* [Multi-Vehicle Capability](docs/multi_vehicle.md)
19-
* [Custom speed units](https://github.com/Microsoft/AirSim/pull/1181)
20-
* [ROS publisher](https://github.com/Microsoft/AirSim/pull/1135)
21-
* [simSetObjectPose API](https://github.com/Microsoft/AirSim/pull/1161)
22-
* [Character Control APIs](https://github.com/Microsoft/AirSim/blob/master/PythonClient/airsim/client.py#L137) (works on TalkingHeads binaries in release)
23-
* [Arducopter Solo Support](https://github.com/Microsoft/AirSim/pull/1387)
24-
* [Linux install without sudo access](https://github.com/Microsoft/AirSim/pull/1434)
25-
* [Kinect like ROS publisher](https://github.com/Microsoft/AirSim/pull/1298)
26-
27-
28-
### June, 2018
29-
* Development workflow doc
30-
* Better Python 2 compatibility
31-
* OSX setup fixes
32-
* Almost complete rewrite of our APIs with new threading model, merging old APIs and creating few newer ones
33-
34-
### April, 2018
35-
* Upgraded to Unreal Engine 4.18 and Visual Studio 2017
36-
* API framework refactoring to support world-level APIs
37-
* Latest PX4 firmware now supported
38-
* CarState with more information
39-
* ThrustMaster wheel support
40-
* pause and continueForTime APIs for drone as well as car
41-
* Allow drone simulation run at higher clock rate without any degradation
42-
* Forward-only mode fully functional for drone (do orbits while looking at center)
43-
* Better PID tuning to reduce wobble for drones
44-
* Ability to set arbitrary vehicle blueprint for drone as well as car
45-
* gimbal stabilization via settings
46-
* Ability to segment skinned and skeletal meshes by their name
47-
* moveByAngleThrottle API
48-
* Car physics tuning for better maneuverability
49-
* Configure additional cameras via settings
50-
* Time of day with geographically computed sun position
51-
* Better car steering via keyboard
52-
* Added MeshNamingMethod in segmentation setting
53-
* gimbal API
54-
* getCameraParameters API
55-
* Ability turn off main rendering to save GPU resources
56-
* Projection mode for capture settings
57-
* getRCData, setRCData APIs
58-
* Ability to turn off segmentation using negative IDs
59-
* OSX build improvements
60-
* Segmentation working for very large environments with initial IDs
61-
* Better and extensible hash calculation for segmentation IDs
62-
* Extensible PID controller for custom integration methods
63-
* Sensor architecture now enables renderer specific features like ray casting
64-
* Laser altimeter sensor
65-
66-
67-
### Jan 2018
68-
* Config system rewrite, enable flexible config we are targeting in future
69-
* Multi-Vehicle support Phase 1, core infrastructure changes
70-
* MacOS support
71-
* Infrared view
72-
* 5 types of noise and interference for cameras
73-
* WYSIWIG capture settings for cameras, preview recording settings in main view
74-
* Azure support Phase 1, enable configurability of instances for headless mode
75-
* Full kinematics APIs, ability to get pose, linear and angular velocities + accelerations via APIs
76-
* Record multiple images from multiple cameras
77-
* New segmentation APIs, ability to set configure object IDs, search via regex
78-
* New object pose APIs, ability to get pose of objects (like animals) in environment
79-
* Camera infrastructure enhancements, ability to add new image types like IR with just few lines
80-
* Clock speed APIs for drone as well as car, simulation can be run with speed factor of 0 < x < infinity
81-
* Support for Logitech G920 wheel
82-
* Physics tuning of the car, Car doesn’t roll over, responds to steering with better curve, releasing gas paddle behavior more realistic
83-
* Debugging APIs
84-
* Stress tested to 24+ hours of continuous runs
85-
* Support for Landscape and sky segmentation
86-
* Manual navigation with accelerated controls in CV mode, user can explore environment much more easily
87-
* Collison APIs
88-
* Recording enhancements, log several new data points including ground truth, multiple images, controls state
89-
* Planner and Perspective Depth views
90-
* Disparity view
91-
* New Image APIs supports float, png or numpy formats
92-
* 6 config settings for image capture, ability to set auto-exposure, motion blur, gamma etc
93-
* Full multi-camera support through out including sub-windows, recording, APIs etc
94-
* Command line script to build all environments in one shot
95-
* Remove submodules, use rpclib as download
96-
97-
### Nov 2017
98-
* We now have the [car model](docs/using_car.md).
99-
* No need to build the code. Just download [binaries](https://github.com/Microsoft/AirSim/releases) and you are good to go!
100-
* The [reinforcement learning example](docs/reinforcement_learning.md) with AirSim
101-
* New built-in flight controller called [simple_flight](docs/simple_flight.md) that "just works" without any additional setup. It is also now *default*.
102-
* AirSim now also generates [depth as well as disparity images](docs/image_apis.md) that is in camera plan.
103-
* We also have official Linux build now!
104-
105-
## Sep 2017
106-
- We have added [car model](docs/using_car.md)!
107-
108-
## Aug 2017
109-
- [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).
110-
- Linux build is official and currently uses Unreal 4.17 due to various bug fixes required
111-
- ImageType enum has breaking changes with several new additions and clarifying existing ones
112-
- SubWindows are now configurable from settings.json
113-
- PythonClient is now complete and has parity with C++ APIs. Some of these would have breaking changes.
114-
115-
## Feb 2017
116-
- First release!
3+
This page has moved [here](https://github.com/microsoft/AirSim/blob/master/docs/CHANGELOG.md).

CONTRIBUTING.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
11
# Contributing
22

3-
## Quick Start
4-
- Please read our [short and sweet coding guidelines](docs/coding_guidelines.md).
5-
- For big changes such as adding new feature or refactoring, [file an issue first](https://github.com/Microsoft/AirSim/issues).
6-
- Use our [recommended development workflow](docs/dev_workflow.md) to make changes and test it.
7-
- 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/).
8-
9-
## Checklist
10-
- Use same style and formatting as rest of code even if it's not your preferred one.
11-
- Change any documentation that goes with code changes.
12-
- Do not include OS specific header files or new 3rd party dependencies.
13-
- Keep your pull request small, ideally under 10 files.
14-
- Make sure you don't include large binary files.
15-
- When adding new includes, make dependency is absolutely necessary.
16-
- Rebase your branch frequently with master (once every 2-3 days is ideal).
17-
- Make sure your code would compile on Windows, Linux and OSX.
3+
This page has moved [here](https://github.com/microsoft/AirSim/blob/master/docs/CONTRIBUTING.md).

MavLinkCom/MavLinkMoCap/Readme.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
11
# Welcome to MavLinkMoCap
22

3-
This folder contains the MavLinkMoCap library which connects to a OptiTrack camera system
4-
for accurate indoor location.
5-
6-
## Dependencies:
7-
* [OptiTrack Motive](http://www.optitrack.com/products/motive/).
8-
* [MavLinkCom](../MavLinkCom).
9-
10-
### Setup RigidBody
11-
12-
First you need to define a RigidBody named 'Quadrocopter' using Motive.
13-
See [Rigid_Body_Tracking](http://wiki.optitrack.com/index.php?title=Rigid_Body_Tracking).
14-
15-
### MavLinkTest
16-
17-
Use MavLinkTest to talk to your PX4 drone, with "-server:addr:port", for example, when connected
18-
to drone wifi use:
19-
20-
MavLinkMoCap -server:10.42.0.228:14590 "-project:D:\OptiTrack\Motive Project 2016-12-19 04.09.42 PM.ttp"
21-
22-
This publishes the ATT_POS_MOCAP messages and you can proxy those through to the PX4 by running
23-
MavLinkTest on the dronebrain using:
24-
25-
MavLinkTest -serial:/dev/ttyACM0,115200 -proxy:10.42.0.228:14590
26-
27-
Now the drone will get the ATT_POS_MOCAP and you should see the light turn green meaning it is
28-
now has a home position and is ready to fly.
29-
30-
3+
This page has moved [here](https://github.com/microsoft/AirSim/blob/master/docs/mavlinkcom_mocap.md).

0 commit comments

Comments
 (0)