Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update creating vehicle and sensor model pages #460

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,10 @@ References:

1. Calibration of sensor

The conversion relationship between every sensor coordinate system and `base_link` can be obtained through sensor calibration technology. How to calibrating your sensors refer to this link [calibrating your sensors](../../../how-to-guides/integrating-autoware/creating-vehicle-and-sensor-description/calibrating-sensors.md).
The conversion relationship between every sensor coordinate system and `base_link` can be obtained through sensor calibration technology.
Please consult the following link
[calibrating your sensors](../../../how-to-guides/integrating-autoware/creating-vehicle-and-sensor-model/calibrating-sensors) for instructions
on how to calibrate your sensors.

2. Localization

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/integrating-autoware/.pages
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nav:
- overview.md
- 1. Creating your Autoware repositories: creating-your-autoware-repositories
- 2. Creating vehicle and sensor description: creating-vehicle-and-sensor-description
- 2. Creating vehicle and sensor model: creating-vehicle-and-sensor-model
- 3. Creating vehicle interface: creating-vehicle-interface-package
- 4. Creating maps: creating-maps
- 5. Launch Autoware: launch-autoware
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
nav:
- index.md
- Creating sensor model: creating-sensor-model
- Creating individual params: creating-individual-params
- Creating vehicle model: creating-vehicle-model
- Calibrating sensors: calibrating-sensors
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nav:
- index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nav:
- index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Creating individual params

## Introduction

The [individual_params](https://github.com/autowarefoundation/autoware_individual_params) package is used
to define customized sensor calibrations for different vehicles.
It lets
you define customized sensor calibrations for different vehicles
while using the same launch files with the same sensor model.

!!! Warning

The "individual_params" package contains the calibration
results for your sensor kit and overrides the default calibration results found in
VEHICLE-ID_sensor_kit_description/config/ directory.

## Placing your `individual_parameters` repository inside Autoware

[Previously on this guide](../../creating-your-autoware-repositories/creating-autoware-repositories.md),
we forked the `autoware_individual_params` repository
to create a [tutorial_vehicle_individual_params](https://github.com/leo-drive/tutorial_vehicle_individual_params) repository
which will be used as an example for this section of the guide.
Your individual_parameters repository should be placed inside your Autoware folder following the same folder structure as the one shown below:

??? note "sample folder structure for [`tutorial_vehicle_individual_params`](https://github.com/leo-drive/tutorial_vehicle_individual_params)"

```diff
<YOUR-OWN-AUTOWARE-DIR>/
└─ src/
└─ param/
└─ tutorial_vehicle_individual_params/
└─ individual_params/
└─ config/
├─ default/
+ └─ tutorial_vehicle/
+ └─ tutorial_vehicle_sensor_kit_launch/
+ ├─ imu_corrector.param.yaml
+ ├─ sensor_kit_calibration.yaml
+ └─ sensors_calibration.yaml
```

After that, we need to build our `individual_params` package:

```bash
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to individual_params
```

Now you are ready to use Autoware with a vehicle_id as an argument.
For example, if you are several, similar vehicles with different sensor calibration requirements,
your autoware_individual_params structure should look like this:

```diff
individual_params/
└─ config/
├─ default/
│ └─ <YOUR_SENSOR_KIT>/ # example1
│ ├─ imu_corrector.param.yaml
│ ├─ sensor_kit_calibration.yaml
│ └─ sensors_calibration.yaml
+ ├─ VEHICLE_1/
+ │ └─ <YOUR_SENSOR_KIT>/ # example2
+ │ ├─ imu_corrector.param.yaml
+ │ ├─ sensor_kit_calibration.yaml
+ │ └─ sensors_calibration.yaml
+ └─ VEHICLE_2/
+ └─ <YOUR_SENSOR_KIT>/ # example3
+ ├─ imu_corrector.param.yaml
+ ├─ sensor_kit_calibration.yaml
+ └─ sensors_calibration.yaml
```

Then, you can use autoware with vehicle_id arguments like this:

Add a `<vehicle_id>` as an argument and switch parameters using options at startup.

```bash
# example1 (do not set vehicle_id)
$ ros2 launch autoware_launch autoware.launch.xml sensor_model:=<YOUR-VEHICLE-NAME>_sensor_kit vehicle_model:=<YOUR-VEHICLE-NAME>_vehicle
# example2 (set vehicle_id as VEHICLE_1)
$ ros2 launch autoware_launch autoware.launch.xml sensor_model:=<YOUR-VEHICLE-NAME>_sensor_kit vehicle_model:=<YOUR-VEHICLE-NAME>_vehicle vehicle_id:=VEHICLE_1
# example3 (set vehicle_id as VEHICLE_2)
$ ros2 launch autoware_launch autoware.launch.xml sensor_model:=<YOUR-VEHICLE-NAME>_sensor_kit vehicle_model:=<YOUR-VEHICLE-NAME>_vehicle vehicle_id:=VEHICLE_2
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nav:
- index.md
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading