Join the pilot
03 / EXTENSION GUIDE

VS Code Extension Guide

Learn how to use the Omera VS Code Extension to manage projects, edit configurations, view interactive system maps, and chat with Omera 3.6 inside your editor.

System Interface Panels

The Omera Extension loads three specialized Webview panels (built using React 19 and Vite) in the IDE container:

1. OMERA Control Panel

  • Location: Primary sidebar.
  • Purpose: Workspace management. Scans for Omera projects (up to depth 2), triggers pipeline executions, adjusts configurations, and displays remaining weekly credits.

2. OMERA Copilot Chat

  • Location: Secondary sidebar.
  • Purpose: AI assistance. Provides an interactive chat portal to ask questions about firmware architecture, request code snippets, draft patches, and compact token context.

3. OMERA: RUN Panel

  • Location: Bottom panel (next to Terminal/Output).
  • Purpose: Execution results. Displays stages status (C1–C5), compiler output logs, live test progress, and the 4-view System Map.

Interactive System Map

The System Map visualizes your embedded project across 4 distinct views, helping you trace physical pin configurations to software behaviors:

  1. Hardware Map: Displays MCU nodes, pin allocations, peripheral interfaces, and netlist IC components parsed from board_profile.json.
  2. Firmware Map: Displays task schedules, application contracts, RTOS task structures, and driver bindings defined in firmware_plan.json.
  3. Simulation Trace: Visualizes tick-level state changes, register transitions, and logic analyzer timelines loaded from sim_report.json.
  4. Diff View: Evaluates planned system contracts against actual compiled properties, raising safety flags (PASS, WARN, FAIL, PENDING).

Board Log Tuning Flow

Tune PID coefficients and operational parameters based on empirical hardware logs:

  1. Click Select Board Log in the Control Panel and choose a csv log (e.g. motor_step.csv) recorded from physical probes.
  2. Select Tune Parameters to trigger Python analysis scripts.
  3. Omera 3.6 calculates overshoot rates, rise times, and output limits, proposing tuned variables directly into your editor.

Security & Sandbox Boundaries

The extension operates under strict security policies to protect local workspaces:

  • Command Allowlist: Only 4 commands are authorized to run via webview event bridges:
    • omera fw build run (build compilation)
    • omera fw build explain (compilation diagnosis)
    • omera fw debug (dry-run debugger)
    • omera doctor (system check)
  • Path Guards: Every path request is resolved using realpath conversions, blocking symlinks pointing outside the active workspace directory to prevent directory traversal attacks.
  • Secret Storage: Backend access tokens are written to VS Code's native SecretStorage API, never exposed as plaintext logs or written to disk.