Quick start

This guide takes you from a fresh install to reading a parameter and a fault code. Every step uses the English UI labels you see in the application.

1. Install

1. The installer is not published yet. When it is, download bmsetup.exe from the release page.
2. Run the installer. Windows 10 or newer is required.
3. Install the x86 Microsoft Visual C++ 2015–2022 Redistributable if the installer asks for it.
4. Start BlackMagic from the Start menu.

2. Choose a workspace

On first launch the app asks for a workspace directory. A workspace contains:

workspace/
├── data/       # DTC databases, DID descriptions, auth DLLs, config.json
├── logs/       # session logs
├── projects/   # one folder per project
├── scripts/    # shared Lua scripts
└── firmware/   # shared firmware images

Pick an empty folder you can write to. The app creates the subdirectories itself. You can switch workspaces later from the workspace selector.

3. Create a project

1. File → New project (Ctrl+N).
2. Add an ECU manually, or open Tools → CAN Scanner and add the ECUs found on the bus.
3. Save the project (Ctrl+S). The app creates a folder inside the workspace projects/ directory.

Each ECU keeps its own transport (CAN or DoIP), parameters, routines and DTC settings.

4. Connect to the vehicle

For CAN, open View → Settings → PassThru Interface and select a J2534 driver. The status bar shows CAN Interface: Connected when the link is up.

For DoIP, open Tools → DoIP Setup, choose the network adapter, set Own IP / Netmask (static or DHCP), the destination IP, port 13400 and the tester address (0x0E80), then use Discover or Scan. Select DoIP as the transport for the ECU in its settings.

5. Read something

1. Double-click the ECU in ECU List to open it in ECU Edit.
2. On the Info tab press Refresh Info to read identification parameters.
3. On the Measurement Values tab set an update period and press Start.
4. On the DTC tab press Read DTC to load fault memory.

6. Write a value

Open the Parameters or Writable Values tab, change the value and confirm the write. Writes use the security level configured for that parameter; if the ECU requires seed/key access, the project must reference a Seed2Key DLL in data/auth/.

Writing parameters and running routines changes the vehicle. Make sure you know what the parameter does before sending a write.

Keyboard shortcuts

Shortcut	Action
Ctrl+N	New project
Ctrl+O	Open project
Ctrl+S	Save project
Ctrl+Z / Ctrl+Y	Undo / Redo
Ctrl+R	Read selected parameters (ECU Edit)
Ctrl+C	Copy selected parameters
Ctrl+A	Select all parameters
Alt+,	Settings

Undo depth is configurable (default 20, range 0–100) and is not kept between launches. Undo is blocked while an ECU task is running.

All guide pages

• Install — requirements, installer, silent install.
• Workspace — layout, backup, moving.
• Project setup — ECUs by hand and from the scanner.
• Connect to a vehicle — J2534 and DoIP.
• Read and write values — identification, parameters, security.
• Read and clear faults — DTC, snapshots, databases.
• Record live data — polling, graphs, CSV.
• Scripting quick start — first Lua script.
• File formats — project, dump, DID, logs.
• FAQ — common transport and access problems.

Next steps

• Features — what each window does in detail.
• Download — requirements and checksums.