Skip to content

Document app.stream() write's ~2KB per-message payload limit #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cscaff merged 2 commits into from
Jul 12, 2026
Merged

Document app.stream() write's ~2KB per-message payload limit #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34a048e
Document app.stream() write's ~2KB per-message payload limit
Jul 12, 2026
291b1b0
Trim payload-limit note to just the constraint and workaround
Jul 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/guides/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,14 @@ the same FPGA at the same time -- the bridge firmware only safely serves one
open connection per board, so opening a stream holds an exclusive lock on the
FPGA's link for the life of the `with` block.

**Per-write payload limit:** a burst `write(addr, value, ...)` is capped at
roughly **2KB (~500 32-bit words)**. Going over it closes the connection,
raised client-side as `websockets.exceptions.ConnectionClosedError` with the
reason `"FPGA is busy with a run job"` -- ignore that text, it's a payload
size limit, not a concurrency/session issue. If you need to send more than
that, split `value` into chunks under ~500 words and call `write()` once per
chunk; `fixed_address=True` composes fine across chunked calls.

#### `app.release()`

Release the active session, returning the board to `idle`. Returns the reset
Expand Down
Loading