Phase 4 of the OSS / pro split. The OSS image has no auth and no
server-side persistence — without this commit, the user's workspace
was ephemeral (lost on tab refresh). `.vlx` is a single-file JSON
snapshot of the entire workspace (boards, file groups, components,
wires, active board id) that the user can save to disk and reload
later.
New: utils/vlxFile.ts
- buildVlxPayload() / buildVlxBlob() — pure snapshot of the current
editor + simulator stores.
- triggerDownloadVlx({ name? }) — anchor-click download with a safe
filename. Returns the filename actually used.
- parseVlxFile(File) — async reader + validator. Checks
format === "velxio-project", version <= 1, and the required
arrays/objects are present. Throws VlxParseError with a human-
readable message on any issue.
- importVlxFile(File) — convenience wrapper that parses AND calls
useSimulatorStore.loadProjectState() with the result.
Format intentionally mirrors the server's POST /api/projects body so
a Pro user can export-from-pro and import-into-OSS losslessly (and
vice-versa once Pro adds an Export button — out of scope here).
lib/proSaveAction.ts: the default (no-overlay) implementation now
calls triggerDownloadVlx() instead of console.info'ing about the
missing handler. The Pro overlay still wins via installSaveActionImpl()
— Save in Pro keeps opening SaveProjectModal. The Save button in OSS
now actually saves.
components/editor/FileExplorer.tsx: new "Open .vlx" button next to
New + Save. Opens a hidden file input; confirms with the user before
replacing the workspace (loadProjectState is destructive); surfaces
VlxParseError messages via window.alert.
Verified with both builds:
- OSS-only: triggerSaveAction → download .vlx; FileExplorer shows
3 buttons (New, Open, Save).
- OSS + overlay: Pro's installSaveActionImpl overrides — Save opens
SaveProjectModal as before. Open .vlx still works (independent
button, not part of the save flow).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
||
|---|---|---|
| .. | ||
| public | ||
| scripts | ||
| src | ||
| .env.production | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| Dockerfile | ||
| README.md | ||
| eslint.config.js | ||
| esp32 plan.md | ||
| index.html | ||
| nginx.conf | ||
| package.json | ||
| tsconfig.app.json | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.ts | ||
README.md
Arduino Emulator - Frontend
React + TypeScript + Vite frontend for the Arduino emulator with visual simulator and code editor.
Features
- Monaco Code Editor - Full VSCode-like Arduino code editing experience
- Dynamic Component System - 48+ wokwi-elements components with search and categories
- Visual Simulator Canvas - Interactive drag-and-drop circuit builder
- Component Property Dialog - Single-click component interaction (rotate, delete, view pins)
- Segment-Based Wire Editing - Drag wire segments perpendicular to orientation (like Wokwi)
- Real AVR8 Emulation - Actual ATmega328p emulation using avr8js
- Pin Management - Automatic pin mapping and state synchronization
- Grid Snapping - 20px grid alignment for clean circuit layouts
Tech Stack
- React 18 - UI framework
- TypeScript - Static typing
- Vite 5 - Build tool and dev server
- Monaco Editor - Code editor (VSCode engine)
- Zustand - State management
- Axios - HTTP client for backend API
- avr8js - AVR8 CPU emulator (npm package)
- @wokwi/elements - Electronic web components (npm package)
Development
Prerequisites
- Node.js 18+
- Backend running at http://localhost:8001
Install Dependencies
npm install
Run Development Server
npm run dev
The app will be available at http://localhost:5173
Build for Production
npm run build
Output will be in the dist/ directory.
Lint
npm run lint
Project Structure
frontend/
├── src/
│ ├── components/
│ │ ├── velxio-components/ # React wrappers for wokwi-elements + Velxio-original parts
│ │ ├── editor/ # Monaco Editor components
│ │ │ ├── CodeEditor.tsx
│ │ │ └── EditorToolbar.tsx
│ │ └── simulator/ # Simulation canvas components
│ │ ├── SimulatorCanvas.tsx
│ │ ├── WireLayer.tsx
│ │ ├── WireRenderer.tsx
│ │ ├── PinOverlay.tsx
│ │ ├── ComponentPropertyDialog.tsx
│ │ ├── ComponentPickerModal.tsx
│ │ └── ComponentPalette.tsx
│ ├── simulation/
│ │ ├── AVRSimulator.ts # AVR8 CPU wrapper
│ │ └── PinManager.ts # Pin mapping and callbacks
│ ├── store/
│ │ ├── useEditorStore.ts # Code editor state
│ │ └── useSimulatorStore.ts # Simulation state
│ ├── services/
│ │ ├── api.ts # Backend API client
│ │ └── ComponentRegistry.ts # Component metadata
│ ├── types/ # TypeScript definitions
│ ├── utils/
│ │ ├── hexParser.ts # Intel HEX parser
│ │ ├── wirePathGenerator.ts # Wire SVG path generation
│ │ └── wireSegments.ts # Segment-based wire editing
│ ├── App.tsx # Main app component
│ └── main.tsx # Entry point
├── public/ # Static assets
├── vite.config.ts # Vite configuration
└── package.json
Key Architecture Patterns
State Management (Zustand)
Two main stores:
- useEditorStore - Code content, theme, compilation state
- useSimulatorStore - Simulation running state, components, wires, compiled hex
Wokwi Libraries
@wokwi/elements, avr8js and rp2040js are regular npm dependencies resolved
from node_modules like any other package — no local clones required.
AVR Simulation Loop
- Runs at ~60 FPS using
requestAnimationFrame - Executes ~267,000 CPU cycles per frame (16MHz / 60fps)
- Port listeners fire when GPIO registers change
- PinManager routes pin states to component callbacks
Component System
Components are Web Components from wokwi-elements:
- React wrappers in
velxio-components/ - Dynamic loading via ComponentRegistry
- Pin info extracted from component metadata
- State updates via refs and callbacks
Wire Editing System
Segment-based editing (like Wokwi):
- Wires consist of orthogonal segments (horizontal/vertical)
- Drag segments perpendicular to orientation:
- Horizontal segments: move up/down (ns-resize)
- Vertical segments: move left/right (ew-resize)
- Local preview state during drag (requestAnimationFrame)
- Store update only on mouse up with grid snapping (20px)
Performance Optimizations
requestAnimationFramefor smooth wire dragging- Local state for real-time previews
- Memoized path generation and segment computation
- Store updates batched at interaction completion
API Integration
Backend endpoints (http://localhost:8001):
POST /api/compile- Compile Arduino code to .hexGET /api/compile/status/{task_id}- Check compilation statusGET /api/compile/download/{filename}- Download compiled .hex
See backend documentation for API details.
Component Development
Adding a New Component Type
-
Check if wokwi-elements has the component:
ls ../third-party/wokwi-elements/src/ -
Create React wrapper in
src/components/velxio-components/:import React, { useRef, useEffect } from 'react'; export const WokwiMyComponent: React.FC<Props> = ({ ... }) => { const elementRef = useRef<any>(null); useEffect(() => { if (elementRef.current) { elementRef.current.setAttribute('prop', value); } }, [value]); return <wokwi-my-component ref={elementRef} />; }; -
Add to ComponentRegistry metadata
-
Use in SimulatorCanvas or make available in ComponentPalette
Troubleshooting
Monaco Editor Not Loading
- Check if
monaco-editoris installed - Verify Vite worker configuration in vite.config.ts
Components Not Rendering
- Ensure wokwi-elements is built:
cd ../third-party/wokwi-elements && npm run build - Check browser console for Web Component registration errors
- Verify Vite alias paths in vite.config.ts
Wire Editing Performance Issues
- Ensure
requestAnimationFrameis being used - Check that store updates only happen on mouse up, not during drag
- Verify no unnecessary re-renders with React DevTools
Pin Alignment Issues
- Pin coordinates from wokwi-elements are in CSS pixels
- Do NOT multiply by MM_TO_PX conversion factor
- Verify component position + pin offset calculation
Compilation Fails
- Check backend is running at http://localhost:8001
- Verify arduino-cli is installed and
arduino:avrcore is available - Check CORS configuration in backend