carla/Docs/adv_traffic_manager.md

17 KiB

Traffic Manager


What is it?

The Traffic Manager, TM for short, is a module built on top of the CARLA API in C++ that is in charge of controlling vehicles inside the simulation. Its goal is to populate the simulation with realistic urban traffic conditions allowing users to customize some behaviours, for example to set specific learning circumstances. To do so, every TM controls vehicles registered to it by setting autopilot to true, and is accounting for the rest by considering them unregistered.

Structured design

The TM is built on the client-side of the CARLA architecture, replacing the former server-side autopilot after version 0.9.7. The execution flow is divided in stages with independent operations and goals, to facilitate the development of phase-related functionalities and data structures, while also improving computational efficiency. Each stage runs on a different thread and communication with the rest is managed through messages facilitating synchronous messaging between the different stages, so the information flows only in one direction.

User customization

Users need to be granted some control by setting parameters that allow, force or encourage certain behaviours. Thus, users can change the traffic behaviour as they prefer, both online and offline. For example they could allow a car to ignore the speed limits or force a lane change. Being able to play around with behaviours is a must when trying to simulate reality, specially to train driving systems under specific and atypical circumstances.


How does it work?

Architecture

The following diagram is a summary of the internal architecture of the Traffic Manager. Blue bodies are the different stages, green ones are additional modules needed during the different stages and the arrows represent communication managed by messenger classes between the different elements.
The inner structure of the TM can be easily translated to code. Each relevant element has its equivalent in the C++ code (.cpp files) found inside LibCarla/source/carla/trafficmanager.

Stages

1. Localization Stage: the TM stores a list of waypoints ahead for each vehicle to follow. The buffer list of waypoints is is updated each iteration and deleted when lane changes are applied, to create a new one with the corresponding trajectory. The amount of waypoints contained in said list varies depending on the vehicle's speed, being greater the faster it goes. The localization stage contains a spacial hashing which summarizes the position for every car registered to the Traffic Manager in a world grid. This is a way to roughly predict possible collisions and create a list of overlapping actors for every vehicle that will be later used by the next stage.

  • Related .cpp files: LocalizationStage.cpp and LocalizationUtils.cpp.

2. Collision Stage: checks possible collisions for every vehicle. For each pairs of overlapping actors in the list contained by the localization stage, it extends a geodesic boundary. These are extended bounding bodies that represent the vehicle along its trajectory. Collisions between two geodesic boundaries are communicated to the Motion planner stage that will manage them.

  • Related .cpp files: CollisionStage.cpp.

3. Traffic Light Stage: manages some general traffic regulations, mainly priority at junctions. Whenever there is a traffic light, if red, a traffic hazard is set to true. Non signaled junctions are managed with a ticket system. When coming closer to these, a geodesic boundary is extended through the intersection along the vehicle's trajectory. If there is another vehicle inside of it, the parent waits for the junction to be free.

  • Related .cpp files: TrafficLightStage.cpp.

4. Motion Planner Stage: aggregates all the information gathered through the previous stages. Their guidance is adjusted with actuation signals provided by a PID controller, this stage makes decisions on how to move the vehicles. It computes all the commands needed for every vehicle and then send these to the final stage. For example, when facing a traffic hazard, this stage will compute the brake needed for said vehicle and communicate it to the apply control stage.

  • Related .cpp files: MotionPlannerStage.cpp.

5. Apply Control Stage: receives actuation signals (such as throttle, brake, steer) from the Motion Planner stage and commands these to the simulator in batches to control every vehicles' movement. It mainly uses the apply_batch() method in carla.Client and different carla.VehicleControl for the registered vehicles.

  • Related .cpp files: BatchControlStage.cpp.

Additional modules

Cached map: in order to ease computation costs during the localization stage, the map is divided into a grid of waypoints, so that these are not calculated every time. These waypoints are not the usual carla.Waypoint accessible from the API but a specific data structure designed according to the needs of the TM. The grid of waypoints representing the road map is at the same time divided into different sections, each of them representing little portions of the road, for instance a junction. These sections are numbered and connected so that it is easier to locate a vehicle on the map and to identify which vehicle are close to it.

  • Related .cpp files: InMemoryMap.cpp and SimpleWaypoint.cpp.

PID controller: the TM module contains its own PID controller to regulate throttle, brake and steering according to an intended result. The way this adjustment is made depends on the specific parametrization of the controller, which can be modified if the desired behaviour is different. Read more about PID compensation to learn how to do it.

  • Related .cpp files: PIDController.cpp.

Using the Traffic Manager

General considerations

First of all there are some general behaviour patterns the TM will generate that should be understood beforehand. These statements inherent to the way the TM is implemented:

  • Vehicles are not goal-oriented they follow a road and whenever a junction appears, choose a path randomly. Their path is endless and thus, will never stop roaming around the city.
  • Vehicles' intended speed is 70% their current speed limit: unless any other behaviour is set.
  • Lane change is currently disabled: it can be enabled through the API, though right now some issues may happen. Disabling lane changes will also ban overtakings between vehicles in the same lane.
  • Junction priority does not follow traffic regulations: the TM has a ticket system to be used while junction complexity is solved. This may cause some issues such as a vehicle inside a roundabout yielding to a vehicle trying to get in.

The TM provides with a set of possibilities that decide how the traffic is conducted or set specific rules for a vehicle. Thus, the user can aim for different behaviours in both a general and specific sense. All the methods accessible from the Python API are listed in the documentation. However, here is a brief summary of what the current possibilities are.

TM creation:

  • 1. Get a TM instance for a client.
  • Safety conditions:
    1. Set a minimum distance between stopped vehicles (for a vehicle or all of them). This will affect the minimum moving distance.
    2. Set an intended speed regarding current speed limitation (for a vehicle or all of them).
    3. Reset traffic lights.
    Collision managing:
    1. Enable/Disable collisions between a vehicle and a specific actor.
    2. Make a vehicle ignore all the other vehicles.
    3. Make a vehicle ignore all the walkers.
    4. Make a vehicle ignore all the traffic lights.
    Lane changes:
    1. Force a lane change disregarding possible collisions.
    2. Enable/Disable lane changes for a vehicle.

    By default, vehicles will not ignore any actor, drive at their current speed limit and leave 1 meter of safety distance between them.
    All of these properties can be easily managed as any other set() method would.

    Creating a Traffic Manager

    A TM instance can be created in any carla.Client. To get it, two elements are needed: the container client and the port that will be used to connect with it. Default port is 8000.

    tm = client.get_trafficmanager(port)
    

    Now the TM needs some vehicles to be in charge of. In order to do so, enable the autopilot mode for every vehicle it is in charge of. In case the client is not connected to any TM, an instance will be created with default presets.

     for v in vehicles_list:
         v.set_autopilot(True)
    

    !!! Note In multiclient situations, creating or connecting to a TM is not that straightforward. Take a look into the other considerations section to learn more about this.

    The script spawn_npc.py in /PythonAPI/examples creates a TM instance in the port passed as argument and registers every vehicle spawned to it by setting the autopilot to True on a batch.

    traffic_manager = client.get_trafficmanager(args.tm_port)
    ...
    batch.append(SpawnActor(blueprint, transform).then(SetAutopilot(FutureActor, True)))
    ...
    traffic_manager.global_percentage_speed_difference(30.0)
    

    Setting a Traffic Manager

    The following example creates an instance of the TM and sets a dangerous behaviour for a specific car that will ignore all traffic lights, leave no safety distance with the rest and drive at 120% its current speed limit.

    tm = client.get_trafficmanager(port)
    for v in my_vehicles:
      v.set_autopilot(True)
    danger_car = my_vehicles[0]
    tm.ignore_lights_percentage(danger_car,100)
    tm.distance_to_leading_vehicle(danger_car,0)
    tm.vehicle_percentage_speed_difference(danger_car,-20)
    

    Now, here is an example that registers that same list of vehicles but instead is set to conduct them with a moderate behaviour. The vehicles will drive at 80% their current speed limit, leaving at least 5 meters between them and never perform a lane change.

    tm = client.get_trafficmanager(port)
    for v in my_vehicles:
      v.set_autopilot(True)
    danger_car = my_vehicles[0]
    tm.global_distance_to_leading_vehicle(5)
    tm.global_percentage_speed_difference(80)
    for v in my_vehicles: 
      tm.auto_lane_change(v,False)
    

    !!! Important Lane changes are currently disabled in the TM due to unintended collisions causing jams. As long as this issues are not fixed, vehicles will remain in the lane they are spawned and the methods to set lane changes will be disabled.

    Stopping a Traffic Manager

    The TM is not an actor that needs to be destroyed, it will stop when the corresponding client does so. This is automatically managed by the API so the user does not have to take care of it.
    However, it is important that when shutting down a TM, the vehicles registered to it are destroyed. Otherwise, they will stop at place, as no one will be conducting them. The script spawn_npc.py does this automatically.

    !!! Warning Shutting down a TM-Server will shut down the TM-Clients connecting to it. To learn the difference between a TM-Server and a TM-Client read the following section.


    Multiclient and multiTM management

    Different Traffic Manager definitions

    When working with different clients containing different TM, understanding inner implementation of the TM in the client-server architecture becomes specially relevant. There is one ruling these scenarios: the port is the key.

    A client creates a TM by communicating with the server and passing the intended port to be used for said purpose. The port can either be stated or not, using the default as 8000.

    tm01 = client01.get_trafficmanager() # tm01 --> tm01 (p=8000)
    
    tm02 = client02.get_trafficmanager(5000) # tm02(p=5000) --> tm02 (p=5000)
    

    The previous code creates two different TM, as both have different ports and none of them was previously occupied by another TM. These are TM-Servers: instances of the TM created on free ports.

    However, if a client tries to create a TM using a port that is already assigned to another TM, it will not create its own but connect to the one already existing. These are TM-Clients: instances of the TM created in an occupied port, which connect to the previous existing one.

    tm03 = client03.get_trafficmanager() # tm03 --> tm01 (p=8000). 
    
    tm04 = client04.get_trafficmanager(5000) # tm04(p=5000) --> tm02 (p=5000)
    

    !!! Important Note how the default creation of a TM uses always port=8000, and so, only the first time a TM-Server is created. The rest will be TM-Clients connecting to it.

    The CARLA server keeps register of all the TM instances internally by storing the port and also the client IP (hidden to the user) that link to them. Right now there is no way to check the TM instances that have been created so far. A connection will always be attempted when trying to create an instance and it will either create a new TM-Server or a TM-Client.

    Multiclient VS MultiTM

    Based on the different definitions for a TM, successfully creating a TM can lead to two different results:

    • TM-Server: when the port is free. This type of TM is in charge of its own logic, managed in TrafficManagerLocal.cpp.

    • TM-Client: when the port is occupied. It is not in charge of its own logic. Instead, it asks for changes in the parameters of the TM-Server it is connected to in TrafficManagerRemote.cpp.

    That creates a clear distinction between having multiple clients and multiple Traffic Managers running:

    • Multiclient scenario: when there is only one TM-Server, but there are other TM-Clients created with the same port definition that are actually connecting to said TM-Server.

    • MultiTM scenario: when there are different TM-Server, created with different port definitions.

    !!! Note The class TrafficManager.cpp acts as a central hub managing all the different TM instances.


    Other considerations

    The TM is a module constantly evolving and trying to adapt the range of possibilities that it presents. For instance, in order to get more realistic behaviours we can have many clients with different TM in charge of sets of vehicles with specific and distinct behaviours. This range of possibilities also makes for a lot of different configurations that can get really complex and specific. For such reason, here are listed of considerations that should be taken into account when working with the TM as it is by the time CARLA 0.9.8 is released:

    FPS limitations

    The TM stops working properly in asynchronous mode when the simulation is under 20fps. Below that rate, the server is going much faster than the client containing the TM and behaviours cannot be simulated properly. For said reason, under these circumstances it is recommended to work in synchronous mode.

    !!! Important The FPS limitations are specially relevant when working in the night mode.

    Synchronous mode

    TM-Clients cannot tick the CARLA server in synchronous mode, only a TM-Server can call for a tick.
    If more than one TM-Server ticks, the synchrony will fail, as the server will move forward on every tick. This is specially relevant when working with the ScenarioRunner, which runs a TM. In this case, the TM will be subordinated to the ScenarioRunner and wait for it.


    Summary

    The Traffic Manager is one of the most complex features in CARLA and so, one that is prone to all kind of unexpected and really specific issues. The CARLA forum is open to everybody to post any doubts or suggestions, and it is the best way to keep track of issues and help the CARLA community to become greater. Feel free to login and join the community.