Versions Compared

Old Version 1

changes.mady.by.user Matt Boyes

Saved on

compared with

New Version 2

changes.mady.by.user Matt Boyes

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This page describes the EPICS database record naming convention for all LCLS records.

Contents: {maketoc} * [LCLS Collaboration - EPICS Record Naming Convention, Apr 5, 2005|http://www.slac.stanford.edu/grp/lcls/controls/global/standards/software/CollTalkNaming.ppt]
Panel

Contents:

Table of Contents
Wiki Markup

Description

In order to limit the number of alias names required, naming is used that allows LCLS PVs to be used by SLC control system CA clients and also provides for simple translation from SLC control system names to PV names by the SLC-aware IOC. These names may also fit in more nicely with existing SLAC documentation tools.

Wiki Markup
The \[ LCLS Linac Current Beamline Design Optics Files\|http://www-ssrl.slac.stanford.edu/lcls/linac/optics\] is a good reference when creating device names.  The current primary, location, units for optics elements in the injector and sector 21 is [here|http://www.slac.stanford.edu/grp/lcls/controls/global/standards/software/opticsElementsIN20toLI21.xls].  The \[ "How to Add an EPICS Process Variable"\|http://www.slac.stanford.edu/grp/cd/soft/share/slaconly/how-to/add_pv.html\] for ESD IOC applications is a good reference.  A similar page for LCLS IOC applications needs to be written.

The SLC-aware IOC naming conventions are VERY strict, stricter than those for the SLC CA clients, and so drive the requirements:

...

  1. All record names consist of exactly 4 parts separated by colons.
  2. All upper-case.
  3. First part (PRIM) indicates device type and is 1 to 4 characters. For records on SLC-aware IOCs that are used by the SLC control system, PRIM must be one of the SLC control system primaries.
  4. Second part (LOCA) is location and must be 4 characters, no more, no less. The first two characters must be non-numeric and the last two characters must be numeric.
  5. Third part (UNIT) is the device "unit" integer number between 1 and 9999 (with no leading zeros) and is unique for the specified PRIM and LOCA. It's like a simple serial number. For "one-of" items, use 1. When 2 values are needed for a unit number (ie, device 3 on girder 2), use a zero to separate (ie, 203). For devices on girders, the first part of the unit number is the girder number for the sector and the second part is the count of that device on the girder. The preference is for unit numbers no greater than 3 characters.
  6. Fourth part (ATTRIBUTE) is the device attribute and is 1 to 12 characters. In the SLC control system, attributes are known as secondaries.

IOC Micro Name List

Wiki Markup
Micro names for the existing SLC control system are listed in [microname.dat|http://www-mcc.slac.stanford.edu/ref_dbsfile/microname.dat] file. All SLC-aware IOCs must be assigned a unique micro name which is then added to this file using the ESD \[ "Adding a Micro to the SLC Control System"\|http://mccdev.slac.stanford.edu/doc$database/how_to_add_micro.mem\] procedure.  A micro name is used as the location (LOCA) name in a record if the record is IOC-specific.  Micro names for IOCs are listed in the [LCLS production IOCs|http://www.slac.stanford.edu/grp/lcls/controls/global/network_devices/slaconly/ioc/production.html] and [LCLS development IOCs|http://www.slac.stanford.edu/grp/lcls/controls/global/network_devices/slaconly/ioc/development.html].

Record Name Examples

  • XCOR:LI21:302:BACT

...

  • add more examples here....

Primary (PRIM) List

Wiki Markup
{{Some of the following list of primaries are extracted from the SLC control system \[ primary.dbs\|http://www-mcc.slac.stanford.edu/ref_dbsfile/primary.dbs\] file for devices that are SLC-Aware.}}

  1. Controlled Devices (SLC-Aware):
    • BEND - BEND (LARGE DIPOLE) MAGNET
    • BTRM - BEND MAGNET TRIM WINDINGS
    • SOLN - SOLENOID MAGNET
    • QTRM - QUAD MAGNET TRIM WINDINGS
    • QUAD - QUADRUPOLE MAGNET
    • XCOR - HORIZONTAL STEERING CORRECTOR MAGNET
    • YCOR - VERTICAL STEERING CORRECTOR MAGNET
    • KICK - KICKER MAGNET
    • LGPS - LARGE POWER SUPPLY
    • SMPS - SMALL POWER SUPPLY
  2. Controlled Devices (non-SLC-Aware):
    • WIRE - MOVING WIRE SCANNER
    • CAMR - Camera
    • COLL - COLLIMATOR
    • KICK - KICKER MAGNET
    • MIRR - Alignment Mirror
  3. Gated ADC Devices (SLC-Aware):
    • BPMS - BEAM POSITION MONITOR (Attributes are X,Y,TMIT)
    • TORO - TOROID (Attribute is TMIT)
    • BLEN - Bunch Length Monitor (Attribute is WIDTH?)
  4. Gated ADC Devices (non-SLC-Aware):
    • PMTS - Photo Multiplier Tube Beam Loss Monitor Signal
    • PICS - Protection Ion Chamber Signal
    • YAGS - YAG screen
    • OTRS - OTR screen
    • PHOS - Phosphor screen
    • PROF - YAGS, OTRS, PHOS monitor (SLC dummy devices only)
  5. Vacuum Gauges:
    • VGKL = Vacuum Gauge associated with a Klystron
    • VGPR = Vacuum Pirani Gauge
    • VGCC = Vacuum Cold Cathode Gauge
    • VGTC = Vacuum ThermoCouple Gauge
    • VGCP = Vacuum Convection-enhanced Pirani Gauge
    • VGHF = Vacuum Hot Filament Gauge
  6. Vacuum Valves:
    • VVKL = Vacuum Valve associated with a Klystron
    • VVPG = Vacuum Pneumatic Gate Valve
    • VVMG = Vacuum Manual Gate Valve
    • VVPR = Vacuum Pneumatic Roughing Valve
    • VVMR = Vacuum Manual Roughing Valve
    • VVPF = Vacuum Pneumatic Fore Valve
    • VVMF = Vacuum Manual Fore Valve
    • VVPV = Vacuum Pneumatic Vent Valve
    • VVMV = Vacuum Manual Vent Valve
    • VVFS = Vacuum Fast Valve
  7. Vacuum Pumps:
    • VPKL = Vacuum Pump associated with a Klystron
    • VPCR = CRyo Pump
    • VPIO = IOn Pump
    • VPTM = TurboMolecular Pump
    • VPTS = Ti Sublimation Pump
    • VPFO = Fore Pump
    • VPRO = Roughing Pump
  8. Other Devices:
    • PLIC - Panofsky Long Ion Chamber (Attribute is LOSS)
    • FAN - Fan (Attribute is SPEED)
    • DT - Diagnostic tank
    • GASA - Gas Attenuator
    • KLYS - Klystron
    • SBST - Sub-Booster
    • FARC - Faraday Cup
    • DOOR - PPS Door
    • STPR - Beam Stopper
    • SBD - Single Beam Dump
    • LENS - LENS MAGNET
    • SEPT - SEPTUM MAGNET
    • CATH - Cathode
    • DUMP - Beam Dump
    • Add others here...
  9. Subsystems and Groups/Collections:
    • LLRF - Low Level RF
    • LCW - Low Conductivity Water
    • AIR - Air
    • PPS - PPS (Personel Protection System)
    • MPS - MPS (Machine Protection System)
    • BCS - Beam Containment System
    • HVAC - Heating, Ventilation, and AC System
    • SLC - SLC-Aware IOC Diagnostics
    • MDEF - Measurement Definition
    • ARRY - Group of Channels on a Gated ADC for SLC-Aware only
    • Add others here...
  10. Controls Hardware:
    • IOC - Input/Output Controller
    • PLC - Programmable Logic Controller
    • CRAT - VME Crate
    • BPMP - BEAM POSITION MODULE
    • GADC - Gated ADC Module (not BPMP)
    • EVG - Event Generator
    • EVR - Event Receiver
    • MPG - MASTER PATTERN GENERATOR
    • PNET - PNET Module
    • DTIZ - DIGITIZER
    • ADC - ADC MODULE
    • VSAM - VME Smart Analog Module
    • DAC - DAC MODULE
    • TDC - TIME-TO-DIGITAL CONVERTER
    • DOM - DIGITAL OUTPUT MODULE
    • DIM - DIGITAL INPUT MODULE
    • SCLR - SCALER MODULE
    • LVDT - Linear Variable Differential Transformer
    • Add others here...

...

    • NAME - name
    • USERNAME - user ID
    • FAN or FANOUT - fanout
    • TOD - timestamp (date/time)

Wiki Markup
::\[ SLC-Aware IOC Home Page\|http://www.slac.stanford.edu/grp/lcls/controls/global/sw/slc_ioc/\] \|


\[ LCLS Controls\|http://www.slac.stanford.edu/grp/lcls/controls/\] \|


[SLAC Computing
|
SLAC Home::
Contact: Stephanie Allison
Last Modified: Feb 3, 2006
|http://www2.slac.stanford.edu/computing] \|
[SLAC Home|http://www.slac.stanford.edu/detailed.html]::
_Contact:_ _[Stephanie Allison|http://www.slac.stanford.edu/grp/lcls/controls/global/standards/software//owner/saa]_
_Last Modified: Feb 3, 2006_