# j123b567/scpi-parser architecture

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

- Interactive diagram: https://gitdiagram.com/j123b567/scpi-parser
- Repository: https://github.com/j123b567/scpi-parser

## Overview

libscpi is an instrument-side SCPI command parser. The main workflow accepts command text, parses and matches its command header, makes parameters available to instrument-specific handlers, and provides routines for formatting responses. The README documents broad command-pattern and parameter-type support. Supporting subsystems cover IEEE 488.2 commands and status, errors, units, expressions, and conversions. Source excerpts are partial, so edges are limited to relationships supported by the README or SOURCE INDEX references; examples and build infrastructure are omitted.

Main entry points: [`libscpi/src/parser.c`](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/parser.c) (Parser and results), [`libscpi/src/units.c`](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/units.c) (Units and suffixes), [`libscpi/src/ieee488.c`](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/ieee488.c) (IEEE 488.2), [`libscpi/src/error.c`](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/error.c) (Error handling)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_command["Command processing"]
  node_parser["Parser and results<br/>[parser.c]"]
  node_lexer["Command lexer<br/>[lexer.c]"]
  node_handler_api["Handler interface<br/>[parser.h]"]
end

subgraph group_instrument["Instrument features"]
  node_ieee488["IEEE 488.2<br/>[ieee488.c]"]
  node_minimal["Minimal commands<br/>[minimal.c]"]
  node_errors["Error handling<br/>[error.c]"]
  node_error_queue["Error queue<br/>[fifo.c]"]
end

subgraph group_support["Parsing support"]
  node_units["Units and suffixes<br/>[units.c]"]
  node_expressions["Expression lists<br/>[expression.c]"]
  node_conversions["Conversions<br/>[utils.c]"]
end

subgraph group_foundation["Library foundation"]
  node_config["Configuration<br/>[config.h]"]
  node_types["Shared types<br/>[types.h]"]
  node_constants["SCPI constants<br/>[constants.h]"]
  node_private_helpers["Parser helpers<br/>[parser_private.h]"]
end

node_instrument_user(("Instrument host"))
node_command_text["SCPI commands"]

node_instrument_user -->|"supplies commands"| node_command_text
node_command_text -->|"parses commands"| node_parser
node_parser -->|"uses lexer"| node_lexer
node_parser -->|"exposes handlers"| node_handler_api
node_parser -->|"uses helpers"| node_private_helpers
node_parser -->|"reports errors"| node_errors
node_parser -.->|"supports suffix parameters"| node_units
node_parser -.->|"supports expressions"| node_expressions
node_handler_api -->|"provides results"| node_instrument_user
node_ieee488 -->|"uses error handling"| node_errors
node_ieee488 -->|"uses parser API"| node_parser
node_minimal -->|"uses parser API"| node_parser
node_minimal -->|"uses status commands"| node_ieee488
node_errors -->|"uses FIFO"| node_error_queue
node_expressions -->|"uses parameter types"| node_parser
node_units -->|"uses parser API"| node_parser
node_units -->|"uses conversions"| node_conversions
node_parser -.->|"formats values"| node_conversions
node_config -->|"configures types"| node_types
node_parser -->|"uses constants"| node_constants

click node_parser "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/parser.c"
click node_lexer "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/lexer.c"
click node_handler_api "https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/parser.h"
click node_ieee488 "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/ieee488.c"
click node_minimal "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/minimal.c"
click node_errors "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/error.c"
click node_error_queue "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/fifo.c"
click node_units "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/units.c"
click node_expressions "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/expression.c"
click node_conversions "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/utils.c"
click node_config "https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/config.h"
click node_types "https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/types.h"
click node_constants "https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/constants.h"
click node_private_helpers "https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/parser_private.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_parser,node_lexer,node_handler_api toneBlue
class node_ieee488,node_minimal,node_errors,node_error_queue toneAmber
class node_units,node_expressions,node_conversions toneMint
class node_config,node_types,node_constants,node_private_helpers toneRose
class node_instrument_user,node_command_text toneIndigo
```

## Components

### Command processing

- [Parser and results](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/parser.c): `libscpi/src/parser.c`
- [Command lexer](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/lexer.c): `libscpi/src/lexer.c`
- [Handler interface](https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/parser.h): `libscpi/inc/scpi/parser.h`

### Instrument features

- [IEEE 488.2](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/ieee488.c): `libscpi/src/ieee488.c`
- [Minimal commands](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/minimal.c): `libscpi/src/minimal.c`
- [Error handling](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/error.c): `libscpi/src/error.c`
- [Error queue](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/fifo.c): `libscpi/src/fifo.c`

### Parsing support

- [Units and suffixes](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/units.c): `libscpi/src/units.c`
- [Expression lists](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/expression.c): `libscpi/src/expression.c`
- [Conversions](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/utils.c): `libscpi/src/utils.c`

### Library foundation

- [Configuration](https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/config.h): `libscpi/inc/scpi/config.h`
- [Shared types](https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/types.h): `libscpi/inc/scpi/types.h`
- [SCPI constants](https://github.com/j123b567/scpi-parser/blob/master/libscpi/inc/scpi/constants.h): `libscpi/inc/scpi/constants.h`
- [Parser helpers](https://github.com/j123b567/scpi-parser/blob/master/libscpi/src/parser_private.h): `libscpi/src/parser_private.h`

### Other components

- **Instrument host**
- **SCPI commands**

## Connections

- Instrument host → SCPI commands: supplies commands (evidence: `README.md`)
- SCPI commands → Parser and results: parses commands (evidence: `README.md`)
- Parser and results → Command lexer: uses lexer (evidence: `libscpi/src/parser.c`)
- Parser and results → Handler interface: exposes handlers (evidence: `libscpi/src/parser.c`)
- Parser and results → Parser helpers: uses helpers (evidence: `libscpi/src/parser.c`)
- Parser and results → Error handling: reports errors (evidence: `libscpi/src/parser.c`)
- Parser and results → Units and suffixes: supports suffix parameters
- Parser and results → Expression lists: supports expressions
- Handler interface → Instrument host: provides results (evidence: `README.md`)
- IEEE 488.2 → Error handling: uses error handling (evidence: `libscpi/src/ieee488.c`)
- IEEE 488.2 → Parser and results: uses parser API (evidence: `libscpi/src/ieee488.c`)
- Minimal commands → Parser and results: uses parser API (evidence: `libscpi/src/minimal.c`)
- Minimal commands → IEEE 488.2: uses status commands (evidence: `libscpi/src/minimal.c`)
- Error handling → Error queue: uses FIFO (evidence: `libscpi/src/error.c`)
- Expression lists → Parser and results: uses parameter types (evidence: `libscpi/src/expression.c`)
- Units and suffixes → Parser and results: uses parser API (evidence: `libscpi/src/units.c`)
- Units and suffixes → Conversions: uses conversions (evidence: `libscpi/src/units.c`)
- Parser and results → Conversions: formats values
- Configuration → Shared types: configures types (evidence: `libscpi/inc/scpi/types.h`)
- Parser and results → SCPI constants: uses constants (evidence: `libscpi/src/parser.c`)
