PVI

PVI (PV Interface) is a framework for specifying the interface to an EPICS driver in a single YAML file. The initial target is asyn port driver based drivers, but it could be extended to streamDevice and other driver types at a later date.

It allows the asyn parameter interface to be specified in a single place, and removes boilerplate code in the driver CPP, template files, documentation, and low level opis

PyPI	pip install pvi
Source code	https://github.com/epics-containers/pvi
Documentation	https://epics-containers.github.io/pvi
Releases	https://github.com/epics-containers/pvi/releases

---

Note: This module is currently a proposal only, so all details are subject to change at any point. The documentation is written in the present tense, but only prototype code is written.

---

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

Tutorials

• Installation
  • Check your version of python
  • Create a virtual environment
  • Installing the library

How-to Guides

Practical step-by-step guides for the more experienced user.

How-to Guides

• Drivers
  • Database Template File
  • UI
  • Ongoing Development
    • With PVI
    • Without PVI
  • Class Hierarchy
    • Change Summary
    • Caveats
    • Next Steps
    • Possible Further Work
• How to Write a Site Specific Formatter
  • Overview
  • Create a formatter subclass
  • Define the Screen Layout Properties
  • Assign a Template File
  • Divide the Template into Widgets
  • Define screen and group widget functions
  • Construct a Screen Object
  • Generate the Screen file

Explanations

Explanation of how the library works and why it works that way.

Explanations

• Why is something the way it is
  • How it works
    • YAML file
    • Screen files
    • HTML Documentation
  • Questions
    • One-time generation and checked into source control or generated by Makefile?
    • Which screen tools to support?

Reference

Practical step-by-step guides for the more experienced user.

Reference

• API
  • pvi
• Contributing
  • Running the tests
  • Code Styling
  • Documentation
  • Release Process
  • Updating the tools
• Releases
• Index

About the documentation

Why is the documentation structured this way?