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

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

Open
ShotaAk opened this issue Nov 15, 2023 · 2 comments
Open
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@ShotaAk
Copy link

ShotaAk commented Nov 15, 2023

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

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 version="1.0" ?>
<sdf version="1.6">
  <world name="default">
    <plugin
      filename="ignition-gazebo-forcetorque-system"
      name="ignition::gazebo::systems::ForceTorque">
    </plugin>
  </world>
</sdf>

model file (URDF):

<?xml version="1.0"?>
<robot xmlns:xacro="http://ros.org/wiki/xacro">
    <gazebo reference="joint1">
      <sensor name="force_torque_sensor" type="force_torque">
        <update_rate>100.0</update_rate>
        <always_on>1</always_on>
        <topic>joint1/force_torque</topic>
        <visualize>false</visualize>
        <ignition_frame_id>link1</ignition_frame_id>
        <force_torque>
          <frame>child</frame>
          <measure_direction>child_to_parent</measure_direction>
        </force_torque>
      </sensor>
    </gazebo>
</robot>

Additional context

@ShotaAk ShotaAk added the enhancement New feature or request label Nov 15, 2023
@mjcarroll mjcarroll added the help wanted Extra attention is needed label Nov 20, 2023
@mjcarroll mjcarroll moved this from Inbox to To do in Core development Nov 27, 2023
@Ryanf55
Copy link

Ryanf55 commented Jan 23, 2024

If the RGB camera API can't be given in a tutorial, perhaps a link to the header file could be added?

@mabelzhang
Copy link
Contributor

The example worlds are helpful too: https://github.com/gazebosim/gz-sim/tree/gz-sim8/examples/worlds
e.g. camera_sensor https://github.com/gazebosim/gz-sim/blob/gz-sim8/examples/worlds/camera_sensor.sdf

A tutorial could start from the existing example worlds, and not have to start from scratch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
Status: To do
Development

No branches or pull requests

4 participants