Skip to content

Commit

Permalink
Updated links in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
WouterJansen committed Mar 10, 2020
1 parent b98516a commit 4cc35d8
Show file tree
Hide file tree
Showing 43 changed files with 59 additions and 61 deletions.
2 changes: 1 addition & 1 deletion AirLib/include/common/AirSimSettings.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ struct AirSimSettings {
std::string settings_filename = Settings::getUserDirectoryFullPath("settings.json");
Settings& settings_json = Settings::loadJSonString("{}");
//write some settings_json in new file otherwise the string "null" is written if all settings_json are empty
settings_json.setString("SeeDocsAt", "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md");
settings_json.setString("SeeDocsAt", "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md");
settings_json.setDouble("SettingsVersion", 1.2);

//TODO: there is a crash in Linux due to settings_json.saveJSonString(). Remove this workaround after we only support Unreal 4.17
Expand Down
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What's new

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).
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://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/commits/master).

### CoSys-Lab Modifications
* Updated [ROS implementation](docs/ros.md)
Expand All @@ -26,7 +26,7 @@ Below is summarized list of important changes. This does not include minor/less
* 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
* Highly efficient [NoDisplay view mode](https://cosysgit.uantwerpen.be/sensorsimulation/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
Expand All @@ -35,7 +35,7 @@ Below is summarized list of important changes. This does not include minor/less
* [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)
* [Character Control APIs](https://cosysgit.uantwerpen.be/sensorsimulation/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)
Expand Down
2 changes: 1 addition & 1 deletion Examples/DataCollection/DataCollectorSGM_settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md",
"SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md",
"SettingsVersion": 1.2,
"SimMode": "ComputerVision",
"CameraDefaults": {
Expand Down
2 changes: 1 addition & 1 deletion Examples/DepthNav/DepthNav_settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md",
"SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md",
"SettingsVersion": 1.2,
"SimMode": "ComputerVision",
"CameraDefaults": {
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ Some examples also requires opencv.
## More Info

More information on AirSim Python APIs can be found at:
https://github.com/Microsoft/AirSim/blob/master/docs/python.md
https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/python.md

2 changes: 1 addition & 1 deletion PythonClient/airsim/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ def waitOnLastTask(timeout_sec = float('nan')):

# legacy handling
# TODO: remove below legacy wrappers in future major releases
upgrade_api_help = "\nPlease see https://github.com/Microsoft/AirSim/blob/master/docs/upgrade_apis.md for more info."
upgrade_api_help = "\nPlease see https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/upgrade_apis.md for more info."
def simGetPose(self):
logging.warning("simGetPose API is renamed to simGetVehiclePose. Please update your code." + self.upgrade_api_help)
return self.simGetVehiclePose()
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/character_control.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This script expects object available in UE environment of type AAirSimCharater
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/cv_capture.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/cv_mode.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/cv_navigate.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/getpos.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/ground_truth.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/objects.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/computer_vision/segmentation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import airsim
import cv2
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/multirotor/multi_agent_drone.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# Use below in settings.json with Blocks environment
"""
{
"SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings.md",
"SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md",
"SettingsVersion": 1.2,
"SimMode": "Multirotor",
"ClockSpeed": 1,
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/multirotor/opencv_show.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# In settings.json first activate computer vision mode:
# https://github.com/Microsoft/AirSim/blob/master/docs/image_apis.md#computer-vision-mode
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/image_apis.md#computer-vision-mode

import setup_path
import airsim
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Cars in AirSim
* Updated Unreal to 4.22

## What's New
* A ROS wrapper for multirotors is available. See [airsim_ros_pkgs](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_ros_pkgs) for the ROS API, and [airsim_tutorial_pkgs](https://github.com/microsoft/AirSim/blob/master/ros/src/airsim_tutorial_pkgs) for tutorials.
* A ROS wrapper for multirotors is available. See [airsim_ros_pkgs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_ros_pkgs) for the ROS API, and [airsim_tutorial_pkgs](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/ros/src/airsim_tutorial_pkgs) for tutorials.
* [Added sensor APIs for Barometer, IMU, GPS, Magnetometer, Distance Sensor](docs/sensors.md)
* Added support for [docker in ubuntu](docs/docker_ubuntu)
* Added Weather Effects and [APIs](docs/apis#weather-apis)
Expand Down
8 changes: 4 additions & 4 deletions Unreal/Plugins/AirSim/AirSim.uplugin
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"Version" : "1.2.0",
"VersionName": "1.2.0",
"FriendlyName": "AirSim",
"Description": "AirSim - Autonomous Aerial Vehicles Simulator Plugin",
"Description": "AirSim - Simulator Plugin",
"Category" : "Science",
"CreatedBy": "Shital Shah",
"CreatedByURL": "http://github.com/Microsoft/AirSim",
"DocsURL" : "https://github.com/Microsoft/AirSim/blob/master/README.md",
"CreatedByURL": "http://cosys-lab.uantwerpen.be/",
"DocsURL" : "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/README.md",
"MarketplaceURL" : "",
"SupportURL" : "https://github.com/Microsoft/AirSim/issues",
"SupportURL" : "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/README.md",
"EnabledByDefault" : true,
"CanContainContent": true,
"IsBetaVersion" : true,
Expand Down
2 changes: 1 addition & 1 deletion build.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ if "%VisualStudioVersion%"=="14.0" (
echo(
echo Hello there! We just upgraded AirSim to Unreal Engine 4.22 and Visual Studio 2017.
echo Here are few easy steps for upgrade so everything is new and shiny:
echo https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md
echo https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/unreal_upgrade.md
goto :buildfailed_nomsg
)

Expand Down
4 changes: 2 additions & 2 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ if [[ ! -d "llvm-source-50" ]]; then
if [[ -d "llvm-source-39" ]]; then
echo "Hello there! We just upgraded AirSim to Unreal Engine 4.22."
echo "Here are few easy steps for upgrade so everything is new and shiny :)"
echo "https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md"
echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/unreal_upgrade.md"
exit 1
else
echo "The llvm-souce-50 folder was not found! Mystery indeed."
Expand Down Expand Up @@ -125,7 +125,7 @@ echo "If you are using your own environment, update plugin using,"
echo "rsync -a --delete Unreal/Plugins path/to/MyUnrealProject"
echo ""
echo "For help see:"
echo "https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md"
echo "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md"
echo "=================================================================="


Expand Down
2 changes: 1 addition & 1 deletion cmake/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# You should NOT use this with Unreal.
# If you want bits that work in Unreal you need to use ../build.sh
# For pre-requisite tools needed to run this script see
# https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md

# First get the location of this script, it is assumed you already cloned "main" and you are running the
# script from that repo. It will then put everything else in a ROS workspace at "../catkin_ws"
Expand Down
2 changes: 1 addition & 1 deletion cmake/gcc_build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# You should NOT use this with Unreal.
# If you want bits that work in Unreal you need to use ../build.sh
# For pre-requisite tools needed to run this script see
# https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md
# https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/build_linux.md

# First get the location of this script, it is assumed you already cloned "main" and you are running the
# script from that repo. It will then put everything else in a ROS workspace at "../catkin_ws"
Expand Down
2 changes: 1 addition & 1 deletion docker/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"SeeDocsAt": "https://github.com/Microsoft/AirSim/blob/master/docs/settings_json.md",
"SeeDocsAt": "https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/settings.md",
"SettingsVersion": 1.2,
"SimMode": "Multirotor",
"ClockSpeed": 1.0,
Expand Down
4 changes: 2 additions & 2 deletions docs/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ AirSim allows to pause and continue the simulation through `pause(is_paused)` AP
The collision information can be obtained using `simGetCollisionInfo` API. This call returns a struct that has information not only whether collision occurred but also collision position, surface normal, penetration depth and so on.

### Time of Day API
AirSim assumes there exist sky sphere of class `EngineSky/BP_Sky_Sphere` in your environment with [ADirectionalLight actor](https://github.com/Microsoft/AirSim/blob/master/Unreal/Plugins/AirSim/Source/SimMode/SimModeBase.cpp#L156). By default, the position of the sun in the scene doesn't move with time. You can use [settings](settings.md#timeofday) to set up latitude, longitude, date and time which AirSim uses to compute the position of sun in the scene.
AirSim assumes there exist sky sphere of class `EngineSky/BP_Sky_Sphere` in your environment with [ADirectionalLight actor](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/Unreal/Plugins/AirSim/Source/SimMode/SimModeBase.cpp#L156). By default, the position of the sun in the scene doesn't move with time. You can use [settings](settings.md#timeofday) to set up latitude, longitude, date and time which AirSim uses to compute the position of sun in the scene.

You can also use following API call to set the sun position according to given date time:

Expand Down Expand Up @@ -176,7 +176,7 @@ class WeatherParameter:

Please note that `Roadwetness`, `RoadSnow` and `RoadLeaf` effects requires adding [materials](https://github.com/Microsoft/AirSim/tree/master/Unreal/Plugins/AirSim/Content/Weather/WeatherFX) to your scene.

Please see [example code](https://github.com/Microsoft/AirSim/blob/master/PythonClient/computer_vision/weather.py) for more details.
Please see [example code](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/PythonClient/computer_vision/weather.py) for more details.

### Lidar APIs
AirSim offers API to retrieve point cloud data from Lidar sensors on vehicles. You can set the number of channels, points per second, horizontal and vertical FOV, etc parameters in [settings.json](settings.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/apis_cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Here's how to use AirSim APIs using Python to control simulated car (see also [P

```cpp

// ready to run example: https://github.com/Microsoft/AirSim/blob/master/HelloCar/main.cpp
// ready to run example: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/HelloCar/main.cpp

#include <iostream>
#include "vehicles/car/api/CarRpcLibClient.hpp"
Expand Down Expand Up @@ -54,7 +54,7 @@ Here's how to use AirSim APIs using Python to control simulated car (see also [P

```cpp

// ready to run example: https://github.com/Microsoft/AirSim/blob/master/HelloDrone/main.cpp
// ready to run example: https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/HelloDrone/main.cpp

#include <iostream>
#include "vehicles/multirotor/api/MultirotorRpcLibClient.hpp"
Expand Down
2 changes: 1 addition & 1 deletion docs/build_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The current recommended and tested environment is **Ubuntu 16.04 LTS**. Theoreti
We've two options - you can either build inside docker containers or your host machine.

## Docker
Please see instructions [here](https://github.com/Microsoft/AirSim/blob/master/docs/docker_ubuntu.md)
Please see instructions [here](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/docs/docker_ubuntu.md)

## Host machine

Expand Down
2 changes: 1 addition & 1 deletion docs/custom_drone.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ You can run the MavlinkCom library and MavLinkTest app to test the connection
between your companion computer and flight controller.

## How Does This Work?
AirSim uses MavLinkCom component developed by @lovettchris. The MavLinkCom has a proxy architecture where you can open a connection to PX4 either using serial or UDP and then other components share this connection. When PX4 sends MavLink message, all components receive that message. If any component sends a message then it's received by PX4 only. This allows you to connect any number of components to PX4 [This code](https://github.com/Microsoft/AirSim/blob/master/AirLib/include/vehicles/multirotor/controllers/MavLinkDroneController.hpp#L793) opens a connection for LogViewer and QGC. You can add something more if you like.
AirSim uses MavLinkCom component developed by @lovettchris. The MavLinkCom has a proxy architecture where you can open a connection to PX4 either using serial or UDP and then other components share this connection. When PX4 sends MavLink message, all components receive that message. If any component sends a message then it's received by PX4 only. This allows you to connect any number of components to PX4 [This code](https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/blob/master/AirLib/include/vehicles/multirotor/controllers/MavLinkDroneController.hpp#L793) opens a connection for LogViewer and QGC. You can add something more if you like.

If you want to use QGC + AirSim together than you will need QGC to let own the serial port. QGC opens up TCP connection that acts as a proxy so any other component can connect to QGC and send MavLinkMessage to QGC and then QGC forwards that message to PX4. So you tell AirSim to connect to QGC and let QGC own serial port.

Expand Down
Loading

0 comments on commit 4cc35d8

Please sign in to comment.