EPICS Record Reference Manual Philip Stanley Janet Anderson Marty Kraimer EPICS Release 3.13 EPICS Release: R3.13 EPICS 1 Copyright Experimental Physics and Industrial Control System (EPICS) Copyright, 1995, The University of California, The University of Chicago Portions of this material resulted from work developed under a U.S. Government contract and are subject to the following license: For a period of five years from March 30, 1993, the Government is granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable worldwide license in this computer software to reproduce, prepare derivative works, and perform publicly and display publicly. Upon request of Licensee, and with DOE and Licensors approval, this period may be renewed for two additional five year periods. Following the expiration of this period or periods, the Government is granted for itself and others acting on its behalf, a paid-up, nonexclusive, irrevocable worldwide license in this computer software to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. NEITHER THE UNITED STATES NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY INFORMATION, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS. Initial development by: The Controls and Automation Group (AOT-8), Ground Test Accelerator, Accelerator Technology Division, Los Alamos National Laboratory. Co-developed with: The Controls and Computing Group, Accelerator Systems Division, Advanced Photon Source, Argonne National Laboratory. EPICS Release: R3.13 Document Revision: Draft Contents Preface. 1 Organization......................................................................................................1 Conventions ......................................................................................................1 Record Tables ...................................................................................................2 Inaccuracies.......................................................................................................2 Chapter 1: Database Concepts . 3 1. Scanning Specification...................................................................................3 Periodic Scanning . 4 Event Scanning . 5 Passive Scanning. 5 Phase . 10 Forward Process Links . 11 2. Address Specification ..................................................................................12 Hardware Addresses . 12 Database Addresses . 14 Constants. 15 3. Conversion Specification.............................................................................16 Discrete Conversions . 16 Analog Conversions . 17 4. Alarm Specification ....................................................................................22 5. Monitor Specification ..................................................................................25 Notification . 25 List Maintenance. 25 6. Control Specification ...................................................................................26 Closing an Analog Control Loop . 26 Chapter 2: Fields Common to All Record Types. 28 Introduction .....................................................................................................28 2. Scan Fields...................................................................................................28 Field Summary . 28 Field Description. 29 3. Alarm Fields.................................................................................................30 Field Summary . 30 Field Description. 31 4. Device Fields ...............................................................................................31 Field Summary . 31 Field Description. 32 5. Debugging Fields.........................................................................................32 Field Summary . 32 Field Description. 32 6. Miscellaneous Fields....................................................................................33 Field Description. 33 Field Description. 33 Chapter 3: Fields Common to Many Record Types . 35 EPICS Release: R3.13 iv Introduction .....................................................................................................35 2. Input Records...............................................................................................35 Common Fields . 35 Device Input. 36 Soft Input . 36 Simulation Mode . 37 3. Output Records ............................................................................................38 Common Fields . 38 Soft Output. 39 Output Mode Select . 39 Simulation Mode . 40 Invalid Alarm Output Action . 40 Chapter 4: ai—Analog Input . 41 Introduction .....................................................................................................41 2. Scanning Parameters....................................................................................41 3. Read and Convert Parameters......................................................................42 Input Specification . 42 Conversion Related Fields . 43 4. Operator Display Parameters .......................................................................44 5. Alarm Parameters.........................................................................................44 6. Monitor Parameters......................................................................................45 7. Run-Time Parameters and Simulation Mode Parameters............................45 8. Record Support Routines .............................................................................46 9. Record Processing.......................................................................................47 10. Device Support..........................................................................................48 Fields Of Interest To Device Support . 48 Device Support Routines . 48 Device Support For Soft Records . 49 Chapter 5: ao - Analog Output . 51 Introduction .....................................................................................................51 2. Scan Parameters...........................................................................................51 3. Desired Output Parameters ..........................................................................51 4. Convert and Write Parameters.....................................................................53 Conversion Related Fields and the Conversion Process . 53 Output Specification . 54 5. Operator Display Parameters .......................................................................54 6. Alarm Parameters.........................................................................................55 7. Monitor Parameters......................................................................................56 8. Run-Time Parameters and Simulation Mode Parameters............................56 9. Record Support Routines .............................................................................57 10. Record Processing......................................................................................58 11. Device Support...........................................................................................59 Fields Of Interest To Device Support . 59 Device Support routines. 60 Device Support For Soft Records . 61 Chapter 6: The Archive Record . 62 v Document Revision: 1 Introduction .....................................................................................................62 2. Scan Parameters...........................................................................................63 3. Read Parameters...........................................................................................63 4. Archive and Monitor Parameters.................................................................63 5. Operator Display Parameters .......................................................................65 6. Run-time Parameters....................................................................................65 Chapter 7: bi - Binary Input . 67 Introduction .....................................................................................................67 2. Scan Parameters...........................................................................................67 3. Read and Convert Parameters......................................................................67 Conversion Fields . 68 4. Operator Display Parameters .......................................................................68 5. Alarm Parameters.........................................................................................69 6. Run-time Parameters and Simulation Mode Parameters .............................69 7. Record Support Routines .............................................................................70 8. Record Processing........................................................................................71 9. Device Support.............................................................................................72 Fields Of Interest To Device Support . 72 Device Support routines . 72 Device Support for Soft Records . 73 Chapter 8: bo—Binary Output . 74 Introduction .....................................................................................................74 2. Scan Parameters...........................................................................................74