Features
========

Assembly Language Support
--------------------------

.. image:: _static/images/assembly_editor.png
   :alt: Assembly Language Support
   :align: center

Full support for traditional FV-1 assembly programming:

📝 **Syntax Highlighting**
   Complete syntax highlighting for ``.spn`` files and the full FV-1 instruction set

⚠️ **Real-time Diagnostics**
   Errors and warnings appear as you type, with comprehensive error messages

💡 **Hover Information**
   Detailed documentation for instructions, registers, and memory locations

🔗 **Go to Definition**
   Use ``Ctrl+Click`` to navigate to user-defined symbols throughout your code

✓ **Built-in Assembler**
   Compile your assembly directly in VS Code with full error reporting


Visual Block Diagram Editor
----------------------------

.. image:: _static/images/block_diagram_example1.png
   :alt: Visual Block Diagram Editor
   :align: center

Create FV-1 programs visually without writing assembly code:

🎨 **Drag-and-Drop Palette**
   Organized blocks in categories: I/O, Control, Gain/Mixing, Filters, Effects, and more

⚡ **Real-time Compilation**
   See compilation results and resource usage instantly as you build

🔍 **Live Error Checking**
   Connection validation and resource tracking in real-time

📊 **Resource Monitor**
   Visual feedback on instruction count, register usage, and delay memory

🧠 **Code Optimizer**
   Automatically optimizes generated assembly to save program space

🎯 **Direct Programming**
   Program your diagram directly to a pedal slot with one keystroke


Integrated Real-time Simulator and Debugger
-------------------------------------------

Debug assembly files:

.. image:: _static/images/debug1.png
   :alt: Debugger
   :align: center

 
Or simulate with realtime audio:

.. image:: _static/images/simulator.png
   :alt: Simulator
   :align: center

Test your programs without hardware:

🎧 **Audio Monitor**
   Listen to your effect in real-time with built-in or custom stimulus files

📈 **Multi-trace Oscilloscope**
   Visualize any register or symbol with logarithmic zoom (1ms to 1s)

💾 **Delay Memory Map**
   Visual representation of delay RAM usage and pointer movement

🔴 **Live Debugging**
   Set breakpoints, step through instructions, and inspect variables live

🎚️ **Interactive Controls**
   Real-time control of POT0, POT1, POT2 and Bypass during simulation

Resource Usage Tracking
-----------------------

.. image:: _static/images/resource_usage.png
   :alt: Resource Usage Tracking
   :align: center

Monitor your program's resource consumption in real-time:

📌 **Instructions**
   Visual indicator showing usage out of 128 instructions

📌 **Registers**
   Track usage of 32 available registers

📌 **Delay Memory**
   Monitor usage out of 32,768 words of delay RAM


Program Bank Management
-----------------------

.. image:: _static/images/bank_editor.png
   :alt: Bank Editor
   :align: center

Organize and deploy multiple programs to your Easy Spin pedal:

📂 **Visual Bank Editor**
   Manage all 8 program slots with an intuitive interface

🎯 **Drag-and-Drop Assignment**
   Drag ``.spn`` or ``.spndiagram`` files directly into bank slots

🔄 **Mix and Match**
   Combine assembly and block diagram programs in a single bank

⚙️ **Batch Programming**
   Program individual slots or the entire bank at once

🔄 **Automatic Compilation**
   All files compile/assemble automatically during programming

💾 **Export to HEX**
   Save your bank as Intel HEX for archival or use with other programmers


Quick Actions Sidebar
---------------------

Convenient access to common tasks:

✨ Create new block diagram
✨ Create new program bank
✨ Backup entire pedal to HEX

.. image:: _static/images/quick_actions.png
   :alt: Quick Actions Sidebar
   :align: center


Hardware Programming
--------------------

Direct integration with the Audiofab USB Programmer:

🔌 **Program to any slot** (1-8) on your Easy Spin pedal

✓ **Automatic verification** of written data

💾 **Backup entire pedal** to Intel HEX format

📂 **Load HEX files** to EEPROM

💾 **Export banks to HEX** for use with other tools or archival

Supported Blocks
----------------

The extension includes a comprehensive library of effects and utilities:

**Inputs/Outputs**
   Hardware ADC and DAC routing

**Control**
   Smoothers, Power curve shaping, Tremolizers

**Gain/Mixing**
   Custom Mixers, Multi-channel Crossfades, Volume controls

**Filter**
   1-pole LPF/HPFs, 2-pole SVFs

**Effects**
   Including Delays, Modulation (Chorus, Flanger), and Reverbs (Plate, Spring, Room, Minimal)

**Other**
   Fixed and Adjustable Sine Tone Generators

.. note::
   Many blocks are ported from the excellent `SpinCAD Designer <https://github.com/HolyCityAudio/SpinCAD-Designer>`_.