update doc links
This commit is contained in:
madratman
Родитель
ab9e9868a3
Коммит
c5615c6829
|
|
@ -2,7 +2,7 @@
|
|||
We added some new APIs (marked with 💚) to [AirSim](https://github.com/Microsoft/Airsim) for the NeurIPS competition binaries.
|
||||
|
||||
#### Loading Unreal Engine environments
|
||||
- [`simLoadLevel(level_name)`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simLoadLevel) 💚
|
||||
- [`simLoadLevel(level_name)`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simLoadLevel) 💚
|
||||
Possible values for `level_name` are:
|
||||
- `Soccer_Field_Easy`
|
||||
- `Soccer_Field_Medium`
|
||||
|
|
@ -23,78 +23,78 @@ Note that any race tier can be run for any level, irrespective of the `Tier_N` s
|
|||
|
||||
#### Race APIs:
|
||||
- Start a race:
|
||||
[`simStartRace(tier=1/2/3)`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simStartRace) 💚
|
||||
[`simStartRace(tier=1/2/3)`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.simStartRace) 💚
|
||||
|
||||
- Reset race:
|
||||
[`simResetRace()`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simResetRace) 💚
|
||||
[`simResetRace()`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.simResetRace) 💚
|
||||
|
||||
- Check if racer is disqualified:
|
||||
[`simIsRacerDisqualified()`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simIsRacerDisqualified) 💚
|
||||
[`simIsRacerDisqualified()`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.simIsRacerDisqualified) 💚
|
||||
|
||||
- Get index of last gate passed:
|
||||
[`simGetLastGatePassed()`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simGetLastGatePassed) 💚
|
||||
[`simGetLastGatePassed()`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.simGetLastGatePassed) 💚
|
||||
|
||||
- Disable generation of logfiles by race APIs:
|
||||
[`simDisableRaceLog`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simDisableRaceLog) 💚
|
||||
[`simDisableRaceLog`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.simDisableRaceLog) 💚
|
||||
|
||||
#### Lower level control APIs:
|
||||
- FPV like Angle rate setpoint APIs:
|
||||
- [`moveByAngleRatesThrottleAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByAngleRatesThrottleAsync) 💚
|
||||
- [`moveByAngleRatesZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByAngleRatesZAsync) 💚 (stabilizes altitude)
|
||||
- [`moveByAngleRatesThrottleAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByAngleRatesThrottleAsync) 💚
|
||||
- [`moveByAngleRatesZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByAngleRatesZAsync) 💚 (stabilizes altitude)
|
||||
|
||||
- Angle setpoint APIs:
|
||||
- [`moveByRollPitchYawThrottleAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawThrottleAsync) 💚
|
||||
- [`moveByRollPitchYawZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawZAsync) 💚 (stabilizes altitude)
|
||||
- [`moveByRollPitchYawThrottleAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawThrottleAsync) 💚
|
||||
- [`moveByRollPitchYawZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawZAsync) 💚 (stabilizes altitude)
|
||||
|
||||
- RollPitchYawrate setpoint APIs:
|
||||
- [`moveByRollPitchYawrateThrottleAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawrateThrottleAsync) 💚
|
||||
- [`moveByRollPitchYawrateZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawrateZAsync) 💚 (stabilizes altitude)
|
||||
- [`moveByRollPitchYawrateThrottleAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawrateThrottleAsync) 💚
|
||||
- [`moveByRollPitchYawrateZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByRollPitchYawrateZAsync) 💚 (stabilizes altitude)
|
||||
|
||||
#### Medium level control APIs:
|
||||
- Velocity setpoints
|
||||
- [`moveByVelocityAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByVelocityAsync)
|
||||
- [`moveByVelocityZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveByVelocityZAsync) (stabilizes altitude)
|
||||
- [`moveByVelocityAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByVelocityAsync)
|
||||
- [`moveByVelocityZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveByVelocityZAsync) (stabilizes altitude)
|
||||
|
||||
- Position setpoints
|
||||
- [`moveToPosition`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveToPositionAsync)
|
||||
- [`moveOnPath`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveOnPathAsync)
|
||||
- [`moveToZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveToZAsync)
|
||||
- [`moveToPosition`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveToPositionAsync)
|
||||
- [`moveOnPath`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveOnPathAsync)
|
||||
- [`moveToZAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveToZAsync)
|
||||
|
||||
#### High level control APIs:
|
||||
- Minimum jerk trajectory planning (using [ethz-asl/mav_trajectory_generation](https://github.com/ethz-asl/mav_trajectory_generation)), and trajectory tracking (using a pure pursuit like controller minimizing position and velocity errors), with position setpoints.
|
||||
Optionally use the `*lookahead*` parameters to start new trajectory from a point sampled `n` seconds ahead for trajectory being tracked currently.
|
||||
- [`moveOnSplineAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveOnSplineAsync) 💚
|
||||
- [`moveOnSplineAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveOnSplineAsync) 💚
|
||||
|
||||
- Minimum jerk trajectory planning (using [ethz-asl/mav_trajectory_generation](https://github.com/ethz-asl/mav_trajectory_generation)), and trajectory tracking (using a pure pursuit like controller minimizing position and velocity errors), with position setpoints and corresponding velocity constraints. Useful for making a drone go through a gate waypoint, while obeying speed and direction constraints.
|
||||
Optionally use the `*lookahead*` parameters to start new trajectory from a point sampled `n` seconds ahead for trajectory being tracked currently.
|
||||
- [`moveOnSplineVelConstraintsAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.moveOnSplineVelConstraintsAsync) 💚
|
||||
- [`moveOnSplineVelConstraintsAsync`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.moveOnSplineVelConstraintsAsync) 💚
|
||||
|
||||
- Clear and stop following current trajectory.
|
||||
- [`clearTrajectory`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.clearTrajectory) 💚
|
||||
- [`clearTrajectory`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.clearTrajectory) 💚
|
||||
|
||||
#### Gain setter APIs:
|
||||
- [`setAngleRateControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.setAngleRateControllerGains) 💚
|
||||
- [`setAngleLevelControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.setAngleLevelControllerGains) 💚
|
||||
- [`setVelocityControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.setVelocityControllerGains) 💚
|
||||
- [`setPositionControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.setPositionControllerGains) 💚
|
||||
- [`setTrajectoryTrackerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.setTrajectoryTrackerGains) 💚
|
||||
- [`setAngleRateControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.setAngleRateControllerGains) 💚
|
||||
- [`setAngleLevelControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.setAngleLevelControllerGains) 💚
|
||||
- [`setVelocityControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.setVelocityControllerGains) 💚
|
||||
- [`setPositionControllerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.setPositionControllerGains) 💚
|
||||
- [`setTrajectoryTrackerGains`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.MultirotorClient.setTrajectoryTrackerGains) 💚
|
||||
|
||||
#### APIs to help generate gate detection datasets:
|
||||
- Object pose setter and getter:
|
||||
- [`simSetObjectPose`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simSetObjectPose)
|
||||
- [`simGetObjectPose`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simGetObjectPose)
|
||||
- [`simSetObjectPose`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simSetObjectPose)
|
||||
- [`simGetObjectPose`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simGetObjectPose)
|
||||
|
||||
- Object scale setter and getter:
|
||||
- [`simSetObjectScale`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simSetObjectScale) 💚
|
||||
- [`simGetObjectScale`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simGetObjectScale) 💚
|
||||
- [`simSetObjectScale`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simSetObjectScale) 💚
|
||||
- [`simGetObjectScale`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simGetObjectScale) 💚
|
||||
|
||||
- Object segmentation ID setter and getter:
|
||||
- [`simGetSegmentationObjectID`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simGetSegmentationObjectID)
|
||||
- [`simSetSegmentationObjectID`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simSetSegmentationObjectID)
|
||||
- [`simGetSegmentationObjectID`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simGetSegmentationObjectID)
|
||||
- [`simSetSegmentationObjectID`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simSetSegmentationObjectID)
|
||||
|
||||
- Listing all the objects in the scene:
|
||||
- [`simListSceneObjects`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simListSceneObjects) 💚
|
||||
- [`simListSceneObjects`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simListSceneObjects) 💚
|
||||
|
||||
- Gate specific APIs:
|
||||
- [`simGetNominalGateInnerDimensions`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simGetNominalGateInnerDimensions) 💚
|
||||
- [`simGetNominalGateOuterDimensions`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/api.html#airsimdroneracinglab.client.MultirotorClient.simGetNominalGateOuterDimensions) 💚
|
||||
- [`simGetNominalGateInnerDimensions`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simGetNominalGateInnerDimensions) 💚
|
||||
- [`simGetNominalGateOuterDimensions`](https://microsoft.github.io/AirSim-Drone-Racing-Lab/autoapi/airsimdroneracinglab/client/index.html#airsimdroneracinglab.client.VehicleClient.simGetNominalGateOuterDimensions) 💚
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче