API Reference
Auto-generated documentation for the RouteRTL Python API.
Public Interface
The RouteRTL SDK exposes its public API through the routertl.sim namespace:
from routertl.sim import Tb, run_simulation
from routertl.sim import UartSource, SpiMaster, I2cMaster
Modules
Core
| Module | Description |
|---|---|
| Testbench Environment | Tb / TbEnv — clock, reset, logging, and monitor management |
| Simulation Runner | run_simulation() — unified simulation entry point |
Protocol Drivers
| Module | Description |
|---|---|
| AXI-Lite | AxiLiteMaster, AxiLiteSlave — AMBA AXI4-Lite BFMs |
| AXI4 | Full AXI4 burst-capable BFMs |
| Avalon-MM | AvalonMMMaster, AvalonMMSlave — Intel Avalon BFMs |
| UART | UartSource, UartSink — async serial drivers |
| SPI | SpiMaster — SPI bus functional model |
| I2C | I2cMaster — I²C bus functional model |
| Native Memory | Direct memory interface driver |
Build & Hooks
| Module | Description |
|---|---|
| Hook Authoring | resolve_tool_binary(), load_project_config() — public API for pre-build hooks |