Quick Start Guide

1. Register Your First Robot

The easiest way to register a robot is through a GitHub issue:

1. Go to the Submit page
2. Click "Submit via GitHub Issue"
3. Fill in your robot's details
4. Submit the issue

Within 24-48 hours, your robot will receive a permanent RRN and appear in the registry.

2. Access the API

The registry provides a JSON API for programmatic access:

List all robots

curl https://rcan.dev/api/robots.json

Get a specific robot

curl https://rcan.dev/api/robots/RRN-00000001.json

Filter by status

curl "https://rcan.dev/api/robots.json?status=active"

See the full API documentation for all endpoints and options.

3. Add a Badge to Your README

Show off your robot's registration with a badge:

Markdown

[![RCAN](https://rcan.dev/api/badge/RRN-XXXXXXXX.svg)](https://rcan.dev/registry/RRN-XXXXXXXX/)

HTML

<a href="https://rcan.dev/registry/RRN-XXXXXXXX/">
  <img src="https://rcan.dev/api/badge/RRN-XXXXXXXX.svg" alt="RCAN">
</a>

Replace RRN-XXXXXXXX with your robot's actual RRN.

4. Generate a QR Code

Each registered robot gets a QR code linking to its registry page:

• View on the robot's registry page under "Share & Embed"
• Download as SVG for printing
• Access via API: /api/qr/RRN-XXXXXXXX.svg

Perfect for labeling physical robots!

5. Explore the Registry

Browse registered robots:

• View all robots
• Filter by status, manufacturer, or tags
• View detailed specifications
• See 3D models (when URDF available)

Next Steps