Skip to content

probe-web / @probe-web/client / index / OpenSessionOptions

Interface: OpenSessionOptions

Defined in: index.ts:531

What openSession needs: a transport, which probe (substring of its name or serial), and the target.

Properties

PropertyTypeDescriptionDefined in
transport"websocket" | "webusb"Which transport to connect over (see Transport).index.ts:533
url?stringWebSocket URL of probe-rs serve (default ws://127.0.0.1:3000).index.ts:535
token?stringAccess token for probe-rs serve, if it requires one.index.ts:537
worker?WorkerA worker to host probe-rs in, instead of the default one (tests pass the fake-probe worker).index.ts:539
probe?stringCase-insensitive substring of the probe's name or serial number; the first probe when omitted.index.ts:541
chip?stringprobe-rs chip name, or omit for auto-detection.index.ts:543
protocol?"Swd" | "Jtag"Debug protocol; the probe's default when omitted.index.ts:545
connectUnderReset?booleanHold the target in reset while connecting.index.ts:547