From 4fb8afbea53b32abaca81659f1ada27bba617a3c Mon Sep 17 00:00:00 2001 From: vinzenzm Date: Sun, 17 Nov 2024 23:36:03 +0100 Subject: [PATCH] Made the linter happy with newlines and trailing spaces --- doc/acting/README.md | 2 +- doc/acting/architecture_documentation.md | 10 +++++----- doc/acting/passthrough.md | 4 +++- doc/control/README.md | 2 +- doc/control/architecture_documentation.md | 17 ++++++++++------- 5 files changed, 20 insertions(+), 15 deletions(-) diff --git a/doc/acting/README.md b/doc/acting/README.md index b081c665..e9845154 100644 --- a/doc/acting/README.md +++ b/doc/acting/README.md @@ -5,4 +5,4 @@ This folder contains the documentation of the acting component. 1. [Overview and Architecture](./architecture_documentation.md) 2. [Passthrough](./passthrough.md) 3. [Main frame publisher](./main_frame_publisher.md) -4. [How to test/tune the acting component](./acting_testing.md) \ No newline at end of file +4. [How to test/tune the acting component](./acting_testing.md) diff --git a/doc/acting/architecture_documentation.md b/doc/acting/architecture_documentation.md index f4699186..4bb6f520 100644 --- a/doc/acting/architecture_documentation.md +++ b/doc/acting/architecture_documentation.md @@ -14,18 +14,19 @@ navigate on a local basis. This information is then processed in the [control_co ![MISSING: Acting-ARCHITECTURE](./../assets/acting/acting_architecture.png) -> [!NOTE] +> [!NOTE] > [Click here to go to control architecture](./../control/architecture_documentation.md) ## Components of acting ### passthrough.py -> [!TIP] +> [!TIP] > For documentation on passthrough component see: [passthrough](./passthrough.md) ### main_frame_publisher.py -> [!TIP] + +> [!TIP] > Follow this link for [Documentation](./main_frame_publisher.md) on this Node. - Inputs: @@ -41,7 +42,6 @@ navigate on a local basis. This information is then processed in the [control_co - rot_quat = rot as quaternion - **transform** = position x/y/z, rot_quat, Timestamp(now), “global”, “hero” - ### helper_functions.py - **vectors_to_angle_abs(x1: float, y1: float, x2: float, y2: float) -> float**:\ @@ -73,4 +73,4 @@ Interpolate linearly between start and end, with a minimal distance of interval_ - **_clean_route_duplicates(route: List[Tuple[float, float]], min_dist: float) -> List[Tuple[float, float]]**:\ Remove duplicates in the given List of tuples, if the distance between them is less than min_dist. - **interpolate_route(orig_route: List[Tuple[float, float]], interval_m=0.5)**:\ -Interpolate the given route with points inbetween,holding the specified distance interval threshold. \ No newline at end of file +Interpolate the given route with points inbetween,holding the specified distance interval threshold. diff --git a/doc/acting/passthrough.md b/doc/acting/passthrough.md index 7c3e7d27..eabd32b1 100644 --- a/doc/acting/passthrough.md +++ b/doc/acting/passthrough.md @@ -11,13 +11,15 @@ reason why it exists - [Reasoning](#reasoning) ## Overview + The passthrough node subscribes to topics on a global scale and republishes them into the "paf/acting" namespace. The control package subscribes to these re-emitted topics. > [!NOTE] > See [acting architecture](./architecture_documentation.md) for further information. ## Reasoning + Before the control package was outsourced and became its own package it resided within the acting package. Therefor many global dependencies existed in the control package. As the goal of the outsourcing was to eliminate global dependencies in control theory the passthrough node was created as a first stepping -stone towards independence. \ No newline at end of file +stone towards independence. diff --git a/doc/control/README.md b/doc/control/README.md index a51234b3..211d7149 100644 --- a/doc/control/README.md +++ b/doc/control/README.md @@ -5,4 +5,4 @@ This folder contains the documentation of the control component. 1. [Overview and Architecture](./architecture_documentation.md) 2. [Overview of the Velocity Controller](./velocity_controller.md) 3. [Overview of the Steering Controllers](./steering_controllers.md) -4. [Overview of the Vehicle Controller Component](./vehicle_controller.md) \ No newline at end of file +4. [Overview of the Vehicle Controller Component](./vehicle_controller.md) diff --git a/doc/control/architecture_documentation.md b/doc/control/architecture_documentation.md index 9dd55d15..89c44042 100644 --- a/doc/control/architecture_documentation.md +++ b/doc/control/architecture_documentation.md @@ -1,6 +1,6 @@ # Control: Overview and Architecture -**Summary**: +**Summary**: The control component applies control theory based on a local trajectory provided by the [acting component](./../acting/README.md). It uses knowledge of the current state of the vehicle in order to send [CarlaEgoVehicleControl](https://carla.readthedocs.io/en/0.9.8/ros_msgs/#CarlaEgoVehicleControlmsg) commands to the Simulator. This component also sends the [/carla/hero/status](https://leaderboard.carla.org/get_started/) command, @@ -19,16 +19,17 @@ which starts the simulation. ![MISSING: Control-ARCHITECTURE](./../assets/control/control_architecture.png) -> [!NOTE] +> [!NOTE] > [Click here to go to acting architecture](./../acting/architecture_documentation.md) ## Summary of Control Components -### Steering controllers -> [!TIP] +### Steering controllers + +> [!TIP] > Follow this link for the [Documentation](./steering_controllers.md) on steering controllers. -#### pure_pursuit_controller.py +#### pure_pursuit_controller.py - Inputs: - **trajectory**: Path @@ -50,7 +51,8 @@ which starts the simulation. - **stanley_steer**: Float32 - **stanley_debug**: StanleyDebug -### Velocity controllers +### Velocity controllers + > [!TIP] > Follow this link for the [Documentation](./velocity_controller.md) on velocity component. @@ -64,6 +66,7 @@ which starts the simulation. - **brake**: Float32 ### vehicle_controller.py + > [!TIP] > Follow this link for [Documentation](./vehicle_controller.md) on vehicle controller. @@ -78,4 +81,4 @@ which starts the simulation. - Outputs: - **vehicle_control_cmd**: [CarlaEgoVehicleControl](https://carla.readthedocs.io/en/0.9.8/ros_msgs/#CarlaEgoVehicleControlmsg) - **status**: Bool - - **emergency**: Bool \ No newline at end of file + - **emergency**: Bool