Skip to content

Commit

Permalink
Made the linter happy with newlines and trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
vinzenzm committed Nov 17, 2024
1 parent 5760c6d commit 4fb8afb
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 15 deletions.
2 changes: 1 addition & 1 deletion doc/acting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4. [How to test/tune the acting component](./acting_testing.md)
10 changes: 5 additions & 5 deletions doc/acting/architecture_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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**:\
Expand Down Expand Up @@ -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.
Interpolate the given route with points inbetween,holding the specified distance interval threshold.
4 changes: 3 additions & 1 deletion doc/acting/passthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
stone towards independence.
2 changes: 1 addition & 1 deletion doc/control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4. [Overview of the Vehicle Controller Component](./vehicle_controller.md)
17 changes: 10 additions & 7 deletions doc/control/architecture_documentation.md
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
- **emergency**: Bool

0 comments on commit 4fb8afb

Please sign in to comment.