Skip to content

Run records ​

A run record is one run of your firmware on a real board, recorded and published. Anyone with the link can play it back: the firmware being written, the board booting, and everything it printed, with the original timing. No account is needed to watch, and watching never touches a board.

Run on SiliconRig

Use it where a claim about real hardware would otherwise have to be taken on trust: a benchmark table, a driver's self-test, a bug report.

Record a run ​

From the CLI:

bash
srig record build/bench.elf --board esp32-s3 --name "Inference benchmark" --seconds 30

It runs the firmware on a free board, waits until the recording is done, then prints the link and the badge in Markdown. Exit codes: 0 recorded, 1 the recording failed, 2 infrastructure error (for example no free board).

From the browser: Records in the dashboard takes the same inputs, lists your records and copies a badge in one click.

Through the API: POST /v1/run-records with the firmware as a multipart upload; see the API reference.

InputDefault
firmwareSame formats as a flash: .bin, .uf2 for rp2350, .elf / .hex for STM32 boards
board typeRequired
namefile nameShown with the recording
sendnoneWritten to the board once it has booted and gone quiet, for firmware that waits for a command
length30 s10 to 120 seconds after the firmware is on the board

A recording is a session of yours and uses credits like one. An account keeps up to 20 records.

What a record shows ​

Next to the recording, every record lists what the run depended on:

  • the SHA-256 and size of the firmware that ran,
  • the board type and the board it ran on,
  • the versions of the SiliconRig agent and coordinator,
  • when it was recorded.

A recording keeps up to 4 MB of output; a run that prints more is cut off at the end and marked as such.

Put the badge in a README ​

srig record and the dashboard both give you the Markdown:

markdown
[![Run on SiliconRig](https://siliconrig.dev/badge/run-on-siliconrig.svg)](https://siliconrig.dev/record/rec_...)

A record never changes. To show a new build, record it again and update the link; delete the old record from the dashboard when nothing links to it any more.

When to record again ​

The same firmware on the same hardware gives the same recording, so a record does not go stale with time. Record again when something it depended on changes: a new build of your firmware, the board it ran on, or the platform versions it lists. Output that varies from run to run, such as timing jitter or sensor readings, is one sample in a recording.

Run it live ​

Signed in, the record page offers Run it live yourself: it starts an ordinary session with the record's firmware already on a free board of the same type, and opens its console. It is billed like any session. The API equivalent is POST /v1/sessions with record_id in place of board_type.