YAML Schema Reference

Complete reference for robot registration data format.

Full Schema

# Required fields
rrn: "RRN-XXXXXXXX"                    # Assigned by registry
name: "Robot Name"                      # Human-readable name
manufacturer: "Company Name"            # Manufacturer/organization
model: "model-identifier"               # Unique model ID
description: "Description text"         # Brief description
status: "active"                        # active | retired | prototype | concept

# Optional metadata
image: "/robots/robot-name.svg"         # Path to image
production_year: 2024                   # Year first produced

# Optional links
urdf_url: "https://..."                 # URDF description URL
github_url: "https://..."               # GitHub repository
website: "https://..."                  # Official website

# Optional technical specifications
specs:
  weight_kg: 10.0                       # Weight in kilograms
  dimensions: "500 x 300 x 200 mm"      # L x W x H
  max_speed_mps: 1.0                    # Max speed (m/s)
  dof: 6                                # Degrees of freedom
  ros_version: ["ROS 2"]                # ROS versions supported
  sensors: ["LiDAR", "Camera"]          # Sensor list
  compute: "NVIDIA Jetson"              # Compute platform
  payload_kg: 5.0                       # Max payload (kg)
  battery_life_hours: 2.0               # Battery life
  reach_mm: 850                         # Arm reach (mm)

# Optional ownership
owner:
  name: "Owner Name"                    # Person or organization
  type: "company"                       # individual | company | research | community
  website: "https://..."                # Owner website

# Optional ownership history (for transfers)
ownership_history:
  - owner_name: "Previous Owner"
    owner_type: "company"
    acquired_date: "2020-01-15"
    transferred_date: "2023-06-01"
    transfer_reason: "Acquisition"
    verified: true

# RCAN protocol integration
ruri: null                              # Robot URI (if RCAN-enabled)

# Submission metadata
submitted_by: "github:username"         # Submitter identifier
submitted_date: "2024-01-15"            # YYYY-MM-DD format
tags: ["mobile", "ros2", "research"]    # Discovery tags

Field Reference

Required Fields

Field	Type	Description
`rrn`	string	Robot Registration Number (format: RRN-XXXXXXXX)
`name`	string	Human-readable robot name
`manufacturer`	string	Manufacturing company or organization
`model`	string	Model identifier (lowercase, hyphens allowed)
`description`	string	Brief description of the robot
`status`	enum	One of: active, retired, prototype, concept

Status Values

Status	Meaning
`active`	Currently in production or active development
`retired`	No longer manufactured or supported
`prototype`	Experimental or pre-production
`concept`	Design phase, not yet built

Owner Types

Type	Meaning
`individual`	Personal/hobbyist ownership
`company`	Commercial entity
`research`	Academic or research institution
`community`	Open source or community project

Validation Rules

rrn must match pattern ^RRN-\d{8}$
production_year must be between 1950 and 2100
submitted_date must match YYYY-MM-DD
All URL fields must be valid URLs
Numeric specs must be positive numbers

Example: Minimal Registration

rrn: "RRN-00000011"
name: "My Robot"
manufacturer: "My Company"
model: "my-robot-v1"
description: "A simple mobile robot for education."
status: "prototype"
tags: ["mobile", "education"]

Example: Complete Registration

rrn: "RRN-00000012"
name: "Advanced Research Platform"
manufacturer: "RoboTech Labs"
model: "arp-2000"
description: "A modular research platform with interchangeable sensors and manipulators."
image: "/robots/arp-2000.svg"
production_year: 2024
status: "active"

urdf_url: "https://github.com/robotech/arp-2000/tree/main/urdf"
github_url: "https://github.com/robotech/arp-2000"
website: "https://robotech-labs.com/arp-2000"

specs:
  weight_kg: 45.0
  dimensions: "800 x 600 x 1200 mm"
  max_speed_mps: 2.0
  dof: 7
  ros_version: ["ROS 2 Humble", "ROS 2 Iron"]
  sensors: ["Velodyne VLP-16", "Intel RealSense D455", "IMU"]
  compute: "NVIDIA Jetson AGX Orin"
  payload_kg: 10.0
  battery_life_hours: 4.0
  reach_mm: 1000

owner:
  name: "RoboTech Labs"
  type: "research"
  website: "https://robotech-labs.com"

ruri: "rcan://robotech-labs.com/robotech/arp-2000/a1b2c3d4"

submitted_by: "github:robotech-admin"
submitted_date: "2024-01-15"
tags: ["research", "modular", "ros2", "manipulation", "mobile"]