gazebosim / gazebosim/docs

Feature Request: Add documentation for SDF file format across all sensors.

Open
#408 2 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
88
Forks
319
Avg merge
2h 2m
Merged PRs (30d)
1

Description

## Desired behavior

**Current Situation:**
Gazebo official tutorials cover IMU and LiDAR usage, but lack documentation for other sensors like cameras and FT sensors.

https://gazebosim.org/docs/harmonic/sensors

![image](https://github.com/gazebosim/docs/assets/18494952/de91c5d6-6119-49a3-bae6-ecb82c17961c)

**Proposal:**
Please expand the official tutorials to include guides on integrating various sensors (e.g., cameras, FT sensors). Include details on plugin usage and parameter configurations for each sensor type.

## Alternatives considered

If documentation for all sensors' plugins and parameters exists, please add links to this information in the official tutorials.

## Implementation suggestion

Table of contents:

- Ignition launch
- Video walk-through
- **Other sensors**
- **RGB Camera**
- **Depth Camera**
- **Force Torque Sensor**
- **Air Pressure Sensor**

Force Torque Sensor page:

world file:
```xml




```

model file (URDF):

```xml



100.0
1
joint1/force_torque
false
link1

child
child_to_parent


```

## Additional context

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked Gazebo sensors tutorial and the proposed table of contents, then review the Force Torque Sensor world and URDF examples in the issue. Expand the official tutorials for RGB, depth, force-torque, and air-pressure sensors, covering plugin usage and parameter configuration or linking to existing references; done when these sensor guides are published and linked from the tutorials.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.