933e276e1a
I split his two "Fields Common to ..." sections back into separate docs, added links between them all, and made the appropriate build changes. Also added these and the aai/aao records to the documentation index.
2.9 KiB
2.9 KiB
Record Reference Documentation
The following documentation for the record types and menus include with Base was converted from the old EPICS Wiki pages and updated. This list only includes the record types supplied with Base.
- Fields Common to All Record Types
- Fields Common to Input Record Types
- Fields Common to Output Record Types
Record Types
- Analog Array Input Record (aai)
- Analog Array Output Record (aao)
- Analog Input Record (ai)
- Analog Output Record (ao)
- Array Subroutine Record (aSub)
- Binary Input Record (bi)
- Binary Output Record (bo)
- Calculation Output Record (calcout)
- Calculation Record (calc)
- Compression Record (compress)
- Data Fanout Record (dfanout)
- Event Record (event)
- Fanout Record (fanout)
- Histogram Record (histogram)
- Long Input Record (longin)
- Long Output Record (longout)
- Long String Input Record (lsi)
- Long String Output Record (lso)
- Multi-Bit Binary Input Direct Record (mbbiDirect)
- Multi-Bit Binary Input Record (mbbi)
- Multi-Bit Binary Output Direct Record (mbboDirect)
- Multi-Bit Binary Output Record (mbbo)
- Permissive Record (permissive)
- Printf Record (prinf)
- Select Record (sel)
- Sequence Record (seq)
- State Record (state)
- String Input Record (stringin)
- String Output Record (stringout)
- Sub-Array Record (subArray)
- Subroutine Record (sub)
- Waveform Record (waveform)
Menu Definitions
- Alarm Severity Menu
- Alarm Status Menu
- Analog Conversions Menu
- Field Type Menu
- Invalid Value Output Action Menu
- Output Mode Select Menu
- Scan Menu
- Simulation Mode Menu
- Yes/No Menu
Corrections and Updates
Corrections to these documents can be submitted as patch files to the EPICS core
developers, or as merge requests or pull requests to the 3.15 branch of Base.
The document sources can be found in the src/std/rec and src/ioc/db
directories in files with extension .dbd.pod. The documentation source format
is a combination of the EPICS DBD file format with an extended version of Perl's
POD (plain old documentation); run perldoc pod for details of POD.