Skip to main content

__init__

CarClient.__init__(ip="", port=41451, timeout_value=3600)
No description provided!
All car-specific methods accept an optional robot_name. If omitted, calls apply to the first robot configured in the simulation settings (alphabetical order).

rotate

CarClient.rotate(rate, duration, robot_name="")
No description provided!

setCarControls

CarClient.setCarControls(controls, robot_name="")
Control the car using throttle, steering, brake, etc.
Arguments
controls
CarControls
(CarControls): Struct containing control values
robot_name
str, optional
Name of robot to be controlled

enableCarSpeedControl

CarClient.enableCarSpeedControl(status, robot_name = "")
Enable or disable speed control for the car.
Arguments
status
bool
True to enable, false to disable.
robot_name
str, optional
Name of the robot

setCarTargetSpeed

CarClient.setCarTargetSpeed(speed, robot_name = "")
Set a target speed for the car.
Arguments
speed
float
Target speed in m/s
robot_name
str, optional
Name of robot to be controlled

getCarState

CarClient.getCarState(robot_name="")
The position inside the returned CarState is in the frame of the robot’s starting point
Arguments
robot_name
str, optional
Name of robot
Returns
CarState
CarState
CarState

getCarControls

CarClient.getCarControls(robot_name="")
No description provided!
Arguments
robot_name
str, optional
Name of robot
Returns
CarControls
CarControls
CarControls

moveOnPath

CarClient.moveOnPath( path, velocity, lookahead=-1, adaptive_lookahead=1, orientations=[], robot_name="" )
Command the car to move along a specified path.This function sends commands to a car to follow a given path at a specified velocity. The path is a list of 3D vectors, and each vector represents a point in space that the car should follow.
Arguments
path
List[Vector3r]
A list of 3D vectors representing the path to follow.
velocity
float
The speed at which the car should move along the path, in meters per second.
timeout_sec
float, optional
The maximum time allowed for the car to reach the destination, in seconds. Defaults to 3e38.
lookahead
int, optional
The number of points the car should look ahead on the path for control decisions. Defaults to -1, which means no specific lookahead.
adaptive_lookahead
bool, optional
Whether to adjust the lookahead dynamically based on the car’s speed. Defaults to True.
orientations
Optional[List[Quarterion]], optional
Optional list of orientations corresponding to each path point. Defaults to empty.
robot_name
str, optional
The name of the robot being controlled, if applicable. Defaults to "".