coding_lab / README.md
dlouapre's picture
dlouapre HF Staff
Initial
ee6161a
|
raw
history blame
1.83 kB

RMScript App

Web IDE for programming Reachy Mini with rmscript - a kid-friendly scripting language.

Features

  • Web-based editor with syntax verification
  • Real-time compilation to robot commands
  • Server-side execution with proper timing and smooth movements
  • Example scripts to get started quickly

Installation

From the Daemon Dashboard

  1. Open the Reachy Mini daemon dashboard at http://localhost:8000
  2. Navigate to the Apps section
  3. Search for "RMScript App" or paste this Space URL
  4. Click Install

Manual Installation

pip install rmscript-app

Usage

Running the App

After installation, start the app from the daemon dashboard or run directly:

# Start the daemon first
reachy-mini-daemon --sim  # or -p /dev/ttyUSB0 for real robot

# Run the app
python -m rmscript_app.main

Then open http://localhost:8042 in your browser.

Example Script

"Wave hello"
look left
antenna both up
wait 1s
look right
antenna both down
wait 0.5s
look center

RMScript Language

RMScript uses natural language commands:

  • Movement: look left, look right 45, turn left
  • Antennas: antenna up, antenna both down
  • Timing: wait 1s, wait 0.5s
  • Loops: REPEAT 3 ... END
  • Sounds: play soundname
  • Camera: picture

See the rmscript documentation for the full language reference.

Development

# Clone and install in development mode
cd rmscript_app
pip install -e .

# Run the app
python -m rmscript_app.main

Publishing to HuggingFace Spaces

# Use the app assistant
reachy-mini-app-assistant publish rmscript_app/

This creates a static Space that serves as a catalog entry. The actual app runs locally when installed via the daemon dashboard.