CoolFace
Apppublic

totosolat/reachy_mini_keyboard_teleop

sourceHugging Faceupdated 10mo agoView on Hugging Face
4likes
App README

🎮 Reachy Mini Keyboard Teleop

Web-based keyboard teleoperation app for Reachy Mini robot with real-time control interface.

🌟 Features

  • —🌐 Web Interface: Modern, responsive web UI accessible from any browser
  • —⌨️ Real-time Keyboard Control: Direct keyboard input for robot control
  • —🗺️ Multiple Keyboard Layouts: Support for AZERTY, QWERTY, and custom layouts
  • —🎯 POV Mode: Toggle for inverted controls for different perspectives
  • —📡 WebSocket Communication: Real-time communication between interface and robot
  • —🔧 Configurable Parameters: Adjust movement speed, rotation, antenna controls
  • —📊 Live Status Display: Real-time position and rotation feedback

🚀 Installation

Install via the Reachy Mini app manager or manually:

bash
pip install reachy-mini-keyboard-teleop

🎮 Usage

  1. 1.Start the App: Launch via the Reachy Mini dashboard or directly
  2. 2.Open Web Interface: Navigate to http://127.0.0.1:8042 in your browser
  3. 3.Focus Page: Click "Focus for Keyboard Input" to capture keyboard events
  4. 4.Control Robot: Use the keys according to the displayed mapping

⌨️ Default Key Mappings

QWERTY Layout

  • —Movement: W/A/S/D (forward/left/back/right), R/F (up/down)
  • —Rotation: I/K (pitch), J/L (roll), U/O (yaw)
  • —Antennas: Q/E (left/right antenna)
  • —Reset: Space (return to center)

AZERTY Layout

  • —Movement: Z/Q/S/D (forward/left/back/right), R/F (up/down)
  • —Rotation: I/K (pitch), J/L (roll), O/P (yaw)
  • —Antennas: W/X (left/right antenna)
  • —Reset: Space (return to center)

🔧 Configuration

  • —Movement Speed: Adjust step size in millimeters
  • —Rotation Speed: Adjust rotation step in degrees
  • —Antenna Modes:
  • —Mirror: Symmetric antenna movement
  • —Incremental: Continuous adjustment
  • —Independent: Separate control
  • —POV Mode: Invert controls for different perspectives

🛠️ Technical Details

  • —Backend: FastAPI with WebSocket support
  • —Frontend: Vanilla JavaScript with Tailwind CSS
  • —Real-time Communication: WebSocket for low-latency control
  • —Port: Runs on 127.0.0.1:8042 by default

📝 Customization

Edit keyboard_mapping.yaml to customize key bindings for different layouts.

Part of the Reachy Mini ecosystem by Pollen Robotics