Beam Line Controls - User contributions [en]

APSU PVs

2026-04-20T22:12:18Z

Jkirchman: /* PSS PVs */ Use png for PSS list since pdf is not supported by wiki-ext

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2025-01-31).

'''Important things to note:'''
* There are 44 PV gateways at APS and you will get write access to certain PVs through only 1
* LOM office and perhaps lab networks are usually not the same as the beamline network
* LOM offices and perhaps labs will have read only access (if not part of the beamline network)
* PV write access is granted ONLY from the beamline network PV gateway

===LOM Access to PVs===
To get '''read only access''' to accelerator PVs you can run the command /APSshare/adlsys/xfd-display which uses a round robin technique to select 1 of 3 PV gateways; as such you don't know which one you are using, nor should you care. Also using this script you do not need to set any EPICS environment variables unless you need to see PVs from an IOC on your local network. If this is the case then use the environment variable EPICS_CA_AUTO_ADDR_LIST as shown below. This will tell your EPICS Channel Access (CA) client to also do PV searches on all network interfaces that the host machine has. There is no need to set the EPICS_CA_ADDR_LIST environment variable for this case.
setenv EPICS_CA_AUTO_ADDR_LIST YES (for cshell)
export EPICS_CA_AUTO_ADDR_LIST=YES (for bash)

In order to get write access to accelerator PVs you need to be running your CA client on a beamline host. Then you will be able to access both the beamline hosted PVs as well as the accelerator PVs of interest. Setting the environment variable EPICS_CA_ADDR_LIST is not enough because the other end of the connection does not necessarily know how to send the information back to your CA client. To clarify this statement if you were to set the EPICS_CA_ADDR_LIST environment variable to include the beamline network then the CA search request might get through to the beamline network. However, the CA server (i.e. EPICS IOC) may not know how to get the response back across to the LOM network. Doubtful that this would work without more effort.

===Beamline Access to PVs===
There is a PV gateway that is located in the APS computer room that has a connection to the beamline network; most often this gateway has a name that looks like sxxpvgate where xx is the beamline sector number and in some instances will also include the beamline (id or bm). All computer hosts on this network have at a minimum '''read access''' to all accelerator PVs. Write access may be allowed to some PVs such as insertion device controls and beamline shutters. If not, then this is simply an email request to [mailto:mls@anl.gov Marty Smith].

===PV Gateway Access Security for Beamlines===
Often times a new beamline computer is added to the beamline network and this does not mean you get the same write permission to PVs that you had on another computer. There are many ways to set up the access security in the PV gateway and currently this decision is left up to the resident beamline personnel. However, in order to make an informed decision about this you will need to know your options; this can be as secure as you would like.
Here are the options you have to select from:
1. You must be logged in as a certain user name and logged into a certain computer (This is the most secure method)
You might have multiple computer names and user names. This would mean that you '''MUST''' be in the user list AND logged into one of the hosts in the
computer list.
2. You must be logged into a certain computer but any user logged in has access (This is a list of computer host names)
3. You must be a certain user logged in
This means that as long as you are a user in the user name list you can get control from any computer with in the same subnet as the
beamline PV gateway.

''It's advisable to verify with [mailto:mls@anl.gov Marty Smith] that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not there before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

It has been suggested that each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue "PSS" button, then selecting "Main" from the menu and then finding the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

The SI group has assured us that '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For the second run in 2024, the Gen4 systems are at 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID and 31ID, 33ID and 34ID.

[[:Media:PSS Version List.png|Latest beamline PSS version list (PNG)]]

This list was last updated in March 2026 and details the PSS Gen version at each beamline.

See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

File:PSS Version List.png

2026-04-20T22:11:06Z

Jkirchman: Jkirchman uploaded a new version of File:PSS Version List.png

== Summary ==
List of the PSS systems at each beamline with the generation of the PLC controller. Most beamlines are Gen1, Gen3, or Gen4.

APSU PVs

2026-04-20T21:56:03Z

Jkirchman: Sync with the latest changes to the internal wiki

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2025-01-31).

'''Important things to note:'''
* There are 44 PV gateways at APS and you will get write access to certain PVs through only 1
* LOM office and perhaps lab networks are usually not the same as the beamline network
* LOM offices and perhaps labs will have read only access (if not part of the beamline network)
* PV write access is granted ONLY from the beamline network PV gateway

===LOM Access to PVs===
To get '''read only access''' to accelerator PVs you can run the command /APSshare/adlsys/xfd-display which uses a round robin technique to select 1 of 3 PV gateways; as such you don't know which one you are using, nor should you care. Also using this script you do not need to set any EPICS environment variables unless you need to see PVs from an IOC on your local network. If this is the case then use the environment variable EPICS_CA_AUTO_ADDR_LIST as shown below. This will tell your EPICS Channel Access (CA) client to also do PV searches on all network interfaces that the host machine has. There is no need to set the EPICS_CA_ADDR_LIST environment variable for this case.
setenv EPICS_CA_AUTO_ADDR_LIST YES (for cshell)
export EPICS_CA_AUTO_ADDR_LIST=YES (for bash)

In order to get write access to accelerator PVs you need to be running your CA client on a beamline host. Then you will be able to access both the beamline hosted PVs as well as the accelerator PVs of interest. Setting the environment variable EPICS_CA_ADDR_LIST is not enough because the other end of the connection does not necessarily know how to send the information back to your CA client. To clarify this statement if you were to set the EPICS_CA_ADDR_LIST environment variable to include the beamline network then the CA search request might get through to the beamline network. However, the CA server (i.e. EPICS IOC) may not know how to get the response back across to the LOM network. Doubtful that this would work without more effort.

===Beamline Access to PVs===
There is a PV gateway that is located in the APS computer room that has a connection to the beamline network; most often this gateway has a name that looks like sxxpvgate where xx is the beamline sector number and in some instances will also include the beamline (id or bm). All computer hosts on this network have at a minimum '''read access''' to all accelerator PVs. Write access may be allowed to some PVs such as insertion device controls and beamline shutters. If not, then this is simply an email request to [mailto:mls@anl.gov Marty Smith].

===PV Gateway Access Security for Beamlines===
Often times a new beamline computer is added to the beamline network and this does not mean you get the same write permission to PVs that you had on another computer. There are many ways to set up the access security in the PV gateway and currently this decision is left up to the resident beamline personnel. However, in order to make an informed decision about this you will need to know your options; this can be as secure as you would like.
Here are the options you have to select from:
1. You must be logged in as a certain user name and logged into a certain computer (This is the most secure method)
You might have multiple computer names and user names. This would mean that you '''MUST''' be in the user list AND logged into one of the hosts in the
computer list.
2. You must be logged into a certain computer but any user logged in has access (This is a list of computer host names)
3. You must be a certain user logged in
This means that as long as you are a user in the user name list you can get control from any computer with in the same subnet as the
beamline PV gateway.

''It's advisable to verify with [mailto:mls@anl.gov Marty Smith] that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not there before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

It has been suggested that each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue "PSS" button, then selecting "Main" from the menu and then finding the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

The SI group has assured us that '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For the second run in 2024, the Gen4 systems are at 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID and 31ID, 33ID and 34ID.

[[:Media:PSS Version List.pdf|Latest beamline PSS version list (PDF)]]

This list was last updated in March 2026 and details the PSS Gen version at each beamline.

See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2025-01-31T16:12:50Z

Jkirchman: Update date for the PV gateway list

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2025-01-31).

'''Important things to note:'''
* There are 44 PV gateways at APS and you will get write access to certain PVs through only 1
* LOM office and perhaps lab networks are usually not the same as the beamline network
* LOM offices and perhaps labs will have read only access (if not part of the beamline network)
* PV write access is granted ONLY from the beamline network PV gateway

===LOM Access to PVs===
To get '''read only access''' to accelerator PVs you can run the command /APSshare/adlsys/xfd-display which uses a round robin technique to select 1 of 3 PV gateways; as such you don't know which one you are using, nor should you care. Also using this script you do not need to set any EPICS environment variables unless you need to see PVs from an IOC on your local network. If this is the case then use the environment variable EPICS_CA_AUTO_ADDR_LIST as shown below. This will tell your EPICS Channel Access (CA) client to also do PV searches on all network interfaces that the host machine has. There is no need to set the EPICS_CA_ADDR_LIST environment variable for this case.
setenv EPICS_CA_AUTO_ADDR_LIST YES (for cshell)
export EPICS_CA_AUTO_ADDR_LIST=YES (for bash)

In order to get write access to accelerator PVs you need to be running your CA client on a beamline host. Then you will be able to access both the beamline hosted PVs as well as the accelerator PVs of interest. Setting the environment variable EPICS_CA_ADDR_LIST is not enough because the other end of the connection does not necessarily know how to send the information back to your CA client. To clarify this statement if you were to set the EPICS_CA_ADDR_LIST environment variable to include the beamline network then the CA search request might get through to the beamline network. However, the CA server (i.e. EPICS IOC) may not know how to get the response back across to the LOM network. Doubtful that this would work without more effort.

===Beamline Access to PVs===
There is a PV gateway that is located in the APS computer room that has a connection to the beamline network; most often this gateway has a name that looks like sxxpvgate where xx is the beamline sector number and in some instances will also include the beamline (id or bm). All computer hosts on this network have at a minimum '''read access''' to all accelerator PVs. Write access may be allowed to some PVs such as insertion device controls and beamline shutters. If not, then this is simply an email request to [mailto:mls@anl.gov Marty Smith].

===PV Gateway Access Security for Beamlines===
Often times a new beamline computer is added to the beamline network and this does not mean you get the same write permission to PVs that you had on another computer. There are many ways to set up the access security in the PV gateway and currently this decision is left up to the resident beamline personnel. However, in order to make an informed decision about this you will need to know your options; this can be as secure as you would like.
Here are the options you have to select from:
1. You must be logged in as a certain user name and logged into a certain computer (This is the most secure method)
You might have multiple computer names and user names. This would mean that you '''MUST''' be in the user list AND logged into one of the hosts in the
computer list.
2. You must be logged into a certain computer but any user logged in has access (This is a list of computer host names)
3. You must be a certain user logged in
This means that as long as you are a user in the user name list you can get control from any computer with in the same subnet as the
beamline PV gateway.

''It's advisable to verify with [mailto:mls@anl.gov Marty Smith] that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue "PSS" button, then selecting "Main" from the menu and then find the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

File:Pvgateway list.png

2025-01-31T16:10:49Z

Jkirchman: Jkirchman uploaded a new version of File:Pvgateway list.png

File:Pvgateway list-20250131.png

2025-01-31T16:09:02Z

Jkirchman: List of PV gateways at APS beamlines taken on 2025-Jan-31

== Summary ==
List of PV gateways at APS beamlines taken on 2025-Jan-31

APSU PVs

2025-01-31T15:46:39Z

Jkirchman: Modifications made by Marty Smith: Updated page so that beamlines will know not to specifically set EPICS_CA_ADDR_LIST but are supplied with an alternative

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

'''Important things to note:'''
* There are 44 PV gateways at APS and you will get write access to certain PVs through only 1
* LOM office and perhaps lab networks are usually not the same as the beamline network
* LOM offices and perhaps labs will have read only access (if not part of the beamline network)
* PV write access is granted ONLY from the beamline network PV gateway

===LOM Access to PVs===
To get '''read only access''' to accelerator PVs you can run the command /APSshare/adlsys/xfd-display which uses a round robin technique to select 1 of 3 PV gateways; as such you don't know which one you are using, nor should you care. Also using this script you do not need to set any EPICS environment variables unless you need to see PVs from an IOC on your local network. If this is the case then use the environment variable EPICS_CA_AUTO_ADDR_LIST as shown below. This will tell your EPICS Channel Access (CA) client to also do PV searches on all network interfaces that the host machine has. There is no need to set the EPICS_CA_ADDR_LIST environment variable for this case.
setenv EPICS_CA_AUTO_ADDR_LIST YES (for cshell)
export EPICS_CA_AUTO_ADDR_LIST=YES (for bash)

In order to get write access to accelerator PVs you need to be running your CA client on a beamline host. Then you will be able to access both the beamline hosted PVs as well as the accelerator PVs of interest. Setting the environment variable EPICS_CA_ADDR_LIST is not enough because the other end of the connection does not necessarily know how to send the information back to your CA client. To clarify this statement if you were to set the EPICS_CA_ADDR_LIST environment variable to include the beamline network then the CA search request might get through to the beamline network. However, the CA server (i.e. EPICS IOC) may not know how to get the response back across to the LOM network. Doubtful that this would work without more effort.

===Beamline Access to PVs===
There is a PV gateway that is located in the APS computer room that has a connection to the beamline network; most often this gateway has a name that looks like sxxpvgate where xx is the beamline sector number and in some instances will also include the beamline (id or bm). All computer hosts on this network have at a minimum '''read access''' to all accelerator PVs. Write access may be allowed to some PVs such as insertion device controls and beamline shutters. If not, then this is simply an email request to [mailto:mls@anl.gov Marty Smith].

===PV Gateway Access Security for Beamlines===
Often times a new beamline computer is added to the beamline network and this does not mean you get the same write permission to PVs that you had on another computer. There are many ways to set up the access security in the PV gateway and currently this decision is left up to the resident beamline personnel. However, in order to make an informed decision about this you will need to know your options; this can be as secure as you would like.
Here are the options you have to select from:
1. You must be logged in as a certain user name and logged into a certain computer (This is the most secure method)
You might have multiple computer names and user names. This would mean that you '''MUST''' be in the user list AND logged into one of the hosts in the
computer list.
2. You must be logged into a certain computer but any user logged in has access (This is a list of computer host names)
3. You must be a certain user logged in
This means that as long as you are a user in the user name list you can get control from any computer with in the same subnet as the
beamline PV gateway.

''It's advisable to verify with [mailto:mls@anl.gov Marty Smith] that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue "PSS" button, then selecting "Main" from the menu and then find the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-09-11T16:06:31Z

Jkirchman: /* Changed */ Made EPS into more like a table and easier to read

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
This list can include multiple IPs each separated by a space. It may be the case that a computer used in an LOM requires setting this list to access APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
''It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name: 0: 1: 2: 3: 4:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM Moving Closed Open Position Error
EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM Moving Closed Open Position Error
EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM Moving Closed Open Position Error
EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM Moving Closed Open Position Error
EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM Moving Closed Open Position Error
EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM Moving Closed Open Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue "PSS" button, then selecting "Main" from the menu and then find the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-09-11T15:00:38Z

Jkirchman: /* PSS PVs */

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
This list can include multiple IPs each separated by a space. It may be the case that a computer used in an LOM requires setting this list to access APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
''It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue "PSS" button, then selecting "Main" from the menu and then find the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-07-31T18:53:15Z

Jkirchman: /* Insertion Device (Undulator) PVs */ Update to some of the ID PVs.

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
This list can include multiple IPs each separated by a space. It may be the case that a computer used in an LOM requires setting this list to access APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
''It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = us or ds
$(YY) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):GapSet S$(xx)ID:$(YY)ID:GapSetC
ID$(xx)$(yy):TaperGapSet S$(xx)ID:$(YY)ID:TaperGapSetC
ID$(xx)$(yy):ScanGap S$(xx)ID:$(YY)ID:ScanGapC
ID$(xx)$(yy):ScanEnergy S$(xx)ID:$(YY)ID:ScanEnergyC
ID$(xx)$(yy):EnergySet S$(xx)ID:$(YY)ID:EnergySetC
ID$(xx)$(yy):TaperEnergySet S$(xx)ID:$(YY)ID:TaperEnergySetC
ID$(xx)$(yy):DeadbandGap S$(xx)ID:$(YY)ID:DeadbandGapC
ID$(xx)$(yy):HarmonicValue S$(xx)ID:$(YY)ID:HarmonicValueC
ID$(xx)$(yy):Start S$(xx)ID:$(YY)ID:StartC
ID$(xx)$(yy):Stop S$(xx)ID:$(YY)ID:StopC
ID$(xx)$(yy):AccessSecurity S$(xx)ID:$(YY)ID:AccessSecurityC
ID$(xx)$(yy):MotorSpeed S$(xx)ID:$(YY)ID:MotorSpeedC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx)$(yy):Gap S$(xx)ID:$(YY)ID:GapM
ID$(xx)$(yy):TaperGap S$(xx)ID:$(YY)ID:TaperGapM
ID$(xx)$(yy):Energy S$(xx)ID:$(YY)ID:EnergyM
ID$(xx)$(yy):TaperEnergy S$(xx)ID:$(YY)ID:TaperEnergyM
ID$(xx)$(yy):Busy S$(xx)ID:$(YY)ID:BusyM
ID$(xx)$(yy):Message1 S$(xx)ID:$(YY)ID:Message1M
ID$(xx)$(yy):Message2 S$(xx)ID:$(YY)ID:Message2M
ID$(xx)$(yy):Message3 S$(xx)ID:$(YY)ID:Message3M
ID$(xx)$(yy):OldGapSet S$(xx)ID:$(YY)ID:OldGapSetM
ID$(xx)$(yy):Taper S$(xx)ID:$(YY)ID:TaperM
ID$(xx)$(yy):EncoderSelect S$(xx)ID:$(YY)ID:LinearEncoderUsedM
ID$(xx)$(yy):PositionAccuracy S$(xx)ID:$(YY)ID:PositionAccuracyM
ID$(xx)$(yy):Location S$(xx)ID:$(YY)ID:LocationM
ID$(xx)$(yy):Device S$(xx)ID:$(YY)ID:DeviceM
ID$(xx)$(yy):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx)$(yy):Version S$(xx)ID:$(YY)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):TaperGapReturn S$(xx)ID:$(YY)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(YY)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(YY)ID:ExpectedPowerM
ID$(xx):DeviceLimit S$(xx)ID:$(YY)ID:DeviceLimitM
ID$(xx):Position1 S$(xx)ID:$(YY)ID:Position1M
ID$(xx):Position2 S$(xx)ID:$(YY)ID:Position2M
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-07-31T18:23:15Z

Jkirchman: /* Insertion Device PVs */

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
This list can include multiple IPs each separated by a space. It may be the case that a computer used in an LOM requires setting this list to access APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
''It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device (Undulator) PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):GapSet S$(xx)ID:$(yy)ID:GapSetC
ID$(xx):TaperGapSet S$(xx)ID:$(yy)ID:TaperGapSetC
ID$(xx):ScanGap S$(xx)ID:$(yy)ID:ScanGapC
ID$(xx):ScanEnergy S$(xx)ID:$(yy)ID:ScanEnergyC
ID$(xx):EnergySet S$(xx)ID:$(yy)ID:EnergySetC
ID$(xx):TaperEnergySet S$(xx)ID:$(yy)ID:TaperEnergySetC
ID$(xx):DeadbandGap S$(xx)ID:$(yy)ID:DeadbandGapC
ID$(xx):HarmonicValue S$(xx)ID:$(yy)ID:HarmonicValueC
ID$(xx):Start S$(xx)ID:$(yy)ID:StartC
ID$(xx):Stop S$(xx)ID:$(yy)ID:StopC
====Monitor Process Variables====
-------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):Gap S$(xx)ID:$(yy)ID:GapM
ID$(xx):TaperGap S$(xx)ID:$(yy)ID:TaperGapM
ID$(xx):Energy S$(xx)ID:$(yy)ID:EnergyM
ID$(xx):TaperEnergy S$(xx)ID:$(yy)ID:TaperEnergyM
ID$(xx):Busy S$(xx)ID:$(yy)ID:BusyM
ID$(xx):Message1 S$(xx)ID:$(yy)ID:Message1M
ID$(xx):Message2 S$(xx)ID:$(yy)ID:Message2M
ID$(xx):Message3 S$(xx)ID:$(yy)ID:Message3M
ID$(xx):OldGapSet S$(xx)ID:$(yy)ID:OldGapSetM
ID$(xx):Taper S$(xx)ID:$(yy)ID:TaperM
ID$(xx):EncoderSelect S$(xx)ID:$(yy)ID:LinearEncoderUsedM
ID$(xx):PositionAccuracy S$(xx)ID:$(yy)ID:PositionAccuracyM
ID$(xx):Location S$(xx)ID:$(yy)ID:LocationM
ID$(xx):Device S$(xx)ID:$(yy)ID:DeviceM
ID$(xx):Version S$(xx)ID:$(yy)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):ShClosedTime ID$(xx)(zz):ShClosedTime
Where zz = us or ds
ID$(xx):MotorSpeed S$(xx)ID:$(yy)ID:MotorSpeedC
ID$(xx):GapReturn S$(xx)ID:$(yy)ID:GapReturnM
ID$(xx):TaperGapReturn S$(xx)ID:$(yy)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(yy)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(yy)ID:ExpectedPowerM
ID$(xx):AccessSecurity S$(xx)ID:$(yy)ID:AccessSecurityC
ID$(xx):DeviceLimit S$(xx)ID:$(yy)ID:DeviceLimitM
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-06-27T15:03:36Z

Jkirchman: /* PV Gateways */

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
This list can include multiple IPs each separated by a space. It may be the case that a computer used in an LOM requires setting this list to access APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
''It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):GapSet S$(xx)ID:$(yy)ID:GapSetC
ID$(xx):TaperGapSet S$(xx)ID:$(yy)ID:TaperGapSetC
ID$(xx):ScanGap S$(xx)ID:$(yy)ID:ScanGapC
ID$(xx):ScanEnergy S$(xx)ID:$(yy)ID:ScanEnergyC
ID$(xx):EnergySet S$(xx)ID:$(yy)ID:EnergySetC
ID$(xx):TaperEnergySet S$(xx)ID:$(yy)ID:TaperEnergySetC
ID$(xx):DeadbandGap S$(xx)ID:$(yy)ID:DeadbandGapC
ID$(xx):HarmonicValue S$(xx)ID:$(yy)ID:HarmonicValueC
ID$(xx):Start S$(xx)ID:$(yy)ID:StartC
ID$(xx):Stop S$(xx)ID:$(yy)ID:StopC
====Monitor Process Variables====
-------------------------------------------------------------
ID$(xx):Gap S$(xx)ID:$(yy)ID:GapM
ID$(xx):TaperGap S$(xx)ID:$(yy)ID:TaperGapM
ID$(xx):Energy S$(xx)ID:$(yy)ID:EnergyM
ID$(xx):TaperEnergy S$(xx)ID:$(yy)ID:TaperEnergyM
ID$(xx):Busy S$(xx)ID:$(yy)ID:BusyM
ID$(xx):Message1 S$(xx)ID:$(yy)ID:Message1M
ID$(xx):Message2 S$(xx)ID:$(yy)ID:Message2M
ID$(xx):Message3 S$(xx)ID:$(yy)ID:Message3M
ID$(xx):OldGapSet S$(xx)ID:$(yy)ID:OldGapSetM
ID$(xx):Taper S$(xx)ID:$(yy)ID:TaperM
ID$(xx):EncoderSelect S$(xx)ID:$(yy)ID:LinearEncoderUsedM
ID$(xx):PositionAccuracy S$(xx)ID:$(yy)ID:PositionAccuracyM
ID$(xx):Location S$(xx)ID:$(yy)ID:LocationM
ID$(xx):Device S$(xx)ID:$(yy)ID:DeviceM
ID$(xx):Version S$(xx)ID:$(yy)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):ShClosedTime ID$(xx)(zz):ShClosedTime
Where zz = us or ds
ID$(xx):MotorSpeed S$(xx)ID:$(yy)ID:MotorSpeedC
ID$(xx):GapReturn S$(xx)ID:$(yy)ID:GapReturnM
ID$(xx):TaperGapReturn S$(xx)ID:$(yy)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(yy)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(yy)ID:ExpectedPowerM
ID$(xx):AccessSecurity S$(xx)ID:$(yy)ID:AccessSecurityC
ID$(xx):DeviceLimit S$(xx)ID:$(yy)ID:DeviceLimitM
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-06-27T15:01:38Z

Jkirchman: /* PV Gateways */

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
It may be the case that a computer used in an LOM requires this for APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
''It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline.'' Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):GapSet S$(xx)ID:$(yy)ID:GapSetC
ID$(xx):TaperGapSet S$(xx)ID:$(yy)ID:TaperGapSetC
ID$(xx):ScanGap S$(xx)ID:$(yy)ID:ScanGapC
ID$(xx):ScanEnergy S$(xx)ID:$(yy)ID:ScanEnergyC
ID$(xx):EnergySet S$(xx)ID:$(yy)ID:EnergySetC
ID$(xx):TaperEnergySet S$(xx)ID:$(yy)ID:TaperEnergySetC
ID$(xx):DeadbandGap S$(xx)ID:$(yy)ID:DeadbandGapC
ID$(xx):HarmonicValue S$(xx)ID:$(yy)ID:HarmonicValueC
ID$(xx):Start S$(xx)ID:$(yy)ID:StartC
ID$(xx):Stop S$(xx)ID:$(yy)ID:StopC
====Monitor Process Variables====
-------------------------------------------------------------
ID$(xx):Gap S$(xx)ID:$(yy)ID:GapM
ID$(xx):TaperGap S$(xx)ID:$(yy)ID:TaperGapM
ID$(xx):Energy S$(xx)ID:$(yy)ID:EnergyM
ID$(xx):TaperEnergy S$(xx)ID:$(yy)ID:TaperEnergyM
ID$(xx):Busy S$(xx)ID:$(yy)ID:BusyM
ID$(xx):Message1 S$(xx)ID:$(yy)ID:Message1M
ID$(xx):Message2 S$(xx)ID:$(yy)ID:Message2M
ID$(xx):Message3 S$(xx)ID:$(yy)ID:Message3M
ID$(xx):OldGapSet S$(xx)ID:$(yy)ID:OldGapSetM
ID$(xx):Taper S$(xx)ID:$(yy)ID:TaperM
ID$(xx):EncoderSelect S$(xx)ID:$(yy)ID:LinearEncoderUsedM
ID$(xx):PositionAccuracy S$(xx)ID:$(yy)ID:PositionAccuracyM
ID$(xx):Location S$(xx)ID:$(yy)ID:LocationM
ID$(xx):Device S$(xx)ID:$(yy)ID:DeviceM
ID$(xx):Version S$(xx)ID:$(yy)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):ShClosedTime ID$(xx)(zz):ShClosedTime
Where zz = us or ds
ID$(xx):MotorSpeed S$(xx)ID:$(yy)ID:MotorSpeedC
ID$(xx):GapReturn S$(xx)ID:$(yy)ID:GapReturnM
ID$(xx):TaperGapReturn S$(xx)ID:$(yy)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(yy)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(yy)ID:ExpectedPowerM
ID$(xx):AccessSecurity S$(xx)ID:$(yy)ID:AccessSecurityC
ID$(xx):DeviceLimit S$(xx)ID:$(yy)ID:DeviceLimitM
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-06-27T15:00:23Z

Jkirchman: /* PV Gateways */

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
It may be the case that a computer used in an LOM requires this for APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
It's advisable to verify with Marty Smith that the hosts in his list are still the appropriate ones for a beamline. Beamline computers are replaced often and the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):GapSet S$(xx)ID:$(yy)ID:GapSetC
ID$(xx):TaperGapSet S$(xx)ID:$(yy)ID:TaperGapSetC
ID$(xx):ScanGap S$(xx)ID:$(yy)ID:ScanGapC
ID$(xx):ScanEnergy S$(xx)ID:$(yy)ID:ScanEnergyC
ID$(xx):EnergySet S$(xx)ID:$(yy)ID:EnergySetC
ID$(xx):TaperEnergySet S$(xx)ID:$(yy)ID:TaperEnergySetC
ID$(xx):DeadbandGap S$(xx)ID:$(yy)ID:DeadbandGapC
ID$(xx):HarmonicValue S$(xx)ID:$(yy)ID:HarmonicValueC
ID$(xx):Start S$(xx)ID:$(yy)ID:StartC
ID$(xx):Stop S$(xx)ID:$(yy)ID:StopC
====Monitor Process Variables====
-------------------------------------------------------------
ID$(xx):Gap S$(xx)ID:$(yy)ID:GapM
ID$(xx):TaperGap S$(xx)ID:$(yy)ID:TaperGapM
ID$(xx):Energy S$(xx)ID:$(yy)ID:EnergyM
ID$(xx):TaperEnergy S$(xx)ID:$(yy)ID:TaperEnergyM
ID$(xx):Busy S$(xx)ID:$(yy)ID:BusyM
ID$(xx):Message1 S$(xx)ID:$(yy)ID:Message1M
ID$(xx):Message2 S$(xx)ID:$(yy)ID:Message2M
ID$(xx):Message3 S$(xx)ID:$(yy)ID:Message3M
ID$(xx):OldGapSet S$(xx)ID:$(yy)ID:OldGapSetM
ID$(xx):Taper S$(xx)ID:$(yy)ID:TaperM
ID$(xx):EncoderSelect S$(xx)ID:$(yy)ID:LinearEncoderUsedM
ID$(xx):PositionAccuracy S$(xx)ID:$(yy)ID:PositionAccuracyM
ID$(xx):Location S$(xx)ID:$(yy)ID:LocationM
ID$(xx):Device S$(xx)ID:$(yy)ID:DeviceM
ID$(xx):Version S$(xx)ID:$(yy)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):ShClosedTime ID$(xx)(zz):ShClosedTime
Where zz = us or ds
ID$(xx):MotorSpeed S$(xx)ID:$(yy)ID:MotorSpeedC
ID$(xx):GapReturn S$(xx)ID:$(yy)ID:GapReturnM
ID$(xx):TaperGapReturn S$(xx)ID:$(yy)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(yy)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(yy)ID:ExpectedPowerM
ID$(xx):AccessSecurity S$(xx)ID:$(yy)ID:AccessSecurityC
ID$(xx):DeviceLimit S$(xx)ID:$(yy)ID:DeviceLimitM
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-06-27T14:57:33Z

Jkirchman: /* PV Gateways */

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See the list of [[:File:pvgateway_list.png|PVgateways]] at the beamlines (as of 2024-06-27).

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
It may be the case that a computer used in an LOM requires this for APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
It's advisable to verify with Marty that the hosts in his list are still the appropriate ones for a beamline. Beamline computers are replaced oftenand the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):GapSet S$(xx)ID:$(yy)ID:GapSetC
ID$(xx):TaperGapSet S$(xx)ID:$(yy)ID:TaperGapSetC
ID$(xx):ScanGap S$(xx)ID:$(yy)ID:ScanGapC
ID$(xx):ScanEnergy S$(xx)ID:$(yy)ID:ScanEnergyC
ID$(xx):EnergySet S$(xx)ID:$(yy)ID:EnergySetC
ID$(xx):TaperEnergySet S$(xx)ID:$(yy)ID:TaperEnergySetC
ID$(xx):DeadbandGap S$(xx)ID:$(yy)ID:DeadbandGapC
ID$(xx):HarmonicValue S$(xx)ID:$(yy)ID:HarmonicValueC
ID$(xx):Start S$(xx)ID:$(yy)ID:StartC
ID$(xx):Stop S$(xx)ID:$(yy)ID:StopC
====Monitor Process Variables====
-------------------------------------------------------------
ID$(xx):Gap S$(xx)ID:$(yy)ID:GapM
ID$(xx):TaperGap S$(xx)ID:$(yy)ID:TaperGapM
ID$(xx):Energy S$(xx)ID:$(yy)ID:EnergyM
ID$(xx):TaperEnergy S$(xx)ID:$(yy)ID:TaperEnergyM
ID$(xx):Busy S$(xx)ID:$(yy)ID:BusyM
ID$(xx):Message1 S$(xx)ID:$(yy)ID:Message1M
ID$(xx):Message2 S$(xx)ID:$(yy)ID:Message2M
ID$(xx):Message3 S$(xx)ID:$(yy)ID:Message3M
ID$(xx):OldGapSet S$(xx)ID:$(yy)ID:OldGapSetM
ID$(xx):Taper S$(xx)ID:$(yy)ID:TaperM
ID$(xx):EncoderSelect S$(xx)ID:$(yy)ID:LinearEncoderUsedM
ID$(xx):PositionAccuracy S$(xx)ID:$(yy)ID:PositionAccuracyM
ID$(xx):Location S$(xx)ID:$(yy)ID:LocationM
ID$(xx):Device S$(xx)ID:$(yy)ID:DeviceM
ID$(xx):Version S$(xx)ID:$(yy)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):ShClosedTime ID$(xx)(zz):ShClosedTime
Where zz = us or ds
ID$(xx):MotorSpeed S$(xx)ID:$(yy)ID:MotorSpeedC
ID$(xx):GapReturn S$(xx)ID:$(yy)ID:GapReturnM
ID$(xx):TaperGapReturn S$(xx)ID:$(yy)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(yy)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(yy)ID:ExpectedPowerM
ID$(xx):AccessSecurity S$(xx)ID:$(yy)ID:AccessSecurityC
ID$(xx):DeviceLimit S$(xx)ID:$(yy)ID:DeviceLimitM
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

File:Pvgateway list.png

2024-06-27T14:55:11Z

Jkirchman:

APSU PVs

2024-06-27T14:54:22Z

Jkirchman: Add PV gateway section

The APS-U has changed many of the process variables(PVs) used for the last 25 years. This includes PVs related to EPS (or FEEPS), PSS, status, insertion devices, etc. Sometimes only the PV name has changed but in some instances the old PV does not have a direct replacement.

This wiki will help to describe what is new, what has been removed, and how to convert to using some of the new PVs available.

As mentioned elsewhere here, Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

==PV Gateways==
In order to access the APS-U PVs, each beamline host needs to know where to find these PVs. This is the function of a PV gateway which IT has configured for each beamline. The PV gateway's network interface is updated to include the new private VLAN for the IOCs which host the APS-U PVs. This PV gateway configuration maintenance is performed by Marty Smith in CTL and Brian Robinson in IT. See below for the list of PV gateways at the beamlines (as of 2024-06-27) [[:File:pvgateway_list.png|PVgateways]]

If the PV gateway has not been configured, it's still possible to direct PV queries to the appropriate host. The environment variable EPICS_HOST_ADDR_LIST can be set to point to a gateway configured for the new APSU PVs. One such gateway is c2gate1-188 (164.54.188.8).
setenv EPICS_HOST_ADDR_LIST 164.54.188.8 (for cshell)
export EPICS_HOST_ADDR_LIST=164.54.188.8 (for bash)
It may be the case that a computer used in an LOM requires this for APS-U PVs. However, be aware that if two working gateways are included with the addition of the EPICS_HOST_ADDR_LIST multiple responses to a PV access could be received. If this occurs, redefine the EPICS_HOST_ADDR_LIST to remove the unnecessary gateway.

Some PVs, e.g. undulator PVs, can only be written by select users and hosts. Marty maintains a list of those users and hosts in a permissions file. One configuration line contains the list of hosts permitted to perform writes and another line the users permitted to write. Below is the configuration for 27ID where 2 users are allowed (rixs and vw5) and several computer hosts:
HAG(sector27) {oriana,oriana.xray.aps.anl.gov,grimlok,grimlok.xray.aps.anl.gov,oswin,oswin.xray.aps.anl.gov,ioc27idmot1,ioc27idmot2,oribi,oribi.xray.aps.anl.gov}
UAG(sector27) {rixs,vw5}
It's advisable to verify with Marty that the hosts in his list are still the appropriate ones for a beamline. Beamline computers are replaced oftenand the PV gateway permissions file may have stale data.

==All APS-U PVs==
All of the PVs currently served by the APS-U are listed in the files in the directory /APSshare/C2/iocinfo/pvdata/. This is an rsync of the oxygen-based directory /net/helios/C2/iocinfo/pvdata/. The files located in this directory are named after the IOC which hosts those PVs. By grepping through the files, one can determine if a PV exists or if the name has changed.

% grep -s XFD:srCurrent /APSshare/C2/iocinfo/pvdata/*
/APSshare/C2/iocinfo/pvdata/siocblops:XFD:srCurrent

A useful tool located in /APSshare/bin called 'pvExist' will also confirm whether a PV is valid and what IOC is hosting it:

% /APSshare/bin/pvExist XFD:srCurrent
Using IOC_INFO environment variable /APSshare/C2/iocinfo
siocblops:XFD:srCurrent
% /APShare/bin/pvExist XFD:srCurrent1
Using IOC_INFO environment variable /APSshare/C2/iocinfo
XFD:srCurrent1 not found

== EPS (or FEEPS) PVs==
Here are the Equipment Protection System PVs for APS-U. Compare to the old PVs as described at https://epics.anl.gov/bcda/aps/frontendpvs.php

Note that there are not 'xx' or 'yy' display subs - only 'Z' and 'a')
In other words, display substitution is Z=Sxxyy, a=SxxyyFE
where:
xx = 2 digit sector number
yy = BM or ID

===Changed===
Old PV Name: New PV Name:
EPS:xx:yy:PS1:POSITION Sxxyy-FEEPS:PS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:PS2:POSITION Sxxyy-FEEPS:PS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS1:POSITION Sxxyy-FEEPS:SS1:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:SS2:POSITION Sxxyy-FEEPS:SS2:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:FEV:POSITION Sxxyy-FEEPS:FEV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

EPS:xx:yy:BIV:POSITION Sxxyy-FEEPS:BIV:PositionM
0 Moving
1 Closed
3 Open
4 Position Error

===New===
These PVs are new and were not present before:
Sxxyy-FEEPS:TripsExistM
0 OFF (No Trip)
1 ON (Trip(s) Exist)

Sxxyy-FEEPS:FaultsExistM
0 OFF (No Fault)
1 ON (Fault(s) Exist)

Sxxyy-FEEPS:WarningsExistM
0 OFF (No Warning)
1 ON (Warning(s) Exist)

Sxxyy-FEEPS:ShutterPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

Sxxyy-FEEPS:VacuumPermitWarnM
0 OFF (No Warning from BLEPS)
1 ON (Warning(s) Exist from BLEPS)

===Removed===
The following PVs have been removed and there is no replacement:
EPS:xx:yy:PS1:STATUS
EPS:xx:yy:PS2:STATUS
EPS:xx:yy:SS1:STATUS
EPS:xx:yy:SS2:STATUS
EPS:xx:yy:SV:STATUS
EPS:xx:yy:SV:POSITION
EPS:xx:yy:FV:STATUS
EPS:xx:yy:FV:POSITION
EPS:xx:yy:FEV:STATUS
EPS:xx:yy:BIV:STATUS
EPS:xx:yy:CC1:RDY
EPS:xx:yy:CC2:RDY
EPS:xx:yy:VAC:CC1:RDY
EPS:xx:yy:VAC:CC2:RDY
EPS:xx:yy:MM:F

== PSS PVs==
There have been a significant amount of PV changes with the PSS PVs. Unfortunately there is no easy translation tool from older PVs to the new APSU PSS PVs.

Each beamline could look at the PSS Input/Output EPICS screens to determine what their new PVs are. This can be done by starting up /APSshare/adlsys/xfd-display then selecting the light blue PSS button, then selecting the drop-down blue button for the beamline (e.g. 27-ID). From there select either "Inputs" or "Outputs". If the beamline is a Gen4 system, then select either "Systems" or "Stations". These 2 EPICS screens will display all of the PSS PVs and you can find the appropriate ones needed.

According to the SI group, '''for Gen3 PSS system the shutter control PVs did not change. Only the Gen4 systems PVs were changed.''' For this second run in 2024, the Gen4 systems will be 8ID, 9ID, 15ID, 16BM, 19ID, 20ID, 22ID, 25ID (to be completed after the Aug 2024 shutdown), 31ID, 33ID and 34ID. [[:File:PSS_Version_List.png|This list details the PSS Gen version at each beamline]]
See the following example PSS Gen4 PVs where:
xx = 2 digit sector number
yy = BM or ID
Old Gen PSS PV's New Gen4 PSS PV's
PA:xxyy:STA_A_FES_OPEN_PL Sxxyy-PSS:FES:BeamBlockingM
PA:xxyy:STA_D_SDS_OPEN_PLS Sxxyy-PSS:SDS:BeamBlockingM
PA:xxyy:STA_A_SEARCHED_PL Sxxyy-PSS:StaA:SecureM
PA:xxyy:STA_C_SEARCHED_PL Sxxyy-PSS:StaC:SecureM
PA:xxyy:STA_D_SEARCHED_PL Sxxyy-PSS:StaD:SecureM

== APS Status PVs==
The following describes the status PVs. These can be compared to the previous PVs which are explained at https://epics.anl.gov/bcda/aps/statuspvs.php

===Changed===
S:DesiredMode
0 State Unknown
1 USER OPERATIONS
2 SUPLEMENTAL TIME
3 Not Used
4 ASD Studies
5 NO BEAM
6 MAINTENANCE
S:ActualMode
0 State Unknown
1 NO BEAM
2 Injecting
3 Stored Beam
4 Delivered Beam
5 MAINTENANCE

OLD PV NEW PV
ACIS:ShutterPermit RF-ACIS:FePermit:Sect1To35IdM ''(1-35 Beamlines)''
RF-ACIS:FePermit:35Bm38AmM ''(35BM and 38AM Beamlines)''
ACIS:ShutterPermit XFD:ShutterPermit ''(alias to RF-ACIS:FePermit:Sect1To35IdM)''
S:SRcurrentAI XFD:srCurrent

===Unchanged===
S:OrbitCorrection:CC
S:OrbitControlLawXFineBO
S:OrbitControlLawYFineBO
S:FillNumber
XFD:srCurrent
S:SRtimeCP & S:SRcurrentCP
S:SRdateCP
XFD:LifeTimeHrs
XFD:message1
XFD:message2
XFD:message3
XFD:message4
XFD:message5
XFD:message6
XFD:message14
XFD:message15
XFD:message17
XFD:message18
OPS:TimeOfDaySI
Liquid Nitrogen Distribution System Information PVs

====Removed====
SRFB:GBL:LoopStatusBI
SRFB:GBL:VLoopStatusBI
SRFB:GBL:HLoopStatusBI
SRFB:dsp2:xRMSmotion30HzPkM
SRFB:dsp2:yRMSmotion30HzPkM
S:VID1:filteredXemittance
S:VID1:filteredYemittance
S:VID1:filteredCoupling
ALL TopUp related information PVs

== Insertion Device PVs ==
Here is a list of old and new PV names for insertion devices. The names have changed but there is no change to their meanings.

Note that there is no sector 4 CPU and the messages for the message PVs are still the same as well.

Compare this to the previous page at https://epics.anl.gov/bcda/aps/idpvs.php

$(xx) = 2 digit sector number
$(yy) = US or DS (Position of ID in storage ring straight)
(Note: there are not any xx or yy display subs, display substitution is P=SxxID:yyID)
===Changed===
====Control Process Variables====
--------------------------------------------------------------
Old PV Name: New PV Name:
ID$(xx):GapSet S$(xx)ID:$(yy)ID:GapSetC
ID$(xx):TaperGapSet S$(xx)ID:$(yy)ID:TaperGapSetC
ID$(xx):ScanGap S$(xx)ID:$(yy)ID:ScanGapC
ID$(xx):ScanEnergy S$(xx)ID:$(yy)ID:ScanEnergyC
ID$(xx):EnergySet S$(xx)ID:$(yy)ID:EnergySetC
ID$(xx):TaperEnergySet S$(xx)ID:$(yy)ID:TaperEnergySetC
ID$(xx):DeadbandGap S$(xx)ID:$(yy)ID:DeadbandGapC
ID$(xx):HarmonicValue S$(xx)ID:$(yy)ID:HarmonicValueC
ID$(xx):Start S$(xx)ID:$(yy)ID:StartC
ID$(xx):Stop S$(xx)ID:$(yy)ID:StopC
====Monitor Process Variables====
-------------------------------------------------------------
ID$(xx):Gap S$(xx)ID:$(yy)ID:GapM
ID$(xx):TaperGap S$(xx)ID:$(yy)ID:TaperGapM
ID$(xx):Energy S$(xx)ID:$(yy)ID:EnergyM
ID$(xx):TaperEnergy S$(xx)ID:$(yy)ID:TaperEnergyM
ID$(xx):Busy S$(xx)ID:$(yy)ID:BusyM
ID$(xx):Message1 S$(xx)ID:$(yy)ID:Message1M
ID$(xx):Message2 S$(xx)ID:$(yy)ID:Message2M
ID$(xx):Message3 S$(xx)ID:$(yy)ID:Message3M
ID$(xx):OldGapSet S$(xx)ID:$(yy)ID:OldGapSetM
ID$(xx):Taper S$(xx)ID:$(yy)ID:TaperM
ID$(xx):EncoderSelect S$(xx)ID:$(yy)ID:LinearEncoderUsedM
ID$(xx):PositionAccuracy S$(xx)ID:$(yy)ID:PositionAccuracyM
ID$(xx):Location S$(xx)ID:$(yy)ID:LocationM
ID$(xx):Device S$(xx)ID:$(yy)ID:DeviceM
ID$(xx):Version S$(xx)ID:$(yy)ID:$(dd)VersionM
Where dd = HPMU, Rev (Revolver), STI (2-Motor ID)
ID$(xx):ShClosedTime ID$(xx)(zz):ShClosedTime
Where zz = us or ds
ID$(xx):MotorSpeed S$(xx)ID:$(yy)ID:MotorSpeedC
ID$(xx):GapReturn S$(xx)ID:$(yy)ID:GapReturnM
ID$(xx):TaperGapReturn S$(xx)ID:$(yy)ID:TaperGapReturnM
ID$(xx):TotalPower S$(xx)ID:$(yy)ID:TotalPowerM
ID$(xx):ExpectedPower S$(xx)ID:$(yy)ID:ExpectedPowerM
ID$(xx):AccessSecurity S$(xx)ID:$(yy)ID:AccessSecurityC
ID$(xx):DeviceLimit S$(xx)ID:$(yy)ID:DeviceLimitM
===Removed===
The synchronous scanning PVs (those beginning with SS) have been removed. It is unlikely that any beamline was using these PVs.

APSU PVs

2024-06-24T20:55:49Z

Jkirchman: /* PSS PVs */

APSU PVs

2024-06-24T16:49:33Z

Jkirchman:

APSU PVs

2024-06-24T15:24:17Z

Jkirchman: /* PSS PVs */ Some formatting. Add link to list of PSS systems

File:PSS Version List.png

2024-06-24T15:04:42Z

Jkirchman: List of the PSS systems at each beamline with the generation of the PLC controller. Most beamlines are Gen1, Gen3, or Gen4.

== Summary ==
List of the PSS systems at each beamline with the generation of the PLC controller. Most beamlines are Gen1, Gen3, or Gen4.

APSU PVs

2024-06-24T14:31:07Z

Jkirchman: More information added about PSS PVs. Examples provided for Gen4.

APSU PVs

2024-06-21T21:00:14Z

Jkirchman: /* PSS PVs */ Add information about the Gen3 and Gen4 PSS systems.

Beamline Controls

2024-06-21T13:56:50Z

Jkirchman: Move APSU section underneath the Beamline Controls Documentation

WIKI for the APS Beamline Controls Community, maintained by the Beamline Controls Technical Working Group.<br />
This wiki exists to collect the output of the working group, including documentation on beamline controls software and hardware useful for APS beamline scientists and resident users.

----

===Getting Started===
* [[EPICS Cheat Sheet]]: Channel Access command-lines, noteworthy record fields & IOC shell commands.
* [[EPICS 101]]: definition of basic EPICS components ([[EPICS_101#What_is_an_IOC.3F|IOC]], [[EPICS 101#What_is_a_PV.3F|PV]], [[EPICS_101#What_is_a_record.3F|record]], [[EPICS 101#What_is_a_database.3F|database]]).
* [[IOC 101]]: learn how to create your own IOC.
* [[Git_101|Git 101]]: git refresher (basic workflow, commands, and more).

===Beamline Controls Documentation===

* [[EPICS networking]]: basic overview of how to control the network paths used by EPICS IOCs and clients.
* [[Controls Software Documentation]]
* [[Hardware and IT Configuration]]
* [[APSU_PVs]]: Description of what process variables(PVs) have changed for PSS, EPS, and ID control for the APSU beamlines
** Mark Rivers has documented the process he used to find the relevant medm screens and the useful PVs for his beamline:
*** https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
*** https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

===Practical Beamline Controls Training (2023)===

[[Practical_Beamline_Controls_Training#IOC_Basics|Session 1: IOC Basics]]
[[Practical_Beamline_Controls_Training#IOC_Deployment_.26_Troubleshooting|Session 2: IOC Deployment & Troubleshooting]]

===Beamline Controls Technical Working Group information===

The BC Technical Working (BCTWG) group meets monthly to review and gather feedback on possible changes in either the way BC delivers support or the technologies that BC supports. The BCTWG comprises the BC group plus interested stakeholders from XSD. In a nutshell, the main goal of the BCTWG is to improve communication between BC and its customers on topics of mutual interest.

* Box folder with slides and meeting notes (ANL only): [https://anl.box.com/s/chcn7xauil93inay8ipinbxtcckc9k9f]

* Current chairs:
** Kevin Peterson (XSD-BC)
** Tejas Guruswamy (XSD-DET)
** Andrew Chuang (XSD-MPE)

===Beamline Data Pipelines===

* https://git.aps.anl.gov/groups/bdp-public/-/wikis/home

Beamline Controls

2024-06-20T17:59:11Z

Jkirchman: Add the APSU PVs section.

WIKI for the APS Beamline Controls Community, maintained by the Beamline Controls Technical Working Group.<br />
This wiki exists to collect the output of the working group, including documentation on beamline controls software and hardware useful for APS beamline scientists and resident users.

----

===Getting Started===
* [[EPICS Cheat Sheet]]: Channel Access command-lines, noteworthy record fields & IOC shell commands.
* [[EPICS 101]]: definition of basic EPICS components ([[EPICS_101#What_is_an_IOC.3F|IOC]], [[EPICS 101#What_is_a_PV.3F|PV]], [[EPICS_101#What_is_a_record.3F|record]], [[EPICS 101#What_is_a_database.3F|database]]).
* [[IOC 101]]: learn how to create your own IOC.
* [[Git_101|Git 101]]: git refresher (basic workflow, commands, and more).

===Beamline Controls Documentation===

* [[EPICS networking]]: basic overview of how to control the network paths used by EPICS IOCs and clients.
* [[Controls Software Documentation]]
* [[Hardware and IT Configuration]]

===Practical Beamline Controls Training (2023)===

[[Practical_Beamline_Controls_Training#IOC_Basics|Session 1: IOC Basics]]
[[Practical_Beamline_Controls_Training#IOC_Deployment_.26_Troubleshooting|Session 2: IOC Deployment & Troubleshooting]]

===Beamline Controls Technical Working Group information===

The BC Technical Working (BCTWG) group meets monthly to review and gather feedback on possible changes in either the way BC delivers support or the technologies that BC supports. The BCTWG comprises the BC group plus interested stakeholders from XSD. In a nutshell, the main goal of the BCTWG is to improve communication between BC and its customers on topics of mutual interest.

* Box folder with slides and meeting notes (ANL only): [https://anl.box.com/s/chcn7xauil93inay8ipinbxtcckc9k9f]

* Current chairs:
** Kevin Peterson (XSD-BC)
** Tejas Guruswamy (XSD-DET)
** Andrew Chuang (XSD-MPE)

===Beamline Data Pipelines===

* https://git.aps.anl.gov/groups/bdp-public/-/wikis/home

===Beamline APSU PVs===

* [[APSU_PVs]]: Description of what process variables(PVs) have changed for PSS, EPS, and ID control for the APSU beamlines
* Mark Rivers has documented the process he used to find the relevant medm screens and the pertinent PVs for his beamlines:
** https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.docx
** https://github.com/CARS-UChicago/GSECARS-EPICS/blob/master/docs/EPICS_Beamline_PVs.pdf

APSU PVs

2024-06-20T17:39:02Z

Jkirchman: Ported this page from internal wiki