Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
Signed-off-by: YuxuanLiuTier4Desktop <[email protected]>
  • Loading branch information
Owen-Liuyuxuan committed Dec 23, 2024
1 parent ddbc8f7 commit ef0bff6
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions aip_urdf_compiler/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ To use aip_urdf_compiler in your description package:
aip_cmake_urdf_compile()
```

- Configure your sensors in `config/sensors.yaml` with required meta values:
- Configure your sensors in `config/sensors.yaml` with metadata values (Note: this does not need to be added in `individual_params`):

- `type`: Sensor type identifier
- `frame_id`: TF frame identifier
- `type`: Required string, corresponding to the string value from [existing sensors](#existing-sensors)
- `frame_id`: Optional string, overwrites the TF frame ID.

- Clean up existing `.xacro` files and add to `.gitignore`:

Expand All @@ -41,6 +41,27 @@ To use aip_urdf_compiler in your description package:
*.xacro
```

### Existing Sensors

```python
class LinkType(enum.Enum):
"""Enum class for the type of the link."""

CAMERA = "monocular_camera"
IMU = "imu"
LIVOX = "livox_horizon"
PANDAR_40P = "pandar_40p"
PANDAR_OT128 = "pandar_ot128"
PANDAR_XT32 = "pandar_xt32"
PANDAR_QT = "pandar_qt"
PANDAR_QT128 = "pandar_qt128"
VELODYNE16 = "velodyne_16"
VLS128 = "velodyne_128"
RADAR = "radar"
GNSS = "gnss"
JOINT_UNITS = "units"
```

## Architecture

### Components
Expand Down

0 comments on commit ef0bff6

Please sign in to comment.