Connect to Open GRID Jupyter servers directly from VS Code with seamless notebook functionality, IntelliSense, and real-time execution
⚡️NOTE: This extension requires an active open GRID session. The extension connects to the active session for code execution and robot simulation.
🚀 Features
SEAMLESS NOTEBOOK EXPERIENCE
- Real-time Execution: Develop in your IDE and see live execution, visualization and simulations on Open GRID
- Streaming Output: Live results and error feedback in your IDE
- Session Continuity: Switch between web and IDE seamlessly
- Bi-directional Cell Sync: Add or delete cells in your IDE - they automatically sync to Open GRID session's editor and vice versa
- Sample Notebooks: Pre-built examples for quick learning
- Multi-IDE Support: Works with VS Code and Cursor
- WebSocket Connection: Direct, secure connection to GRID servers
INTELLIGENT ROBOT API INTEGRATION
- Auto-completion: IntelliSense for robot API methods with parameter hints
- Hover Documentation: Instant method signatures and documentation
- MCP Integration: Model Context Protocol for real-time robot API documentation
📦 Installation
Search for "GRID Platform" in VS Code Extensions on VS Code Marketplace
System Requirements:
- VS Code 1.96.2+ or Cursor (latest)
- Active GRID platform account
- Stable internet connection
🛠️ Quick Start
- Start Your Session: Begin in the openGRID web platform
- Open in IDE: Click the "Open in VSCode" or "Open in Cursor" button
- Automatic Setup: Your IDE opens with session parameters pre-configured
Step 2: Activate Extension
- Find GRID Icon: Look for the yellow GRID icon in your status bar (bottom right)
- Connect: Click the icon to directly connect to your session
- Start Coding: Your notebook loads automatically with full IDE features
Step 3: Enhanced Development
# IntelliSense works automatically
robot. # ← Auto-completion appears with available methods
# Hover for documentation
robot.moveToPosition() # ← Hover to see parameters and docs
# Load sample notebooks
# Click "Sample Notebooks" in the notebook toolbar
🎯 Key Workflows
IDE ↔ WEB SYNCHRONIZATION
- Cell Management: Add/delete cells in either IDE or web - changes sync automatically to both
- Code Execution: Run code in IDE, see results in both IDE and GRID platform visualizations
ROBOT API DEVELOPMENT
# Full IntelliSense support for robot APIs
position = robot.getCurrentPosition()
robot.moveToPosition(position.x + 1, position.y, position.z)
# Hover documentation shows:
# moveToPosition(x: float, y: float, z: float) -> bool
# Move robot to specified coordinates in 3D space
SAMPLE LEARNING
- Open any GRID notebook in your IDE from OpenGRID
- Click "Sample Notebooks" button in your IDE
- Browse available examples
- Load directly into your current notebook
🎨 IntelliSense Features
AUTO-COMPLETION
- Robot API methods with parameter hints
- Snippet insertion for methods with parameters
- Priority sorting for robot-specific methods
HOVER DOCUMENTATION
- Method signatures with types
- Comprehensive docstrings
- Real-time documentation from MCP server
🐛 Troubleshooting
Connection Issues
| Problem |
Solution |
| GRID icon not visible |
Check extension is installed and enabled |
Session Problems
| Problem |
Solution |
| Session expired |
Sessions expire after 1 hour - start new session |
| Missing progress |
Refresh connection to sync latest changes |
🤝 Contributing
This extension is developed by General Robotics for the GRID community.
Open GRID by General Robotics.
