fix: make elf file optional

Author: urish

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.4 - 2025-07-06
+
+- feat: make `elf` parameter optional in `start_simulation()`
+
 ## 0.0.3 - 2025-07-01
 
 - feat: add MicroPython + ESP32 example

docs/index.md

@@ -41,8 +41,7 @@ async def main():
     await client.connect()
     await client.upload_file("diagram.json")
     await client.upload_file("firmware.bin")
-    await client.upload_file("firmware.elf")
-    await client.start_simulation(firmware="firmware.bin", elf="firmware.elf")
+    await client.start_simulation(firmware="firmware.bin")
     serial_task = asyncio.create_task(
         client.serial_monitor_cat()
     )  # Stream serial output

examples/micropython_esp32/main.py

@@ -93,7 +93,7 @@ async def main() -> None:
     await client.upload(FIRMWARE_NAME, bytes(firmware_data))
 
     # Start the simulation
-    await client.start_simulation(firmware=FIRMWARE_NAME, elf=FIRMWARE_NAME)
+    await client.start_simulation(firmware=FIRMWARE_NAME)
 
     # Stream serial output for a few seconds
     serial_task = asyncio.create_task(client.serial_monitor_cat())

src/wokwi_client/client.py

@@ -87,16 +87,17 @@ async def upload_file(
     async def start_simulation(
         self,
         firmware: str,
-        elf: str,
+        elf: Optional[str] = None,
         pause: bool = False,
         chips: list[str] = [],
     ) -> ResponseMessage:
         """
         Start a new simulation with the given parameters.
 
         The firmware and ELF files must be uploaded to the simulator first using the
-        `upload()` or `upload_file()` methods. The firmware and ELF files are required
-        for the simulation to run.
+        `upload()` or `upload_file()` methods.
+        The firmware file is required for the simulation to run.
+        The ELF file is optional and can speed up the simulation in some cases.
 
         The optional `chips` parameter can be used to load custom chips into the simulation.
         For each custom chip, you need to upload two files:
@@ -109,7 +110,7 @@ async def start_simulation(
 
         Args:
             firmware: The firmware binary filename.
-            elf: The ELF file filename.
+            elf: The ELF file filename (optional).
             pause: Whether to start the simulation paused (default: False).
             chips: List of custom chips to load into the simulation (default: empty list).
 

src/wokwi_client/simulation.py

@@ -12,7 +12,7 @@ async def start(
     transport: Transport,
     *,
     firmware: str,
-    elf: str,
+    elf: Optional[str] = None,
     pause: bool = False,
     chips: list[str] = [],
 ) -> ResponseMessage: