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
| Property | Type | Description | Defined in |
|---|---|---|---|
transport | "websocket" | "webusb" | Which transport to connect over (see Transport). | index.ts:533 |
url? | string | WebSocket URL of probe-rs serve (default ws://127.0.0.1:3000). | index.ts:535 |
token? | string | Access token for probe-rs serve, if it requires one. | index.ts:537 |
worker? | Worker | A worker to host probe-rs in, instead of the default one (tests pass the fake-probe worker). | index.ts:539 |
probe? | string | Case-insensitive substring of the probe's name or serial number; the first probe when omitted. | index.ts:541 |
chip? | string | probe-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? | boolean | Hold the target in reset while connecting. | index.ts:547 |