caproto: a pure-Python Channel Access protocol library¶
Caproto is an implementation of the EPICS Channel Access protocol for distributed hardware control in pure Python with a “sans-I/O” architecture.
Caproto is a toolkit for building Python programs that speak Channel Access (“EPICS”). It includes a reusable core that encodes the Channel Access protocol. It also includes several client and server implementations built on that core. This layered design is inspired by the broad effort in the Python community to write sans-I/O implementations of network protocols. The EPICS (Experimental Physics and Industrial Control System) Channel Access protocol is used in laboratories and companies around the world to implement distributed control systems for devices such as large telescopes, particle accelerators, and synchrotrons. Its roots go back to a 1988 meeting funded by the Reagan-era Strategic Defense Initiative (“Star Wars”).
The authors pronounce caproto “kah-proto” (not “C.A. proto”). It’s fun to say.
Caproto is intended as a friendly entry-point to EPICS. It may be useful for scientists who want to understand their hardware better, engineers learning more about the EPICS community, and “makers” interested in using it for hobby projects — EPICS has been used for brewing beer and keeping bees! At the same time, caproto is suitable for use at large experimental facilities.
Try caproto in four lines¶
First verify that you have Python 3.6+.
If necessary, install it by your method of choice (apt, Homebrew, conda, etc.). Now install caproto:
python3 -m pip install -U caproto
In one terminal, start an EPICS Input-Output Controller (IOC), which is a server.
python3 -m caproto.ioc_examples.simple --list-pvs
In another, use the command-line client:
caproto-put simple:A 42
10 Reasons To Use Caproto and 1 Big Reason Not To¶
Most existing EPICS tools are built on well-established C and C++ libraries. Why write something from scratch in Python instead of just wrapping those?
Effortlessly Portable: No required dependencies — even numpy is optional. Caproto just needs Python itself. We use it on Linux, OSX, Windows, and RaspberryPi.
Easy to Install and Use: See “Try caproto in four lines,” above.
Handy for Debugging: Programmatic access to convenient Python objects embodying every CA message sent and received. See the examples of verbose logging with the Command-Line Client.
Efficient: Data is read directly from sockets into contiguous-memory ctypes structures.
Only pay a performance cost of human-friendly introspection if and when you use it.
Batteries Included: Includes multiple server and client implementations with different concurrency strategies.
Command-line tools (largely argument-compatible with standard epics-base ca*)
A drop-in replacement for pyepics
Various client and server implementations that are synchronous, threaded, or employing one of Python’s cooperative concurrency frameworks
Accessible: Writing IOCs in pure Python is so easy, a scientist can do it!
Reusable: “Sans-I/O” design separates protocol interpretation from wire transport. See the sans-I/O documentation for more on the rationale for this design pattern and a list of related projects.
Consistent: Server and client implementations share protocol state machine code.
Robust: Over 1500 unit tests verify compatibility with standard epics-base tools (tested against 3.14, 3.15, 3.16, R7).
Succinct: The core of the package is about the same word count as the CA protocol documentation.
All that said, some applications of EPICS — such as running an accelerator — rely on the battle-tested reliability of EPICS’ reference implementation. We would advise those kinds of users to steer well clear of caproto. It is best suited to applications that reward convenience, fast iteration, and accessibility.
Some facilities do use caproto “in production” for these kinds of applications, and we are pleased to hear that it works well. Keep in mind that caproto is maintained primarily by two people as a hybrid work/hobby project, mostly on evenings and weekends. At present, no facilities or funding sources have formally committed resources to its continued support. If a facility makes a “bet” on caproto:
Depending on the size of the bet and the scale of support it may require, the facility should commit someone to becoming a caproto core developer.
The facility should also maintain general EPICS (base) expertise, so that they have a reasonable path to back out of caproto if they need to.
What about pvAccess?¶
Caproto offers very preliminary pvAccess support. See more in the Overview section.
Requirements: Python 3.6+ (no other required dependencies!)
License: 3-clause BSD
The design of this library was modeled on h11, to which caproto owes its core design principles and many of its clever tricks. h11 is distributed under an MIT license.
And of course many resources from the EPICS developer community were indispensable. See References.
In addition to its core “sans I/O” protocol library, caproto includes some ready-to-use client and server implementations exploring different API choices and networking libraries. They are organized into packages by how they handle concurrency. Some will be maintained long-term; others may be abandoned as learning exercises.
- Install Caproto
- Environment Variables
- Shark (pcap/tcpdump parsing)
- Input-Output Controllers (IOCs)
- IOC Template Cookiecutters
- Writing Your Own Documentation
- Server API
- Synchronous Client
- Input-Output Controllers (IOCs)
- Type Annotations
- Using the IOC Examples
- PVAccess API
- Details of our Protocol Compliance for CA Nerds
- Release History
- v0.8.0 (2021-03-??)
- v0.7.1 (2020-01-13)
- v0.7.0 (2020-12-08)
- v0.6.0 (2020-07-31)
- v0.5.2 (2020-06-18)
- v0.5.1 (2020-06-12)
- v0.5.0 (2020-05-01)
- v0.4.4 (2020-03-26)
- v0.4.3 (2020-01-29)
- v0.4.2 (2019-11-13)
- v0.4.1 (2019-10-06)
- v0.4.0 (2019-06-06)
- v0.3.4 (2019-05-02)
- v0.3.3 (2019-04-11)
- v0.3.2 (2019-03-06)
- v0.3.1 (2019-03-05)
- v0.3.0 (2019-02-20)
- v0.2.3 (2019-01-02)
- v0.2.2 (2018-11-15)
- v0.2.1 (2018-10-29)
- v0.2.0 (2018-10-17)
- v0.1.2 (2018-08-31)
- v0.1.1 (2018-06-17)
- v0.1.0 (2018-06-14)