6.0 KiB
SDF validation
Generation validates every gen_sdf() result before writing. This validation is dependency-light and intended to catch common structural errors. It is not a replacement for libsdformat, Gazebo, or target-simulator validation.
Validation model
The validator should produce structured diagnostics with severities:
error: invalid or unsafe enough to block writing output;warning: likely problem or unverified simulator behavior; output can be written unless--strictis used;info: assumption, skipped check, or useful context.
--strict treats warnings as failures.
Bundled checks
Root and document shape
The runtime should check that:
- the root element is
<sdf>; - the root has a non-empty
versionattribute; - the version looks like
major.minor; - the document contains meaningful SDF content such as a model, world, actor, light, include, or plugin;
- structurally valid pure world files are accepted even when they contain no inline model.
Names and scopes
The runtime should check that:
- world names are non-empty and unique at root scope;
- root model names are non-empty and unique;
- model link, joint, frame, sensor, visual, and collision names are non-empty where required and unique within their owner scope;
- duplicate names are reported with a path and scope.
Poses
The runtime should check all <pose> elements:
- default
rotation_format="euler_rpy"has exactly six finite values; rotation_format="quat_xyzw"has exactly seven finite values;- unsupported
rotation_formatis an error; - quaternion values are approximately normalized;
degrees="true"is a warning unless strict mode is enabled;- nontrivial omitted
relative_tois a warning; relative_toresolves within local scope when possible;- nested
::references have valid syntax and resolve when the local tree is available.
Frames
The runtime should check that:
<frame name="...">has a non-empty unique name in its scope;attached_to, when present, resolves locally when possible;- frame attachment chains do not cycle;
- unresolved nested or external frame references are reported as warnings when local validation cannot prove them invalid.
Joints
Known SDF 1.12 joint types:
continuous, revolute, gearbox, revolute2, prismatic, ball, screw, universal, fixed
The runtime should check that:
- joint type is non-empty and known;
<parent>and<child>text exists;worldis allowed as parent but not child;- unscoped parent/child references exist in the same model;
axisandaxis2vectors are finite, nonzero, and normalized;axis2is used only where the joint type supports a second axis;expressed_inresolves when local resolution is possible;- limit and dynamics values are finite or documented infinities where SDFormat permits them;
- finite lower limits do not exceed finite upper limits;
- continuous joints with fake finite position limits produce a warning.
Geometry and mesh URIs
The runtime should check that:
- each visual/collision owner has one geometry element;
- each geometry has exactly one known primitive or mesh child when possible;
- box size has 3 positive finite values;
- cylinder radius and length are positive and finite;
- sphere radius is positive and finite;
- plane size has 2 positive finite values;
- mesh URI values are non-empty;
- mesh scale has 3 positive finite values when present;
- local mesh references resolve relative to the generated
.sdflocation; - known external URI schemes such as
model://,package://,fuel://,http://, andhttps://are accepted without local filesystem resolution.
Inertials
The runtime should check that:
- mass is positive and finite;
- inertial pose is valid when present;
- inertia tensor components are finite;
- inertia matrix is positive semidefinite within tolerance;
- missing inertial data on dynamic physical links is at least a warning;
- frame-like or static links can omit inertials when documented.
Sensors and plugins
The runtime should check that:
- sensor names are non-empty and unique within owner scope;
- sensor
typeis non-empty; - sensor
update_rate, when present, is finite and non-negative; - sensor pose is valid;
- plugin filename is non-empty;
- plugin name, when present, is non-empty;
- arbitrary simulator-specific plugin schemas are not invented by the validator.
Plugin filenames and parameters can pass bundled validation and still fail in the target simulator. Use smoke tests.
CAD Viewer review
CAD Viewer treats SDF plugins, sensors, lights, includes, and nested models as static metadata. The bundled validator checks generic structure only; it does not validate Explorer-only motion contracts or execute simulator plugins.
After generated .sdf files are created or modified, hand explicit paths to $cad-viewer for live viewer links when available.
This plugin is for CAD Viewer visualization and review. It is not a Gazebo physics/controller plugin and should not be represented as simulator runtime behavior.
External checks
When Gazebo tooling is available, run:
gz sdf --check path/to/file.sdf
The CLI option should be:
python scripts/sdf path/to/source.py --gz-check auto
External checks should be recorded in the diagnostics report. A skipped optional check is not a bundled-validation failure unless the user requested --gz-check required.
SDF validity vs project policy
Separate these categories:
| Category | Examples |
|---|---|
| SDF structural validity | root <sdf>, version, legal element shape, non-empty names, references |
| Numeric plausibility | finite poses, positive dimensions, positive mass, normalized axes, PSD inertia |
| Simulator compatibility | libsdformat version, supported joint types, plugin availability, sensor support |
| Project policy | mesh location, preferred URI style, STL/DAE preference, collision simplification, no unresolved external URIs |
Do not reject valid SDF merely because it violates a project policy unless the task or repository requires that policy. Prefer warnings and strict-mode controls.