read
Fetches newly received serial frames since your previous cursor, waits up to timeout_ms for the first frame, and reports dropped_bytes if the buffer overflowed.
Instructions
Cursor-based framed read: returns frames received since your previous read (waits up to timeout_ms for the first frame). Reports dropped_bytes if the buffer overflowed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_frames | No | ||
| session_id | Yes | ||
| timeout_ms | No | ||
| max_inline_bytes | No | Result JSONs longer than this many bytes are written in full to .openbaud/out/ and returned as a summary carrying a full_result path — keeps huge payloads out of your context. Raise it to force large results inline. |