What is Spvirit?
✅ Verified · no code on this page ·
The badge reports the whole
docs-verifysuite, not this chapter alone.
Spvirit is a Rust implementation of the EPICS PVAccess protocol: the wire codec, a client, a server, a set of command-line tools, and Python bindings. It talks to EPICS Base, p4p/pvxs, and PVAccessJava, and it needs none of them installed to build or run.
/ˈspɪrɪt/ of the Machine
The crates
The project is a Cargo workspace of nine crates, strictly layered. Each crate
depends only on the ones above it. The six below form the core stack;
spvirit-ioc (synchronous record-processing engine), spvirit-gateway
(p4p-compatible gateway) and spvirit-calc (CALC expression evaluator) are
described in the crate map.
| Crate | What it is |
|---|---|
spvirit-types | Shared data model for PVAccess Normative Types. Pure data, no I/O. |
spvirit-codec | Protocol encoding/decoding (PVA message layer + pvData) and segment reassembly. |
spvirit-client | Search, connect, get, put, monitor. |
spvirit-server | .db parsing, the Source trait, the PVAccess server runtime. |
spvirit-tools | The command-line tools, and the integration test suites. |
spvirit-py | Python bindings via PyO3, client and server. |
flowchart LR
T["spvirit-types"] --> C["spvirit-codec"]
C --> CL["spvirit-client"]
C --> SV["spvirit-server"]
SV --> IOC["spvirit-ioc"]
CL --> GW["spvirit-gateway"]
SV --> GW
CL --> TO["spvirit-tools"]
SV --> TO
GW --> TO
CL --> PY["spvirit-py"]
SV --> PY
IOC --> PY
If you only want to read and write PVs from Rust, you need spvirit-client.
If you want to serve them, spvirit-server. Both pull in the two layers below
automatically.
When to reach for it
Spvirit is a good fit when you want to:
- Read or write PVs from a Rust program without linking EPICS Base.
- Stand up a simulator or test double: a handful of PVs that behave like an IOC, in a few lines, started and stopped from a test.
- Bridge something into PVAccess (a REST API, a file, a piece of
hardware with its own protocol) using the
Sourcetrait. - Debug the wire: the tools hex-dump frames, watch search traffic, and byte-compare against captures from other implementations.
- Drive PVs from Python without the p4p build chain.
When not to
spvirit-server is not a production softIOC replacement. It implements
the record behaviours that matter for simulation and testing (values, alarms,
deadbands, scan and put callbacks, links), but it is not EPICS Base. It does not implement the full record
processing model, database links with all their link types, or the
sequencing guarantees a real IOC gives you. If you are running a beamline,
run an IOC.
The separate spvirit-ioc crate adds a real record-processing engine (scan lists, link
graph, lock sets) for ai/ao/bi/bo/longin/longout; it is still not
a full EPICS Base (no calc/calcout/seq/fanout records).
Development is also ongoing rather than finished. The near-term work is expanding the server's softIOC behaviours and record processing, and adding TLS support and structured put payloads to the client.
Where to go next
- New to EPICS? EPICS in 10 minutes.
- Know EPICS, want it running? Installation.
- Want the internals? The Developer guide.