Skip to content

Commit

Permalink
style(pre-commit): autofix
Browse files Browse the repository at this point in the history
  • Loading branch information
pre-commit-ci[bot] committed Jun 16, 2023
1 parent fe80bc3 commit 781349f
Showing 1 changed file with 28 additions and 12 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Creating vehicle and sensor description

## Introduction

This page introduce following topics.

1. YOUR_VEHICLE_description
Expand All @@ -14,7 +15,7 @@ This page introduce following topics.
In `YOUR_VEHICLE_description`, the following configurations are set:

1. vehicle_info.param.yaml (must be changed)
2. mesh file (*.dae)
2. mesh file (\*.dae)
3. mirror.param.yaml(must be changed)
4. simulator_model.param.yaml
5. vehicle.xacro
Expand All @@ -39,23 +40,26 @@ Configuration file for the [simulator environment](https://autowarefoundation.gi

The entry point file that defines the entire URDF of the vehicle. It refers to `sensors.xacro`, which specifies the sensor mounting positions.


## 2. YOUR_SENSOR_KIT_description

In sensor_kit_description, the following files are configured:

1. sensors.xacro (must be changed)
2. sensor_kit.xacro (must be changed)

### 1. sensors.xacro

Resolves the positions of sensors with `base_link` as the parent frame and defines the positions and orientations based on `sensors_calibration.yaml` in individual_params.

> In Autoware, `<YOUR_SENSOR_KIT_description>/config/sensors_calibration.yaml` is not used.
#### About sensor_kit_base_link

A `sensor_kit` refers to a subset that includes multiple sensors, and `sensor_kit_base_link` is the name of its frame.
The positions and orientations within the kit are defined in `sensor_kit.xacro`.

### 2. sensor_kit.xacro

Resolves the positions of sensors with `sensor_kit_base_link` as the parent and defines the positions and orientations based on `sensor_kit_calibration.yaml` in individual_params.

> In Autoware, `<YOUR_SENSOR_KIT_description>/config/sensor_kit_calibration.yaml` is not used.
Expand All @@ -65,27 +69,31 @@ Resolves the positions of sensors with `sensor_kit_base_link` as the parent and
The `individual_parameter` is where parameters referenced by `sensors.xacro` and `sensor_kit.xacro` are stored. As the name imply, it is intended to manage parameters for multiple individual instances.

### Introduction to Various Parameters

1. sensors_calibration.yaml (must be changed)
2. sensor_kit_calibaration.yaml (must be changed)
3. imu_corrector.param.yaml

### 1. sensors_calibration.yaml

A file that defines the mounting positions and orientations of sensors with `base_link` as the parent frame.

### 2. sensor_kit_calibaration.yaml

A file that defines the mounting positions and orientations of sensors with `sensor_kit_base_link` as the parent frame.

### 3. imu_corrector.param.yaml

A file used by `imu_corrector`.

### 4. Folder Structure

Below is the default directory structure.

```diff
individual_params/
└─ config/
└─ default/
└─ config/
└─ default/
└─ sample_sensor_kit/
├─ imu_corrector.param.yaml
├─ sensor_kit_calibration.yaml
Expand All @@ -96,10 +104,10 @@ Copy and create a folder based on your `YOUR_SENSOR_KIT` name.

```diff
individual_params/
└─ config/
└─ default/
└─ config/
└─ default/
- └─ sample_sensor_kit/
+ └─ <YOUR_SENSOR_KIT>/
+ └─ <YOUR_SENSOR_KIT>/
├─ imu_corrector.param.yaml
├─ sensor_kit_calibration.yaml
└─ sensors_calibration.yaml
Expand All @@ -123,8 +131,8 @@ $ ros2 launch autoware_launch autoware.launch.xml sensor_model:=<YOUR_SENSOR_KIT

```diff
individual_params/
└─ config/
├─ default/
└─ config/
├─ default/
│ └─ <YOUR_SENSOR_KIT>/ # example1
│ ├─ imu_corrector.param.yaml
│ ├─ sensor_kit_calibration.yaml
Expand All @@ -148,6 +156,7 @@ individual_params/
1. vehicle_interface.launch.xml (must be changed)

### 1. vehicle_interface.launch.xml

`vehicle_interface.launch.xml` is the launch file related to the drive system. Please modify it according to the configuration of your vehicle's drive system.

If you are operating multiple vehicles, use the `vehicle_id` to switch to the corresponding configuration for each vehicle.
Expand All @@ -164,25 +173,32 @@ If you are operating multiple vehicles, use the `vehicle_id` to switch to the co
6. pointcloud_preprocessor.launch.py (must be changed)

### 1. sensing.launch.xml

`sensing.launch.xml` is the entry point that calls the launch files for all sensors. Modify it according to your sensor configuration.

### 2. lidar.launch.xml

`lidar.launch.xml` is the launch file related to starting the LiDAR driver. Modify it according to your LiDAR configuration.

> In Autoware's initial configuration, it assumes converting the acquired data using `pointcloud_preprocessor.launch.py`.
#### Example Configuration Items
* Setting the frame_id defined in `YOUR_SENSOR_KIT_description`.
* Connection information for each device.

- Setting the frame_id defined in `YOUR_SENSOR_KIT_description`.
- Connection information for each device.

### 3. camera.launch.xml

`camera.launch.xml` is the launch file related to starting the camera driver.

### 4. imu.launch.xml

`imu.launch.xml` is the launch file related to starting the IMU driver.

### 5. gnss.launch.xml

`gnss.launch.xml` is the launch file related to starting the GNSS driver.

### 6. pointcloud_preprocessor.launch.py
`pointcloud_preprocessor.launch.py` is the launch file to convert the raw sensor data. For more information, please click [here](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/sensing/data-types/point-cloud/).

`pointcloud_preprocessor.launch.py` is the launch file to convert the raw sensor data. For more information, please click [here](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/sensing/data-types/point-cloud/).

0 comments on commit 781349f

Please sign in to comment.