Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 2.06 KB

File metadata and controls

76 lines (60 loc) · 2.06 KB

Reachy Mini Documentation

Local copy of SDK documentation for quick reference.

SDK Reference

Document Description
quickstart.md First steps, verify setup
python-sdk.md Full API reference
core-concepts.md Architecture, coordinates, safety
integration.md LLM integration, REST API, Apps
installation.md Setup instructions

Troubleshooting

Document Description
troubleshooting.md FAQ, common issues, fixes

Quick API Reference

Movement

from reachy_mini import ReachyMini
from reachy_mini.utils import create_head_pose
import numpy as np

with ReachyMini() as mini:
    # Smooth movement
    mini.goto_target(
        head=create_head_pose(z=10, roll=15, mm=True, degrees=True),
        antennas=np.deg2rad([30, -30]),
        body_yaw=np.deg2rad(20),
        duration=1.5,
        method="minjerk"
    )

    # Instant (for streaming/joystick)
    mini.set_target(head=pose)

Media

frame = mini.media.get_frame()           # Camera (OpenCV)
sample = mini.media.get_audio_sample()   # Microphone
mini.media.play_sound("file.wav")        # Speaker

Motor Control

mini.enable_motors()               # Stiff
mini.disable_motors()              # Limp
mini.enable_gravity_compensation() # Soft/teachable

Recording

mini.start_recording()
# ... movements ...
data = mini.stop_recording()

REST API

When daemon is running:

External Links