connect
Open a debug session to a connected probe by specifying probe serial, target type, board ID, or custom board config.
Instructions
Open a debug session to a connected probe.
Args:
unique_id: Whole or partial probe serial/unique ID to select a specific
probe. Omit when exactly one probe is attached. Defaults to the
``PYOCD_PROBE_UID`` environment variable if unset.
target: Target type override, e.g. "stm32f407vg" or "nrf52833". Takes
precedence over a board config. Omit to use the selected board's
target (when ``board_id`` is given), else the ``PYOCD_TARGET``
environment variable, else pyOCD auto-detection.
board_id: Load facts from ``boards/<board_id>.yaml`` through the shared
board-config loader — pyOCD target, recover policy, silicon id, baud.
Lets a custom ST/nRF board connect by id with no hand-passed target;
call ``get_board_info`` to see the loaded facts. Defaults to the
``PYOCD_BOARD_ID`` environment variable.
board_config: Path to an extra board-config file outside the tracked
``boards/`` directory, for a custom board. Defaults to the
``PYOCD_BOARD_CONFIG`` environment variable.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| target | No | ||
| board_id | No | ||
| unique_id | No | ||
| board_config | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |