YAML Specification
Overview
This document describes the structure and format of the project.yaml
file used by Resolver to define robot workcells, motion planning, and optimization scenarios.
The project.yaml
file defines:
- Robot models and their kinematics
- Workcell objects and their positions
- Targets for robot motion
- Motion planning connections between targets
- Collision rules and safety constraints
Units and Coordinate Systems
Default Units
- Length: Millimeters (mm)
- Angles: Radians
- Time: Seconds
Supported Unit Specifications
- Length:
"m"
,"meter"
,"meters"
,"cm"
,"centimeter"
,"centimeters"
,"mm"
,"millimeter"
,"millimeters"
,"ft"
,"foot"
,"feet"
,"in"
,"inch"
,"inches"
- Angles:
"deg"
for degrees
Rotation Convention
RPY rotations are applied in order: Rz(C) * Ry(B) * Rx(A)
Supported CAD Formats
Primary Formats
- JT (.jt) - Recommended, supports B-Rep and polygonal
- STEP (.stp, .step) - B-Rep and polygonal
- STL (.stl) - Polygonal only, requires units specification
- IGES (.igs, .iges) - B-Rep only
Additional Formats
- FBX (.fbx) - Polygonal with assembly structure
- OBJ (.obj) - Polygonal
- Collada (.dae) - Polygonal with materials
- ACIS (.sat, .sab) - B-Rep
- BRep (.brep) - B-Rep
- IFC (.ifc) - Building information modeling
- Para (.x_t, .x_b) - B-Rep
- Rhino (.3dm) - B-Rep
- U3D (.u3d) - Polygonal
- VRML (.wrl) - Polygonal
- X3D (.x3d) - Polygonal
- X3MF (.3mf) - Additive manufacturing
Naming Rules
Uniqueness
- All names must be globally unique within the file
- Robot link/joint names must be unique within each robot model
- Different robot models can use the same link/joint names
Allowed Characters
- Most UTF-8 characters (including Japanese)
- Spaces allowed (but not at start/end)
- Cannot contain invisible ASCII control characters (0x00-0x1F)
- Cannot contain comma (,) or double quotes (")
Reserved Names
Cannot use (case-insensitive):
world
,origin
,floor
,home
,null
,tcp
- Cannot start with
rtr_
Length Limit
Maximum 1024 characters per name