NB: This manual refers to a very old version of EPICS, see the EPICS Wiki for updated record reference documentation.

[Next] [Previous] [Top] [Index]

EPICS Record Reference Manual

Contents


Copyright
- Contents
Preface
Organization
Conventions
Record Tables
Inaccuracies
Chapter 1: - Database Concepts
1. - Scanning Specification
1.1. - Periodic Scanning
1.2. - Event Scanning
I/O Interrupt Events
User-defined Events
1.3. - Passive Scanning
Passive Scanning and Channel Access Links
1.4. - Phase
1.5. - Forward Process Links
2. - Address Specification
2.1. - Hardware Addresses
VME Bus
Allen-Bradley Bus
Camac Bus
Others
2.2. - Database Addresses
Channel Access Links
2.3. - Constants
3. - Conversion Specification
3.1. - Discrete Conversions
3.2. - Analog Conversions
Linear Conversions
Transducer Matches the I/O module
Transducer Lower than the I/O module
Transducer Positive and I/O module bipolar
Combining Linear Conversion with an Amplifier
Breakpoint Conversions
4. - Alarm Specification
Alarm Severity
Scan Alarm
Read Alarm
Write Alarm
Limit Alarms
State Alarms
Alarm Handling
5. - Monitor Specification
5.1. - Notification
5.2. - List Maintenance
6. - Control Specification
6.1. - Closing an Analog Control Loop
Chapter 2: - Fields Common to All Record Types
1. - Introduction
2. - Scan Fields
2.1. - Field Summary
2.2. - Field Description
3. - Alarm Fields
3.1. - Field Summary
3.2. - Field Description
4. - Device Fields
4.1. - Field Summary
4.2. - Field Description
5. - Debugging Fields
5.1. - Field Summary
5.2. - Field Description
6. - Miscellaneous Fields
6.1. - Field Description
6.2. - Field Description
Chapter 3: - Fields Common to Many Record Types
1. - Introduction
2. - Input Records
2.1. - Common Fields
2.2. - Device Input
2.3. - Soft Input
2.4. - Simulation Mode
3. - Output Records
3.1. - Common Fields
3.2. - Soft Output
3.3. - Output Mode Select
3.4. - Simulation Mode
3.5. - Invalid Alarm Output Action
Chapter 4: - ai--Analog Input
1. - Introduction
2. - Scanning Parameters
3. - Read and Convert Parameters
3.1. - Input Specification
3.2. - Conversion Related Fields
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Monitor Parameters
7. - Run-Time Parameters and Simulation Mode Parameters
8. - Record Support Routines
init_record
process
special
get_value
get_alarm_double
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
read_ai
special_linconv
10.3. - Device Support For Soft Records
Soft Channel
Raw Soft Channel
Chapter 5: - ao - Analog Output
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Convert and Write Parameters
4.1. - Conversion Related Fields and the Conversion Process
4.2. - Output Specification
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Monitor Parameters
8. - Run-Time Parameters and Simulation Mode Parameters
9. - Record Support Routines
init_record
process
special
get_value
get_alarm_double
10. - Record Processing
11. - Device Support
11.1. - Fields Of Interest To Device Support
11.2. - Device Support routines
init
init_record
get_ioint_info
write_ao
special_linconv
11.3. - Device Support For Soft Records
Soft Channel
Raw Soft Channel
Chapter 6: - The Archive Record
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Archive and Monitor Parameters
5. - Operator Display Parameters
6. - Run-time Parameters
Chapter 7: - bi - Binary Input
1. - Introduction
2. - Scan Parameters
3. - Read and Convert Parameters
3.1. - Conversion Fields
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time Parameters and Simulation Mode Parameters
7. - Record Support Routines
init_record
process
get_value
get_enum_str
get_enum_strs
put_enum_str
8. - Record Processing
9. - Device Support
9.1. - Fields Of Interest To Device Support
9.2. - Device Support routines
report
init
init_record
get_ioint_info
read_bi
9.3. - Device Support for Soft Records
Soft Channel
Raw Soft Channel
Chapter 8: - bo--Binary Output
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Convert and Write Parameters
4.1. - Conversion Parameters
4.2. - Output Specification
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-Time and Simulation Mode Parameters
8. - Record Support Routines
init_record
process
get_value
get_enum_str
get_enum_strs
put_enum_str
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support routines
report
init
init_record
get_ioint_info
write_bo
10.3. - Device Support For Soft Records
Soft Channel
Raw Soft Channel
Chapter 9: - Calc - Calculation
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Expression
4.1. - Operands
4.2. - Algebraic Operators
4.3. - Trigonometric Operators
4.4. - Relational Operators
4.5. - Logical Operators
4.6. - Bitwise Operators
4.7. - Parentheses and Comma
4.8. - Conditional Expression
4.9. - Examples
Algebraic
Relational
Question Mark
Logical
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Monitor Parameters
8. - Run-time Parameters
9. - Record Support Routines
init_record
process
special
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
10. - Record Processing
Chapter 10: - Calcout - Calculation Output Record
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Expression
4.1. - Operands
4.2. - Algebraic Operators
4.3. - Trigonometric Operators
4.4. - Relational Operators
4.5. - Logical Operators
4.6. - Bitwise Operators
4.7. - Parentheses and Comma
4.8. - Conditional Expression
4.9. - Examples
Algebraic
Relational
Question Mark
Logical
5. - Output Parameters
6. - Operator Display Parameters
7. - Alarm Parameters
8. - Monitor Parameters
9. - Run-time Parameters
10. - Record Support Routines
init_record
process
special
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
11. - Record Processing
11.1. - process()
11.2. - execOutput()
Chapter 11: - compress - Compression
1. - Introduction
2. - Scanning Parameters
3. - Read Parameters and Algorithm Parameters
3.1. - Input Specification
3.2. - Algorithms and Related Fields
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time Parameters.
7. - Record Support Routines
init_record
process
special
get_value
cvt_dbaddr
get_array_info
put_array_info
get_units
get_precision
get_graphic_double
get_control_double
8. - Record Processing
Chapter 12: - CPID Control
1. - Introduction
2. - Scan Parameters
3. - Controlled Variable and Setpoint Parameters
4. - Expression Parameters
5. - Output, Readback, and Mode Parameters
6. - Operator Display Parameters
7. - Alarm Parameters
8. - Monitor Parameters
9. - Run-time Parameters
10. - Record Support Routines
init_record
process
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
11. - Record Processing
12. - Device Support
Chapter 13: - dfanout
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Write Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Monitor Parameters
8. - Run-Time Parameters and Simulation Mode Parameters
9. - Record Support Routines
init_record()
process()
get_value()
get_units()
get_graphic_double()
get_control_double()
get_alarm_double()
10. - Record Processing
Chapter 14: - Event
1. - Introduction
2. - Scan Parameters
3. - Input Specification
4. - Event Number Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Simulation Mode Parameters
8. - Record Support Routines
init_record
process
get_value
9. - Record Processing
10. - Device Support
10.1. - Fields of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
read_event
10.3. - Device Support For Soft Records
Chapter 15: - Fanout
1. - Introduction
2. - Scan Parameters
3. - Operator Display Parameters
4. - Alarm Parameters
5. - Run-time Parameters
6. - Record Support Routines
init_record
process
7. - Record Processing
Chapter 16: - Histogram
1. - Introduction
2. - Scanning Parameters
3. - Read Parameters
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Monitor Parameters
7. - Run-time and Simulation Mode Parameters
8. - Record Support Routines
init_record
process
special
get_value
cvt_dbaddr
get_array_info
put_array_info
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
init_record
read_histogram
10.3. - Device Support For Soft Records
Soft Channel
Chapter 17: - longin--Long Input
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Monitor Parameters
7. - Run-time and Simulation Mode Parameters
8. - Record Support Routines
init_record
process
get_value
get_units
get_graphic_double
get_control_double
get_alarm_double
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support routines
report
init
init_record
get_ioint_info
read_longin
10.3. - Device Support For Soft Records
Chapter 18: - longout - Long Output
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Write Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Monitor Parameters
8. - Run-time and Simulation Mode Parameters
9. - Record Support Routines
init_record
process
get_value
get_units
get_graphic_double
get_control_double
get_alarm_double
10. - Record Processing
11. - Device Support
11.1. - Fields Of Interest To Device Support
11.2. - Device Support Routines
init
init_record
get_ioint_info
write_longout
11.3. - Device Support For Soft Records
Chapter 19: - mbbi -- Multi-Bit Binary Input
1. - Introduction
2. - Scan parameters
3. - Read and Convert Parameters
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time and Simulation Mode Parameters
7. - Record Support Routines
init_record
process
special
get_value
get_enum_str
get_enum_strs
put_enum_str
8. - Record Processing
9. - Device Support
9.1. - Fields Of Interest To Device Support
9.2. - Device Support Routines
report
init
init_record
get_ioint_info
read_mbbi
9.3. - Device Support For Soft Records
Soft Channel
Raw Soft Channel
Chapter 20: - mbbiDirect - Multi-Bit Binary Input Direct
1. - Introduction
2. - Scan fields
3. - Read and Convert fields
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time and Simulation Mode Fields
7. - Record Support Routines
init_record
process
get_value
8. - Record Processing
9. - Device Support
9.1. - Fields Of Interest To Device Support
9.2. - Device Support Routines
report
init
init_record
get_ioint_info
read_mbbiDirect
9.3. - Device Support For Soft Records
Soft Channel
Raw Soft Channel
Chapter 21: - mbbo -- Multi-Bit Binary Output
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Convert and Write Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-Time and Simulation Mode Parameters
8. - Record Support Routines
init_record
process
special
get_value
get_enum_str
get_enum_strs
put_enum_str
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
write_mbbo
10.3. - Device Support For Soft Records
Soft Channel
Raw Soft Channel
Chapter 22: - mbboDirect - Multi-Bit Binary Output Direct
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Convert and Write Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-time and Simulation Mode Parameters
8. - Record Support Routines
init_record
Process
get_value
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
write_mbboDirect
10.3. - Device Support For Soft Records
Chapter 23: - Permissive
1. - Introduction
2. - Scan Parameters
3. - Client-server Parameters
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time Parameters
7. - Record Support Routines
process
get_value
Chapter 24: - PID Control
1. - Introduction
2. - Scan Parameters
3. - Controlled Variable Parameters
4. - Setpoint Parameters
5. - Expression Parameters
6. - Operator Display Parameters
7. - Alarm Parameters
8. - Monitor Parameters
9. - Run-time Parameters
10. - Record Support Routines
init_record
process
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
11. - Record Processing
Chapter 25: - pulseCounter
1. - Introduction
2. - Scan Parameters
3. - Setup Parameters
4. - Write Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-time parameters
8. - Record Support Routines
init_record
process
get_value
get_graphic_double
get_control_double
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
cmd_pc
Chapter 26: - pulseDelay
1. - Introduction
2. - Scan Parameters
3. - Trigger Parameters
4. - Pulse Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-time Parameters
8. - Record Support Routines
init_record
process
special
get_value
get_precision
get_graphic_double
get_control_double
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
write_pd
Chapter 27: - pulseTrain
1. - Introduction
2. - Scan Parameters
3. - Trigger Parameters
4. - Pulse Parameters
5. - Output Parameters
6. - Operator Display Parameters
7. - Alarm Parameters
8. - Run-time Parameters
9. - Record Support Routines
init_record
process
get_value
get_precision
get_graphic_double
get_control_double
10. - Record Processing
11. - Device Support
11.1. - Fields Of Interest To Device Support
11.2. - Device Support Routines
report
init
init_record
get_ioint_info
write_pt
11.3. - Soft Device Support
Chapter 28: - scan
1. - Introduction
1.1. - A Simple Single Dimensional Scan
1.2. - Two Dimensional Scanning
2. - Scan Parameters
2.1. - Positioner Parameters
2.2. - Linear Mode
Lookup Mode Parameters
2.3. - Position Verification, Readback Process Variable, and Delta Parameters
2.4. - Detector Trigger Process Variables and Desired Command
3. - Data Acquisition Parameters
4. - Operator Display Parameters
5. - Run-time Parameters
Chapter 29: - sel - Select
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Select Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Monitor Parameters
8. - Run-time Parameters
9. - Record Support Routines
init_record
process
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
10. - Record Processing
Chapter 30: - seq - Sequence
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Output Parameters
5. - Selection Algorithm Parameters
6. - Delay Parameters
7. - Operator Display Parameters
8. - Alarm Parameters
9. - Record Support Routines
Chapter 31: - State
1. - Introduction
2. - Scan Parameters
3. - Operator Display Parameters
4. - Alarm Parameters
5. - Run-time Parameters
6. - Record Support Routines
process
get_value
Chapter 32: - Stepper Motor
1. - Introduction
2. - Scan Parameters
3. - Setup Parameters
4. - Desired Output Parameters
5. - Output and Readback Parameters
6. - Operator Display Parameters
7. - Alarm Parameters
8. - Monitor Parameters
9. - Run-time Parameters
10. - Record Support Routines
init_record
init_sm
process
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
11. - Record Processing
12. - Device Support
Chapter 33: - stringin - String Input
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time and Simulation Mode Parameters
7. - Record Support Routines
init_record
process
get_value
8. - Record Processing
9. - Device Support
9.1. - Fields Of Interest To Device Support
9.2. - Device Support Routines
report
init
init_record
get_ioint_info
read_stringin
9.3. - Device Support For Soft Records
Chapter 34: - stringout -- String Output
1. - Introduction
2. - Scan Parameters
3. - Desired Output Parameters
4. - Write Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-time and Simulation Mode Parameters
8. - Record Support Routines
init_record
process
get_value
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
get_ioint_info
write_stringout
10.3. - Device Support for Soft Records
Chapter 35: - subArray
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Array Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Run-time Parameters
8. - Record Support Routines
init_record
process
get_value
cvt_dbaddr
get_array_info
put_array_info
get_graphic_double
get_control_double
get_units
get_prec
9. - Record Processing
10. - Device Support
10.1. - Fields Of Interest To Device Support
10.2. - Device Support Routines
report
init
init_record
read_sa
10.3. - Device Support For Soft Records
Soft Channel
Chapter 36: - sub - Subroutine
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Subroutine Connection
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Monitor Parameters
8. - Run-time Parameters
9. - Record Support Routines
init_record
process
get_value
get_units
get_precision
get_graphic_double
get_control_double
get_alarm_double
10. - Record Processing
11. - Example Synchronous Subroutine
12. - Example Asynchronous Subroutine
Chapter 37: - Timer
1. - Introduction
2. - Scan Parameters
3. - Setup Parameters
4. - Write and Convert Parameters
5. - Operator Display Parameters
6. - Alarm Parameters
7. - Event Generation Parameters
8. - Run-time Parameters
Chapter 38: - Wait
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Expression-related Parameters
4.1. - Operands
4.2. - Algebraic Operators
4.3. - Trigonometric Operators
4.4. - Relational Operators
4.5. - Logical Operators
4.6. - Bitwise Operators
4.7. - parentheses and Comma
4.8. - Conditional Expression
4.9. - Examples
Algebraic
Relational
Question Mark
Logical
5. - Desired Output Parameters
6. - Write Parameters
7. - Operator Display Parameters
8. - Alarm Parameters
9. - Monitor Parameters
10. - Run-time Parameters
Chapter 39: - Waveform
1. - Introduction
2. - Scan Parameters
3. - Read Parameters
4. - Operator Display Parameters
5. - Alarm Parameters
6. - Run-time Parameters
7. - Record Support Routines
init_record
process
get_value
cvt_dbaddr
get_array_info
put_array_info
get_units
get_prec
get_graphic_double
get_control_double
get_graphic_double
get_control_double
8. - Record Processing
9. - Device Support
9.1. - Fields Of Interest To Device Support
9.2. - Device Support Routines
report
init
init_record
get_ioint_info
read_wf
9.3. - Device Support For Soft Records
Appendix A: Menu Choices
1. - GBLCHOICE and RECCHOICE Fields
1.1. - Determining the Choices of a GBLCHOICE or RECCHOICE Field
Using dbst
Peeking at the Database Definition Files
2. - Standard Menu Definitions
seqSELM
selSELM
menuYesNo
menuScan
menuPriority
menuOmsl
menuLinr
menuIvoa
menuFtype
menuConvert
menuCompress
menuArrType
menuAlarmStat
menuAlarmSevr
fanoutSELM
compressALG
aoOIF

EPICS Record Reference Manual - 19 MAY 1998
[Next] [Previous] [Top] [Index]

Generated with Harlequin WebMaker