Skip to content

Commit 03fe7a4

Browse files
committed
docs(apis): lowercase microsoft org links and fix PythonClient// paths
Normalize github.com/Microsoft/AirSim → microsoft and collapse double-slash PythonClient tree URLs so example links resolve. AI-assisted; human-reviewed.
1 parent d109f0d commit 03fe7a4

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

docs/apis.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ First install this package:
1212
pip install msgpack-rpc-python
1313
```
1414

15-
You can either get AirSim binaries from [releases](https://github.com/Microsoft/AirSim/releases) or compile from the source ([Windows](build_windows.md), [Linux](build_linux.md)). Once you can run AirSim, choose Car as vehicle and then navigate to `PythonClient\car\` folder and run:
15+
You can either get AirSim binaries from [releases](https://github.com/microsoft/AirSim/releases) or compile from the source ([Windows](build_windows.md), [Linux](build_linux.md)). Once you can run AirSim, choose Car as vehicle and then navigate to `PythonClient\car\` folder and run:
1616

1717
```
1818
python hello_car.py
@@ -125,13 +125,13 @@ for response in responses:
125125
* `simGetObjectPose`, `simSetObjectPose`: Gets and sets the pose of specified object in Unreal environment. Here the object means "actor" in Unreal terminology. They are searched by tag as well as name. Please note that the names shown in UE Editor are *auto-generated* in each run and are not permanent. So if you want to refer to actor by name, you must change its auto-generated name in UE Editor. Alternatively you can add a tag to actor which can be done by clicking on that actor in Unreal Editor and then going to [Tags property](https://answers.unrealengine.com/questions/543807/whats-the-difference-between-tag-and-tag.html), click "+" sign and add some string value. If multiple actors have same tag then the first match is returned. If no matches are found then NaN pose is returned. The returned pose is in NED coordinates in SI units in the world frame. For `simSetObjectPose`, the specified actor must have [Mobility](https://docs.unrealengine.com/en-us/Engine/Actors/Mobility) set to Movable or otherwise you will get undefined behavior. The `simSetObjectPose` has parameter `teleport` which means object is [moved through other objects](https://www.unrealengine.com/en-US/blog/moving-physical-objects) in its way and it returns true if move was successful
126126

127127
### Image / Computer Vision APIs
128-
AirSim offers comprehensive images APIs to retrieve synchronized images from multiple cameras along with ground truth including depth, disparity, surface normals and vision. You can set the resolution, FOV, motion blur etc parameters in [settings.json](settings.md). There is also API for detecting collision state. See also [complete code](https://github.com/Microsoft/AirSim/tree/main/Examples/DataCollection/StereoImageGenerator.hpp) that generates specified number of stereo images and ground truth depth with normalization to camera plane, computation of disparity image and saving it to [pfm format](pfm.md).
128+
AirSim offers comprehensive images APIs to retrieve synchronized images from multiple cameras along with ground truth including depth, disparity, surface normals and vision. You can set the resolution, FOV, motion blur etc parameters in [settings.json](settings.md). There is also API for detecting collision state. See also [complete code](https://github.com/microsoft/AirSim/tree/main/Examples/DataCollection/StereoImageGenerator.hpp) that generates specified number of stereo images and ground truth depth with normalization to camera plane, computation of disparity image and saving it to [pfm format](pfm.md).
129129

130130
More on [image APIs and Computer Vision mode](image_apis.md).
131131
For vision problems that can benefit from domain randomization, there is also an [object retexturing API](retexturing.md), which can be used in supported scenes.
132132

133133
### Pause and Continue APIs
134-
AirSim allows to pause and continue the simulation through `pause(is_paused)` API. To pause the simulation call `pause(True)` and to continue the simulation call `pause(False)`. You may have scenario, especially while using reinforcement learning, to run the simulation for specified amount of time and then automatically pause. While simulation is paused, you may then do some expensive computation, send a new command and then again run the simulation for specified amount of time. This can be achieved by API `continueForTime(seconds)`. This API runs the simulation for the specified number of seconds and then pauses the simulation. For example usage, please see [pause_continue_car.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//car/pause_continue_car.py) and [pause_continue_drone.py](https://github.com/Microsoft/AirSim/tree/main/PythonClient//multirotor/pause_continue_drone.py).
134+
AirSim allows to pause and continue the simulation through `pause(is_paused)` API. To pause the simulation call `pause(True)` and to continue the simulation call `pause(False)`. You may have scenario, especially while using reinforcement learning, to run the simulation for specified amount of time and then automatically pause. While simulation is paused, you may then do some expensive computation, send a new command and then again run the simulation for specified amount of time. This can be achieved by API `continueForTime(seconds)`. This API runs the simulation for the specified number of seconds and then pauses the simulation. For example usage, please see [pause_continue_car.py](https://github.com/microsoft/AirSim/tree/main/PythonClient/car/pause_continue_car.py) and [pause_continue_drone.py](https://github.com/microsoft/AirSim/tree/main/PythonClient/multirotor/pause_continue_drone.py).
135135

136136

137137
### Collision API
@@ -180,9 +180,9 @@ class WeatherParameter:
180180
Fog = 7
181181
```
182182

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

185-
Please see [example code](https://github.com/Microsoft/AirSim/blob/main/PythonClient/environment/weather.py) for more details.
185+
Please see [example code](https://github.com/microsoft/AirSim/blob/main/PythonClient/environment/weather.py) for more details.
186186

187187
### Recording APIs
188188

@@ -210,7 +210,7 @@ wind = airsim.Vector3r(20, 0, 0)
210210
client.simSetWind(wind)
211211
```
212212

213-
Also see example script in [set_wind.py](https://github.com/Microsoft/AirSim/blob/main/PythonClient/multirotor/set_wind.py)
213+
Also see example script in [set_wind.py](https://github.com/microsoft/AirSim/blob/main/PythonClient/multirotor/set_wind.py)
214214

215215
### Lidar APIs
216216
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).
@@ -294,12 +294,12 @@ See the [Adding New APIs](adding_new_apis.md) page
294294
## References and Examples
295295

296296
* [C++ API Examples](apis_cpp.md)
297-
* [Car Examples](https://github.com/Microsoft/AirSim/tree/main/PythonClient//car)
298-
* [Multirotor Examples](https://github.com/Microsoft/AirSim/tree/main/PythonClient//multirotor)
299-
* [Computer Vision Examples](https://github.com/Microsoft/AirSim/tree/main/PythonClient//computer_vision)
300-
* [Move on Path](https://github.com/Microsoft/AirSim/wiki/moveOnPath-demo) demo showing video of fast multirotor flight through Modular Neighborhood environment
301-
* [Building a Hexacopter](https://github.com/Microsoft/AirSim/wiki/hexacopter)
302-
* [Building Point Clouds](https://github.com/Microsoft/AirSim/wiki/Point-Clouds)
297+
* [Car Examples](https://github.com/microsoft/AirSim/tree/main/PythonClient/car)
298+
* [Multirotor Examples](https://github.com/microsoft/AirSim/tree/main/PythonClient/multirotor)
299+
* [Computer Vision Examples](https://github.com/microsoft/AirSim/tree/main/PythonClient/computer_vision)
300+
* [Move on Path](https://github.com/microsoft/AirSim/wiki/moveOnPath-demo) demo showing video of fast multirotor flight through Modular Neighborhood environment
301+
* [Building a Hexacopter](https://github.com/microsoft/AirSim/wiki/hexacopter)
302+
* [Building Point Clouds](https://github.com/microsoft/AirSim/wiki/Point-Clouds)
303303

304304

305305
## FAQ

0 commit comments

Comments
 (0)