# jancumps/pico_scpi_usbtmc_lablib architecture

> Architecture diagram of the GitHub repository jancumps/pico_scpi_usbtmc_lablib, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jancumps/pico_scpi_usbtmc_lablib
- Repository: https://github.com/jancumps/pico_scpi_usbtmc_lablib

## Overview

PSL is an embedded framework for SCPI-capable lab devices exposed over USBTMC. A USB host sends commands through the USBTMC application, which passes completed input to the SCPI instrument layer; SCPI output is buffered for USBTMC replies. The framework also supplies USB descriptors, USB488 status/trigger handling, and LED indicator behavior. Edges reflect calls visible in the excerpts; the README gives no further workflow detail, and the SCPI parser submodule implementation was not sampled.

Main entry points: [`usb/usbtmc_app.c`](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usbtmc_app.c) (USBTMC Application), [`scpi/scpi_base.c`](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/scpi/scpi_base.c) (SCPI Instrument), [`usb/usb_descriptors_common.c`](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usb_descriptors_common.c) (USB Descriptors), [`usb/usbtmc_device_custom.c`](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usbtmc_device_custom.c) (USBTMC SRQ)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_usb["USB Device"]
  node_descriptors["USB Descriptors"]
  node_tmc["USBTMC Application<br/>[usbtmc_app.c]"]
  node_custom["USBTMC SRQ"]
  node_tmc_api["USBTMC API<br/>[usbtmc_app.h]"]
  node_custom_api["USBTMC Device API"]
end

subgraph group_scpi["SCPI Instrument"]
  node_scpi["SCPI Instrument<br/>[scpi_base.c]"]
  node_scpi_api["SCPI Interface<br/>[scpi_base.h]"]
end

subgraph group_support["Device Support"]
  node_usb_utils["USB Utilities<br/>[usb_utils.c]"]
  node_usb_utils_api["USB Utility API<br/>[usb_utils.h]"]
end

node_host(("USB Host"))

node_host -->|"requests descriptors"| node_descriptors
node_host -->|"sends commands"| node_tmc
node_tmc -->|"submits input"| node_scpi
node_scpi -->|"writes replies"| node_tmc
node_scpi -->|"signals SRQ"| node_tmc
node_tmc -->|"sends SRQ"| node_custom
node_tmc -->|"handles trigger"| node_scpi
node_tmc -->|"pulses indicator"| node_usb_utils

click node_descriptors "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usb_descriptors_common.c"
click node_tmc "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usbtmc_app.c"
click node_custom "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usbtmc_device_custom.c"
click node_scpi "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/scpi/scpi_base.c"
click node_scpi_api "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/scpi/scpi_base.h"
click node_usb_utils "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usb_utils.c"
click node_usb_utils_api "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/usb/usb_utils.h"
click node_tmc_api "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/usb/usbtmc_app.h"
click node_custom_api "https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/usb/usbtmc_device_custom.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_descriptors,node_tmc,node_custom,node_tmc_api,node_custom_api toneBlue
class node_scpi,node_scpi_api toneAmber
class node_usb_utils,node_usb_utils_api toneMint
class node_host toneIndigo
```

## Components

### USB Device

- [USB Descriptors](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usb_descriptors_common.c): `usb/usb_descriptors_common.c`
- [USBTMC Application](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usbtmc_app.c): `usb/usbtmc_app.c`
- [USBTMC SRQ](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usbtmc_device_custom.c): `usb/usbtmc_device_custom.c`
- [USBTMC API](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/usb/usbtmc_app.h): `include/usb/usbtmc_app.h`
- [USBTMC Device API](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/usb/usbtmc_device_custom.h): `include/usb/usbtmc_device_custom.h`

### SCPI Instrument

- [SCPI Instrument](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/scpi/scpi_base.c): `scpi/scpi_base.c`
- [SCPI Interface](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/scpi/scpi_base.h): `include/scpi/scpi_base.h`

### Device Support

- [USB Utilities](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/usb/usb_utils.c): `usb/usb_utils.c`
- [USB Utility API](https://github.com/jancumps/pico_scpi_usbtmc_lablib/blob/main/include/usb/usb_utils.h): `include/usb/usb_utils.h`

### Other components

- **USB Host**

## Connections

- USB Host → USB Descriptors: requests descriptors (evidence: `usb/usb_descriptors_common.c`)
- USB Host → USBTMC Application: sends commands (evidence: `usb/usbtmc_app.c`)
- USBTMC Application → SCPI Instrument: submits input (evidence: `usb/usbtmc_app.c`)
- SCPI Instrument → USBTMC Application: writes replies (evidence: `scpi/scpi_base.c`)
- SCPI Instrument → USBTMC Application: signals SRQ (evidence: `scpi/scpi_base.c`)
- USBTMC Application → USBTMC SRQ: sends SRQ (evidence: `usb/usbtmc_app.c`)
- USBTMC Application → SCPI Instrument: handles trigger (evidence: `usb/usbtmc_app.c`)
- USBTMC Application → USB Utilities: pulses indicator (evidence: `usb/usbtmc_app.c`)
