# Presentation: 360554

## EPICS Database II

- Ned D. Arnold
- APS

## The Record Reference Manual

- Database Concepts (good review)
- Fields common to all records (covered earlier)
- Fields common to many records (covered earlier)
- Record Types – provides a description of the record processing routines for each record type.

## Input Records

- Analog in
- Read analog value, convert to engineering units, four alarm levels, simulation mode
- Binary in
- Single bit, two states, assign strings to each state, alarm on either state or change of state, simulation mode
- Multi-bit binary in
- Multiple bit, sixteen states, assign input value for each state, assign strings to each state, assign alarm level to each state, simulation mode
- Multi-bit binary in Direct
- Read an unsigned short and map each bit to a field (16 BI records in one)
- String in
- 40 character (max) ascii string,  simulation mode

## Input Records (cont..)

- Long in
- Long integer, four alarm levels, simulation mode
- Pulse counter
- Written to support a Mizar 8310 timing module
- Waveform
- Configurable data type and array length (16,000 bytes max for CA)

## Algorithms/Control Records

- Calc
- 12 input links, user specified “calc expression” (algebraic, trig, relational, Boolean, Logical, “?”), four alarm levels
- Examples:
* **(A-B)*C*
*((A<<2)&B)|C*
*(A+B)<(C+D)?E:F+L+10*
- Calcout
- Same as CALC with a *conditional* output link, separate output CALC expression, output delay, and output event
- Options : "Every Time”, "On Change", "When Zero", "When Non-zero", "Transition To Zero", "Transition To Non-zero"
- PID
- Proportional/Integral/Derivative Control

## Algorithms/Control Records (cont..)

- Select
- 12 input links, four select options (specified, highest, lowest, median), four alarm levels
- Compress
- Input link can be scalar or array
- Algorithms include N to 1 compression (highest, lowest, or average), circular buffer of scalar input
- Subroutine
- 12 input links, user provided subroutine, four alarm levels
- Fanout
- Forward links to six other records
- Dfanout
- Writes a single source of data to eight output links

## Algorithms/Control Records (cont..)

- Sequence
- Ten “Input link to Output link” pairs with a specified delay between link execution. Subsets of the ten pairs can be executed by specifying a mask or a specific link pair (Select options include ALL, SPECIFIED, MASK).
- Event
- Posts a “soft” event which may trigger other records to process, simulation mode
- Scan
- Four “positioners”, fifteen “detectors”. A scan steps through values of the positioners and records the detector values at each point. All arrays are accumulated within the record and posted when the scan is complete
- SubArray
- Extracts a sub-array from a waveform

## Output Records

- Analog out
- Write analog value, convert from engineering units, four alarm levels, closed_loop mode, drive limits, output rate-of-change limit, INVALID alarm action, simulation mode
- Binary out
- Single bit, two states, assign strings to each state, alarm on either state or change of state, closed_loop mode, momentary ‘HIGH’, INVALID alarm action, simulation mode
- Multi-bit binary out
- Multiple bit, sixteen states, assign output value for each state, assign strings to each state, assign alarm level to each state, closed_loop mode, INVALID alarm action simulation mode
- Multi-bit binary out direct
- 16 settable bit fields that get written as a short integer to the hardware, closed_loop mode, INVALID alarm action simulation mode

## Output Records (cont..)

- Stepper motor
- Position control, retry, speed, ramps, etc
- Pulse delay
- Written to support a Mizar 8310 timing module
- Pulse Train
- Written to support a Mizar 8310 timing module
- Long out
- Write long integer value, four alarm levels, closed_loop mode, INVALID alarm action, simulation mode
- String out
- Write a character string (40 max), closed_loop mode, INVALID alarm action, simulation mode

## Examples of Custom Records

- RF Amplitude Measurements
- Sample time, measurement in watts and db, waveform acquired through sweeping sample time
- Beam Position Monitor record
- Four voltage inputs, numerous calibration constants, X-Y-I outputs, waveforms for each input
- Multi-Channel Analyzer record
- Controls and acquires data from a multichannel analyzer (MCA). Currently, there are 3 supported multichannel analyzers.
- Many others that are site-specific

## Which record is right for ...

-  “operator entered” soft parameters
- AO has DRVH, DRVL, OROC, closed loop
- MBBO provides enumerated options which can be converted to constants (DTYP = Raw Soft Channel)
- Multiple output actions
- Sequence record can have a different data source for each output link vs. the dfanout record which fanouts a single source to multiple links
- Different output actions based on an operator selection
- CALCOUT records that conditionally process sequence records
- MBBO (Soft Raw Channel) forward linked to a single sequence record in “masked” mode. Mask is provided in MBBO for each state.

## Defining the Database

- How does an IOC know what record types and device support options are available ?
- Record types, device support options, enumerated menus, and other configuration options are defined in “database definition files” (.dbd)
- During the IOC booting process, one or more .dbd files are loaded
- .dbd files are created on the workstation to include the desired information for that IOC.
- How does an IOC know about record instances (the user’s database) ?
- Record instances are describe in “database files” (.db)
- During the IOC booting process, one or more .db files are loaded
- .db files are created on the workstation to include the desired information for that IOC.

## Database File Formats

- A typical database definition file (.dbd)

- menu(menuPriority) {
- 	choice(menuPriorityLOW,"LOW")
- 	choice(menuPriorityMEDIUM,"MEDIUM")
- 	choice(menuPriorityHIGH,"HIGH")
- }
- menu(menuScan) {
- 	choice(menuScanPassive,"Passive")
- 	choice(menuScanEvent,"Event")
- 	choice(menuScanI_O_Intr,"I/O Intr")
- 	choice(menuScan10_second,"10 second")
- 	choice(menuScan5_second,"5 second")
- 	choice(menuScan2_second,"2 second")
- 	choice(menuScan1_second,"1 second")
- 	choice(menuScan_5_second,".5 second")
- 	choice(menuScan_2_second,".2 second")
- 	choice(menuScan_1_second,".1 second")
- }
- device(ai,CONSTANT,devAiSoftRaw,
-             "Raw Soft Channel")
- device(ai,BITBUS_IO,devAiIObug,
-             "Bitbus Device")
- device(ao,CONSTANT,devAoSoftRaw,
-             "Raw Soft Channel")
- device(ao,VME_IO,devAoAt5Vxi,
-             "VXI-AT5-AO")
- device(bi,VME_IO,devBiAvme9440,
-             "AVME9440 I")
- device(bi,AB_IO,devBiAb,
-             "AB-Binary Input")
- driver(drvVxi)
- driver(drvMxi)
- driver(drvGpib)
- driver(drvBitBus)

- recordtype(ai) {
-         field(NAME,DBF_STRING) {
-                 prompt("Record Name")
-                 special(SPC_NOMOD)
-                 size(29)
-         }
-         field(DESC,DBF_STRING) {
-                 prompt("Descriptor")
-                 promptgroup(GUI_COMMON)
-                 size(29)
-         }
-         field(ASG,DBF_STRING) {
-                 prompt("Access Security Group")
-                 promptgroup(GUI_COMMON)
-                 special(SPC_AS)
-                 size(29)
-         }
-         field(SCAN,DBF_MENU) {
-                 prompt("Scan Mechanism")
-                 promptgroup(GUI_SCAN)
-                 special(SPC_SCAN)
-                 menu(menuScan)
-                 interest(1)
-         }
- ...
- recordtype(ao) {  ...
- recordtype(bi) { ...
- recordtype(bo) { ...
- recordtype(calc) { ...

## Database File Formats

- A typical database file (.db)

- record(bo,"$(user):gunOnC") {
-     field(DESC,"Controls e-gun")
- record(bo,"$(user):gunOnC") {
-     field(DESC,"Controls e-gun")
-     field(DTYP,"Soft Channel")
-     field(ZNAM,"Beam Off")
-     field(ONAM,"Beam On")
- }
- record(ao,"$(user):cathodeCurrentC") {
-     field(DESC,"set cathode current")
-     field(DTYP,"Raw Soft Channel")
-     field(SCAN,"1 second")
-     field(OROC,".5")
-     field(PREC,"2")
-     field(EGU,"Amps")
-     field(DRVH,"20")
-     field(DRVL,"0")
-     field(HOPR,"20")
-     field(LOPR,"0")
- }

- record(calc,"$(user):rampM") {
-     field(CALC,"A>6.27?0:A+.1")
-     field(SCAN,"1 second")
-     field(INPA,"$(user):rampM.VAL NPP NMS")
- }
- record(calc,"$(user):cathodeTempM") {
-     field(DESC,"Measured Temp")
-     field(SCAN,"1 second")
-     field(CALC,"C+(A*7)+(SIN(B)*3.5)")
-     field(INPA,"$(user):cathodeCurrentC.OVAL NPP NMS")
-     field(INPB,"$(user):rampM.VAL NPP NMS")
-     field(INPC,"70")
-     field(EGU,"degF")
-     field(PREC,"1")
-     field(HOPR,"200")
-     field(LOPR,"")
-     field(HIHI,"180")
-     field(LOLO,"130")
-     field(HIGH,"160")
-     field(LOW,"140")
-     field(HHSV,"MAJOR")
-     field(HSV,"MINOR")
-     field(LLSV,"MAJOR")
-     field(LSV,"MINOR")
- }

## Loading Database Files into the IOC

- Part of a typical startup script (st.cmd)

- dbLoadDatabase("../../dbd/linacApp.dbd")
- dbLoadRecords("../../db/xxLinacSim.db","user=studnt1")
- iocInit          /* starts ioc software */

- One or more database definition files (.dbd) must be loaded first.
- Any record type specified in the database files must have been defined in the definition file
- Macros (variables) within the database files (e.g. $(user) ) can be specified at boot time. This allows the same database to be loaded with different names or channel assignments.

## Creating Database Files

- Since the database file is a simple ascii file, it can be generated by numerous applications ... as long as the syntax is correct.
- Text editor
- Script
- Relational Database Tool
- EPICS-aware Database Configuration Tools
- CAPFAST (a schematic entry application)
- GDCT
- JDCT
- An EPICS-aware tool will read the .dbd file (library provided) and provide menu selections of enumerated fields. It may also detect database errors prior to the boot process
- A graphical tool is helpful to document and support complex databases

## Steps to Creating and Loading a New Database File

- Create the database file in an appropriate Db directory
- Edit the Makefile.Host so this .db file is managed properly
- gnumake
- Edit the IOC’s startup script (st.cmd) to load the new database
- dbLoadRecords(______)
- Reboot the IOC

## JDCT

- Start *jdct* (usually in a Db directory)
- Open one or more .dbd files (usually in the directory ‘../../dbd’) to define available record types, menus, available device options, etc)
- Create, copy, edit record instances
- Save the .db file
- ‘gnumake’ to install the .db into another directory
- You must modify the Makefile.Host each time you add a new database file

## Database Examples

- Calculating “Rate-of-Change” of an Input

- .INPA

- .INPB

- .VAL

- .NPP

- CALC Record

- .INP

- .VAL

- AI Record

- .PP

- .SCAN = Passive

- .SCAN = 1 second

- .CALC = A-B

- A/D Card

- Ion Gauge

- INPA fetches data that is 1 second old because it does not request processing of the AI record. INPB fetches current data because it requests the AI record to process. The subtraction of these two values reflects the ‘rate of change’ (difference/sec) of the pressure reading.

- * The direction of the arrows indicates where a link points to, not necessarily the direction of the data flow.

## Database Examples

- Slow Periodic Scan with Fast Change Response

- FANOUT Record

- AI Record

- .SCAN = Passive

- A/D D/A Card

- Programmable Power Supply

- AI records get processed every 5 seconds AND when the associated AO record is changed. This provides immediate response to a change even though the desired scan rate is very slow. Changes to the power supply settings are inhibited by the BI record, which could represent a Local/Remote switch.

- Programmable Power Supply

- BI Record

- .VAL

- AO Record

- .SCAN = Passive

- .SDIS

- .FLNK

- .OUT

- .SCAN = 5 second

- .LNK1

- .LNK2

- AI Record

- .SCAN = Passive

- AO Record

- .SCAN = Passive

- .SDIS

- .FLNK

- .OUT

- .INP

- .INP

- .DISV = 1

- .DISV = 1

- .ZNAM = Normal

- .ONAM = Inhibit

## Database Examples

- Simulation Mode

- AI Record

- A/D D/A Card

- Programmable Power Supply

- When in simulation mode, the AO record does not call device support and the AI record fetches its input from the AO record.

- (Simulation Mode Switch)

- .VAL

- AO Record

- .SIML

- .OUT

- .INP

- .SIML

- .VAL

- .SIML

## Database Examples

- Maximize Severity

- BI Record

- Input Card

- If chassis is powered off, Temp Trip and Flow Trip indicate Normal. Force these PVs into an alarm state by specifying .SDIS with .MS (maximize severity) to the Chassis On record. Set .DISV (disable value) to 2 so processing will never be disabled.

- .VAL

- .INP

- Interlock Chassis

- Chassis On = 1

- Temp Trip = 1

- Flow Trip = 1

- BI Record

- .SDIS

- BI Record

- .INP

- .INP

- .SDIS

- .MS

- .MS

- .DISV = 2

- .DISV = 2

- .ZSV = MAJOR

- .OSV = NO_ALRM

- .ZSV = NO_ALARM

- .OSV = MAJOR

- .ZSV = NO_ALARM

- .OSV = MAJOR

## Database Examples

- Different Actions Based on Operator Selection

- Different links in the sequence record are executed for each selection of the mbbo. This allows much functionality to be specified in only two records.

- record(mbbo,"$(user):PS:Control") {
-         field(DTYP,"Raw Soft Channel")
-         field(FLNK,"$(user):PS:ControlSQ.VAL PP NMS")
-         field(ZRVL,”0x3")
-         field(ONVL,”0x5")
-         field(TWVL,"0xc")
-         field(ZRST,"Off")
-         field(ONST,"On)")
-         field(TWST,"Set @ Default")
- }
- record(seq,"$(user):PS:ControlSQ") {
-         field(SELM,"Mask")
-         field(SELL,"$(user):PS:Control.RVAL NPP NMS")
-         field(DLY1,"0")
-         field(DOL1,"0")
-         field(LNK1,"$(user):PS:setCurrent.VAL PP NMS")
-         field(DLY2,"2")
-         field(DOL2,"0")
-         field(LNK2,"$(user):PS:pwrControl.VAL PP NMS")
-         field(DLY3,"0")
-         field(DOL3,"1")
-         field(LNK3,"$(user):PS:pwrControl.VAL PP NMS")
-         field(DLY4,"1")
-         field(DOL4,"3.75")
-         field(LNK4,"$(user):PS:setCurrent.VAL PP NMS)
- }

## Database Examples

- Automatic Shutdown on Logout

- BI Record

- If no monitor exists on the BI record (i.e. the operator has logged out), .MLIS will be NULL. The subroutine record .VAL field will become 0, which will cause the sequence record to process.

- .MLIS

- SUB Record*

- .INPA

- Invisible widget on medm display that monitors BI record

- .VAL

- SEQ Record

- .SDIS

- .DISV = 1

- .LNK1

- .LNK2

- .LNK3

- .LNK4

- if (inpa.mlis == NULL)
-    sub.val = 0;
- else
-     sub.val = 1;

- * A subroutine record is required because the .MLIS field is defined as a NO_ACCESS field (for links).

## Database Examples

- Quick Prototyping with Standard Records

- AI Record

- .VAL

- .INP

- AI Record

- .VAL

- .INP

- AI Record

- .VAL

- .INP

- AI Record

- .VAL

- .INP

- .INPA

- .INPB

- Custom Record Definition

- BPM Record

- .INPA

- .INPB

- CALC Record

- .INPA

- .INPB

- .INPC

- .INPD

- CALC Record

- X position

- Intensity

- Y position

- Left BPM Button

- Right BPM Button

- Top BPM Button

- Bottom BPM Button

- Left BPM Button

- Right BPM Button

- Top BPM Button

- Bottom BPM Button

- .INPL

- .INPR

- .INPT

- .INPB

- .XPOS

- .YPOS

- .INT

- .VAL

- - Average inputs
- - Input history
- - Standard deviation
- ...