VehicleClient

IP address of the server, defaults to localhost

Port number of the server, defaults to 41451

Timeout value for the connection, defaults to 3600

Whether to run the client in background, defaults to False. When true, this client does not print info unless necessary.

bool

True to enable, False to disable API control

Name of the vehicle to send this command to

Name of the vehicle

If API control is enabled

True to arm, False to disarm the vehicle

Name of the vehicle to send this command to

Success

True to pause the simulation, False to release

If the simulation is paused

Time to run the simulation for

Frames to run the simulation for

Name of vehicle to get home location of

Home location of the vehicle

Name of light to change

New intensity value

True if successful, otherwise False

string of ”,” or ”, ” delimited tags to identify on which actors to perform the swap

indexes the array of textures assigned to each actor undergoing a swap

component_id

material_id

List of objects which matched the provided tags and had the texture swap perfomed

name of object to set material for

name of material to set for object

True if material was set

name of object to set material for

path to texture to set for object

True if material was set

name of object to set material for

url for texture to set for object

True if material was set

True to enable time-of-day effect, False to reset the position to original

Date & Time in %Y-%m-%d %H:%M:%S format, e.g. 2018-02-12 15:20:00

True to adjust for Daylight Savings Time

Run celestial clock faster or slower than simulation clock

Interval to update the Sun’s position

Whether or not to move the Sun

True to enable, False to disable

(WeatherParameter): Weather effect to be enabled

Intensity of the effect, Range 0-1

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

(ImageType): Type of image required

Name of the vehicle with the camera

Whether the camera is an External Camera

Whether to capture 3D images (default: False).

Whether to capture cubemap images otherwise equirectangular (default: False).

string literal of compressed png image

list[ImageType]: Images required

Name of vehicle associated with the camera

Whether to capture 3D images (default: False).

Whether to capture cubemap images otherwise equirectangular (default: False).

list[ImageResponse]

list[ImageRequest]: Images required

Name of vehicle associated with the camera

Whether the camera is an External Camera

Whether to capture 3D images (default: False).

Whether to capture cubemap images otherwise equirectangular (default: False).

list[ImageResponse]

list[Pose]: A list of poses of the vehicle, at which images are to be requested

list[ImageRequest]: Images required

Name of vehicle associated with the camera

Whether the camera is an External Camera, defaults to False

Whether to capture 3d images (default: False).

Whether to capture cubemap images otherwise equirectangular (default: False).

list[ImageResponse]

camera name

vechile name. Defaults to "".

Whether the camera is an External Camera. Defaults to False.

description

camera name

vechile name. Defaults to "".

Whether the camera is an External Camera. Defaults to False.

(GeoPoint): target point

Name of vehicle

Success

(GeoPoint): source point

(GeoPoint): target point

Success

list[GeoPoint]

Desired Unreal Engine Console command to run

Success

list[MeshPositionVertexBuffersResponse]

Name of the Vehicle to get the info of. This call will also reset the collision info (state of the vehicle) to False.

CollisionInfo

(Pose): Desired Pose pf the vehicle

Whether to ignore any collision or not

Name of the vehicle to move

Whether to set the vehicle position on ground position

(Pose): Desired Pose pf the vehicle

Whether to ignore any collision or not

Name of the vehicle to move

Whether to set the vehicle position to ground position

(GeoPoint): Desired GeoPoint of the scene

Name of the vehicle to get the Pose of

Pose

desired RGBA values from 0.0 to 1.0

Thickness of the line

Name of the vehicle to set Trace line values for

Object to get the Pose of

Pose

Name of the object(actor) to move

(Pose): Desired Pose of the object

Whether to move the object immediately without affecting their velocity

If the move was successful

Name of the object(actor) to move

(Pose): Desired Pose of the object

Whether to move the object immediately without affecting their velocity

If the move was successful

Object to get the scale of

Scale

Object to set the scale of

Desired scale of object

True if scale change was successful

Object to get the bounds of

Extents in X, Y, Z

Object to get the center of

Center position

String to match actor names against, e.g. “Cylinder.*”

List containing all the names

Name of the level to load

True if the level was successfully loaded

Names of all the assets

Desired name of new object

Name of asset(mesh) in the project database

Desired pose of object

Desired scale of object

Whether to enable physics for the object

Whether to spawn a blueprint or an actor

Name of spawned object, in case it had to be modified

Desired name of new object

Name of asset(mesh) in the project database

Desired pose of object

Desired scale of object

Whether to enable physics for the object

Whether to spawn a blueprint or an actor

True if object was spawned, False otherwise

Desired name of new object

Name of asset(mesh) in the project database

Desired pose of object

Desired scale of object

Whether to enable physics for the object

Whether to spawn a blueprint or an actor

True if object was spawned, False otherwise

Name of object to be removed

True if object is queued up for removal

Name of the mesh to set the ID of (supports regex)

Object ID to be set, range 0-255.

Whether the mesh name is a regex. If True, all meshes matching the regex will be set to the same ID

If the mesh was found

Name of the mesh to set the ID of (supports regex)

start of instance ID to be set, range 0-255. Gets incremented each time for each instance (mesh)

Whether the mesh name is a regex

number of instances (meshes) matched with mesh_id updated

Name of the mesh to get the ID of

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

(ImageType): Type of image required

mesh name in wild card format

Vehicle which the camera is associated with

Whether the camera is an External Camera

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

(ImageType): Type of image required

Radius in [cm]

Vehicle which the camera is associated with

Whether the camera is an External Camera

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

(ImageType): Type of image required

Vehicle which the camera is associated with

Whether the camera is an External Camera

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

(ImageType): Type of image required

Vehicle which the camera is associated with

Whether the camera is an External Camera

array

Message to be printed

Parameter to be printed next to the message

Range 0-3, inclusive, corresponding to the severity of the message

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

Vehicle which the camera is associated with

Whether the camera is an External Camera

CameraInfo

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

Vehicle which the camera is associated with

Whether the camera is an External Camera

(float): List of distortion parameter values corresponding to K1, K2, K3, P1, P2 respectively.

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

Dictionary of distortion param names and corresponding values

Vehicle which the camera is associated with

Whether the camera is an External Camera

Name of the camera, for backwards compatibility, ID numbers such as 0,1,etc. can also be used

Name of distortion parameter

Value of distortion parameter

Vehicle which the camera is associated with

Whether the camera is an External Camera

Name of the camera to be controlled

(Pose): Pose representing the desired position and orientation of the camera

Name of vehicle which the camera corresponds to

Whether the camera is an External Camera

Name of the camera to be controlled

Value of field of view in degrees

Name of vehicle which the camera corresponds to

Whether the camera is an External Camera

Name of the camera to be controlled

(Pose): Pose representing the desired position the camera has to observe

Name of vehicle which the camera corresponds to

Whether the camera is an External Camera

Name of the vehicle

Ground truth of the vehicle

(KinematicsState): Desired Pose pf the vehicle

Whether to ignore any collision or not

Name of the vehicle to move

Name of the vehicle

Ground truth environment state

Name of IMU to get data from, specified in settings.json

Name of vehicle to which the sensor corresponds to

ImuData

Name of Barometer to get data from, specified in settings.json

Name of vehicle to which the sensor corresponds to

BarometerData

Name of Magnetometer to get data from, specified in settings.json

Name of vehicle to which the sensor corresponds to

MagnetometerData

Name of GPS to get data from, specified in settings.json

Name of vehicle to which the sensor corresponds to

GpsData

Name of Distance Sensor to get data from, specified in settings.json

Name of vehicle to which the sensor corresponds to

DistanceSensorData

Name of Lidar to get data from, specified in settings.json

Name of vehicle to which the sensor corresponds to

LidarData

Name of Lidar sensor

Name of the vehicle wth the sensor

Segmentation IDs of the objects

list[Vector3r]: List of Vector3r objects

desired RGBA values from 0.0 to 1.0

Size of plotted point

Duration (seconds) to plot for

If set to True, the desired object will be plotted for infinite time.

list[Vector3r]: List of 3D locations of line start and end points, specified as Vector3r objects

desired RGBA values from 0.0 to 1.0

Thickness of line

Duration (seconds) to plot for

If set to True, the desired object will be plotted for infinite time.

list[Vector3r]: List of 3D locations of line start and end points, specified as Vector3r objects. Must be even

desired RGBA values from 0.0 to 1.0

Thickness of line

Duration (seconds) to plot for

If set to True, the desired object will be plotted for infinite time.

list[Vector3r]: List of 3D start positions of arrow start positions, specified as Vector3r objects

list[Vector3r]: List of 3D end positions of arrow start positions, specified as Vector3r objects

desired RGBA values from 0.0 to 1.0

Thickness of line

Size of arrow head

Duration (seconds) to plot for

If set to True, the desired object will be plotted for infinite time.

List of strings to plot

list[Vector3r]: List of positions where the strings should be plotted. Should be in one-to-one correspondence with the strings’ list

Font scale of transform name

desired RGBA values from 0.0 to 1.0

Duration (seconds) to plot for

list[Pose]: List of Pose objects representing the transforms to plot

Length of transforms’ axes

Thickness of transforms’ axes

Duration (seconds) to plot for

If set to True, the desired object will be plotted for infinite time.

list[Pose]: List of Pose objects representing the transforms to plot