WWW-POSIM v0.6.16Simulator documentation
Documentation menu
WWW-POSIM / Simulator documentation

Custom Sensors

Sensor settings live in the vehicle SDF. Select the sensor set in the vehicle builder first, then download its SDF at the start review. The file contains active sensors and commented examples for every supported option on that vehicle.

Choose the right setting

SDF field What it changes
sensor / pose Mount position in metres and roll, pitch, yaw in radians. Local X is forward, Y left and Z up.
update_rate Requested measurements per simulated second. Rendering and relay limits can reduce the received rate.
camera / image / width, height Image size in pixels. The builder’s pixel budget and dimension limits apply on upload.
camera / horizontal_fov Horizontal field of view in radians. Wider FOV changes image geometry and calibration.
camera / clip / near, far Geometric clipping planes in metres. Use 0 < near < far ≤ 10000; underwater haze can shorten useful visibility.
lidar / scan and lidar / range Ray angles, sample count and measurable range. Retain the sensor type and installed route.
gz:dvl / maximum_range Maximum bottom-return range. The DVL adapter uses the saved value too.
noise Existing noise model parameters. Keep the model type; edit the numeric parameters already present.
Acoustic plugin fields Provider-specific frequency, beam geometry, range and intensity processing. Check the installed acoustic provider and Sensor models & parameters.

Near/far clipping is different from optical absorption. Likewise, single Ping, DVL and imaging sonar produce different measurements; increasing a range value does not change the sensor’s measurement method.

Keep calibration and connections together

Upload the edited SDF in Edit SDF files → Upload edited vehicle SDF. Supported mounts, rates, image sizes, FOV and ranges are synchronized with the saved recipe and sensor manifest. A new session uses the saved SDF itself, preserving other allowed numeric plugin settings.

Keep topic names, frame names, plugin filenames and controller connections unchanged. To add or remove a sensor, use Saved vehicles → Edit a copy, then export that configuration. Multibeam sonar requires its compatible provider on the simulation host. DVL and single Ping cannot be selected together.

Full examples and validation

Read Complete WAM-V SDF and Complete BlueROV2 SDF for the entire models and the inactive sensor catalogue. Comments are documentation; they do not enable a sensor.

After restarting, check the sensor tree, image dimensions, data timestamps and mount direction. Use RViz & Foxglove viewers to inspect the output. If validation fails, fix the named field; increasing a value beyond an allowed limit does not override the runtime’s capabilities.

Optional sensors and providers

Check both the measurement type and the execution host before selecting a payload. A disabled Provider required item needs its matching installed and verified plugin. The web host and your computer can have different providers.

Sensor Output and intended use
Forward / downward camera Colour images and calibration. Check the mount direction, FOV and resolution together.
2D LiDAR · WAM-V Planar distance scan; objects outside its scan height may be absent.
Downward single Ping One range derived from a narrow ray bundle. This is a different output from imaging sonar; select it as an alternative to DVL.
DVL Bottom-tracking velocity and status. It needs valid bottom returns and is selected as an alternative to single Ping.
Forward multibeam Range-and-bearing intensity from a compatible acoustic provider. See Physics-based sonar preview.

Adding sensors alone does not create a SLAM map. SLAM also needs a compatible estimator, required inputs, calibration, timing and frames. Recorded demonstrations use dedicated SLAM configurations; check the current host's available features and the POSIM-SLAM documentation.

Search documentation