Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/ports/debugger-port.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ import type {
} from './types'

export interface DebuggerPort {
/**
* Get list of available debug ports/devices.
* Includes standard COM ports and special devices like ST-LINK V2.
* Used by the port selection UI to show available debug targets.
*/
getAvailablePorts?(): Promise<Array<{ path: string; manufacturer?: string; productId?: string; vendorId?: string }>>

/**
/**
* Connect to a debug target.
* The adapter resolves the actual transport (TCP, RTU, WebSocket, WebRTC, simulator)
Expand Down
10 changes: 10 additions & 0 deletions docs/ports/device-port.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ export interface DevicePort {
* Editor: queries local system serial ports.
* Web: may not be applicable locally (ports come from remote device).
*/
/**
* Get available serial/communication ports.
* Editor: queries local system serial ports and USB devices (e.g., ST-LINK V2).
* Web: may not be applicable locally (ports come from remote device).
*/
getCommunicationPorts(): Promise<CommunicationPort[]>

/**
Expand All @@ -50,6 +55,11 @@ export interface DevicePort {
* Editor: re-scans local system serial ports.
* Web: re-queries orchestrator for available ports.
*/
/**
* Refresh communication ports list.
* Editor: re-scans local system serial ports and USB devices.
* Web: re-queries orchestrator for available ports.
*/
refreshCommunicationPorts(): Promise<CommunicationPort[]>

/**
Expand Down