Device

If you are building a new device API, read in this order:

1. Base Device

2. Parameter System

3. Function System

4. Command Solver

5. Traffic Manager

6. Error Handling

7. Logging System

8. Test Helpers

To orchestrate several devices as one unit (the shape an Experiment consumes), see Composite Device.

Topic Guide

Core Architecture

1. Base Device: Defines the synchronized device abstraction and lifecycle.

2. Traffic Manager: Implements transport communication (Serial, VISA, TCP/IP).

3. Command Solver: Maps standardized operations to protocol commands.

4. Composite Device: Groups local and remote devices with resilient remote calls.

Metadata and API Contracts

1. Parameter System: Declares configuration parameters, constraints, and parsing rules.

2. Function System: Declares operation signatures, validates inputs/outputs, and binds execution.

Runtime Utilities

1. Error Handling: Standard error propagation and contextual wrapping.

2. Logging System: Process-level logging setup and usage patterns.

3. Test Helpers: Auto-test utilities for config parameters, operations, resource contention, and schema refresh.