Initial attempt to merge the many versions of sumIO

This commit is contained in:
2025-04-07 15:31:58 +02:00
parent fc0d5254d6
commit dd3bcd5213
7 changed files with 633 additions and 83 deletions

13
Makefile Normal file
View File

@ -0,0 +1,13 @@
# This build the sinq extensions for the PSI EPICS setup
include /ioc/tools/driver.makefile
MODULE=sinqProtonCurrent
BUILDCLASSES=Linux
EPICS_VERSIONS=7.0.7
ARCH_FILTER=RHEL%
# additional module dependencies
REQUIRED+=calc
# General DB files to include in the release
TEMPLATES += db/sumIO.db

View File

@ -1,93 +1,22 @@
# SinqProtonCurrent
Estimates Proton Current via Calc Records.
This replaces the `sumIO.db` and `sumIO.cmd` that are/were in many Sinq IOCs.
## Getting started
## How to
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
```bash
require sinqProtonCurrent
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://git.psi.ch/sinq-epics-modules/sinqprotoncurrent.git
git branch -M main
git push -uf origin main
dbLoadRecords("$(sinqprotoncurrent_DIR)protoncurrent.db" "P=SQ:<INSTR>:sumi:, AI=MHC6:IST:2")
```
## Integrate with your tools
Or with camini
- [ ] [Set up project integrations](https://git.psi.ch/sinq-epics-modules/sinqprotoncurrent/-/settings/integrations)
```bash
require sinqProtonCurrent
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
dbLoadRecords("$(sinqprotoncurrent_DIR)camini.db","P=SQ:<INSTR>:CAMINI:")
dbLoadRecords("$(sinqprotoncurrent_DIR)protoncurrent.db" "P=SQ:<INSTR>:sumi:, AI=MHC6:IST:2, GATE=SQ:<INSTR>:CAMINI:SHUTTER")
```

90
db/old/sumIO.db.amor Normal file
View File

@ -0,0 +1,90 @@
# This code integrates the beam intensity signal during the
# time where the integration is activated (SWITCH = 1).
# It also counts the time during which the integration occured.
# this is a switch which can be set to activate/deactivate the counting
record(bi, "$(P)SWITCH")
{
field(DTYP,"Soft Channel")
field(ZNAM,"Low")
field(ONAM,"High")
}
## This is an accumulator for the beam intensity integral
record(ai, "$(P)ACCINT")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# field for a beam copy
record(ai, "$(P)BEAMCPY")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
field(INP, "$(AI) CP")
field(SCAN, "Passive")
}
# This is for holding a preset
record(ai, "$(P)PRESET")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
#
#
#
## This is an accumulator for the exposure time
record(ai, "$(P)ACCTIME")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
#
## This record computes the integral of the beam intensity
## (gated by the SWITCH signal)
record(calcout, "$(P)BEAMINT")
{
field(SCAN,"Passive")
field(INPA,"$(AI) CP")
field(INPB,"$(P)SWITCH")
field(INPD,"$(P)ACCINT")
field(CALC,"(B >= 1) ? D + A : D")
field(OUT,"$(P)ACCINT PP")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
field(FLNK, "$(P)COUNTER")
}
# This record stops counting when the preset has been reached
record(calcout, "$(P)COUNTER")
{
field(SCAN,"Passive")
field(INPA,"$(P)BEAMINT")
field(INPB,"$(P)SWITCH")
field(INPD,"$(P)PRESET")
field(CALC,"(B >= 1 && A >= D) ? 0 : 1")
field(OUT,"$(P)SWITCH PP")
field(OOPT,"When Zero")
field(DOPT,"Use CALC")
}
#
#
#
## This record computes the total exposure time
## (gated by the SWITCH signal)
record(calcout, "$(P)COUNTTIME")
{
field(SCAN,".1 second")
field(INPA,"$(AI)")
field(INPB,"$(P)SWITCH")
field(INPD,"$(P)ACCTIME")
field(CALC,"(B >= 1) ? D + 0.1 : D")
field(OUT,"$(P)ACCTIME PP")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}

191
db/old/sumIO.db.boa Normal file
View File

@ -0,0 +1,191 @@
# This code integrates the beam intensity signal during the
# time where the integration is activated (SWITCH = 1)
# and the camera is acquiring (SHUTTER = 0). It also counts
# the time during which the integration occured to compute
# the average intensity. This average intensity is compared
# to a threshold to indicate the camera whether the exposure
# is sufficient.
# this is a switch which can be set to activate/deactivate the counting
record(bi, "$(P)SWITCH")
{
field(DTYP,"Soft Channel")
field(ZNAM,"Low")
field(ONAM,"High")
}
# This is an accumulator for the beam intensity integral
record(ai, "$(P)ACCINT")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This is an accumulator for the exposure time
record(ai, "$(P)ACCTIME")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This is the threshold for acceptable intensity
record(ai, "$(P)THRES")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This record keeps the last average value
record(ai, "$(P)LASTAVG")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This is a record to hold a copy of the HIPA proton beam intensity
record(ai, "$(P)BEAM")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This is a calculation record to copy the HIPA proton beam intensity,
# visible from NICOS
record(calcout, "$(P)BEAMCOPY")
{
field(SCAN, "1 second")
field(INPA, "$(AI)")
field(CALC, "A")
field(OUT, "$(P)BEAM")
field(OOPT, "Every Time")
field(DOPT, "Use CALC")
}
# This record computes the integral of the beam intensity
# (gated by the SWITCH and SHUTTER signals)
record(calcout, "$(P)BEAMINT")
{
field(SCAN,".1 second")
field(INPA,"$(AI)")
field(INPB,"$(P)SWITCH")
field(INPC,"$(CAM)SHUTTER")
field(INPD,"$(P)ACCINT")
field(CALC,"(B >= 1) AND (C = 0)? D + 0.1*A : D")
field(OUT,"$(P)ACCINT")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}
# This record computes the total exposure time
# (gated by the SWITCH and SHUTTER signals)
record(calcout, "$(P)EXPTIME")
{
field(SCAN,".1 second")
field(INPA,"$(AI)")
field(INPB,"$(P)SWITCH")
field(INPC,"$(CAM)SHUTTER")
field(INPD,"$(P)ACCTIME")
field(CALC,"(B >= 1) AND (C = 0)? D + 0.1 : D")
field(OUT,"$(P)ACCTIME")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}
# This record computes the average beam intensity
record(calcout, "$(P)BEAMAVG")
{
field(SCAN,".1 second")
field(INPA,"$(P)EXPTIME")
field(INPB,"$(P)BEAMINT")
field(INPC,"$(P)LASTAVG")
field(CALC,"A > 0 ? B/A : C")
field(OUT,"$(P)LASTAVG")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}
# This record compares the average intensity to the threshold
record(calcout, "$(CAM)AUX")
{
field(SCAN,".1 second")
field(INPA,"$(P)BEAMAVG")
field(INPB,"$(P)THRES")
field(CALC,"A >= B ? 1 : 0")
field(OUT,"$(CAM)AUX")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}

41
db/old/sumIO.db.dmc Normal file
View File

@ -0,0 +1,41 @@
# This code integrates the beam intensity signal during the
# time where the integration is activated (SWITCH = 1).
# It also counts the time during which the integration occured.
# this is a switch which can be set to activate/deactivate the counting
record(bi, "$(P)SWITCH")
{
field(DTYP,"Soft Channel")
field(ZNAM,"Low")
field(ONAM,"High")
}
# This is an accumulator for the beam intensity integral
record(ai, "$(P)ACCINT")
{
field(SCAN,"1 second")
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
record(longin, "$(P)PRESET")
{
field(DTYP,"Soft Channel")
}
# This record computes the integral of the beam intensity
# (gated by the SWITCH signal)
record(calcout, "$(P)BEAMINT")
{
field(SCAN,".1 second")
field(INPA,"$(AI)")
field(INPB,"$(P)SWITCH")
field(INPC,"$(P)PRESET")
field(INPD,"$(P)ACCINT")
field(CALC,"((B >= 1) && (C > D)) ? D + A * .1 : D")
field(OUT,"$(P)ACCINT")
field(OOPT,"Every Time")
field(DOPT,"Use CALC")
}

180
db/old/sumIO.db.neutra Normal file
View File

@ -0,0 +1,180 @@
# This code integrates the beam intensity signal during the
# time where the integration is activated (SWITCH = 1)
# and the camera is acquiring (SHUTTER = 0). It also counts
# the time during which the integration occured to compute
# the average intensity. This average intensity is compared
# to a threshold to indicate the camera whether the exposure
# is sufficient.
# field for a beam copy
record(ai, "$(P)BEAMCPY")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
field(INP, "$(AI) CP")
field(SCAN, "Passive")
}
# this is a switch which can be set to activate/deactivate the counting
record(bi, "$(P)SWITCH")
{
field(DTYP,"Soft Channel")
field(ZNAM,"Low")
field(ONAM,"High")
}
# this is a dummy switch which simulates the shutter
record(bi, "$(P)DummyShutter")
{
field(DTYP,"Soft Channel")
field(ZNAM,"Closed")
field(ONAM,"Open")
}
# This is an accumulator for the beam intensity integral
record(ai, "$(P)ACCINT")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This is an accumulator for the exposure time
record(ai, "$(P)ACCTIME")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This is the threshold for acceptable intensity
record(ai, "$(P)THRES")
{
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
# This record computes the integral of the beam intensity
# (gated by the SWITCH and SHUTTER signals)
record(calcout, "$(P)BEAMINT")
{
field(SCAN,".1 second")
field(INPA,"$(AI)")
field(INPB,"$(P)SWITCH")
field(INPC,"$(CAM)SHUTTER")
field(INPD,"$(P)ACCINT")
field(CALC,"(B >= 1) AND (C = 0)? D + 0.1*A : D")
field(OUT,"$(P)ACCINT")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}
# This record computes the total exposure time
# (gated by the SWITCH and SHUTTER signals)
record(calcout, "$(P)EXPTIME")
{
field(SCAN,".1 second")
field(INPA,"$(AI)")
field(INPB,"$(P)SWITCH")
field(INPC,"$(CAM)SHUTTER")
field(INPD,"$(P)ACCTIME")
field(CALC,"(B >= 1) AND (C = 0)? D + 0.1 : D")
field(OUT,"$(P)ACCTIME")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}
# This record computes the average beam intensity
record(calcout, "$(P)BEAMAVG")
{
field(SCAN,".1 second")
field(INPA,"$(P)EXPTIME")
field(INPB,"$(P)BEAMINT")
field(CALC,"A > 0 ? B/A : 0")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}
# This record compares the average intensity to the threshold
record(calcout, "$(P)EXPOK")
{
field(SCAN,".1 second")
field(INPA,"$(P)BEAMAVG")
field(INPB,"$(P)THRES")
field(CALC,"A >= B ? 1 : 0")
field(OUT,"$(CAM)AUX")
field(OOPT,"On Change")
field(DOPT,"Use CALC")
}

106
db/protoncurrent.db Normal file
View File

@ -0,0 +1,106 @@
# Macros
# P - Prefix
# AI - HIPA Beam Current PV
# GATE - (optional) second gating PV
record(bi, "$(P)SWITCH")
{
field(DESC, "Gates signal intensity measurement")
field(DTYP, "Soft Channel")
field(ZNAM, "Low")
field(ONAM, "High")
}
record(bi, "$(P)SHUTTER")
{
field(DESC, "Optional extra gate for e.g. Camera")
field(DTYP, "Soft Channel")
field(ZNAM, "High")
field(ONAM, "Low")
field(INP, "$(GATE=0) CP")
field(SCAN, "Passive")
}
record(ai, "$(P)BEAMCPY")
{
field(DESC, "Copy of $(AI)")
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
field(INP, "$(AI) CP")
field(SCAN, "Passive")
}
record(ai, "$(P)ACCTIME")
{
field(DESC, "Beam time accumulator")
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
record(calcout, "$(P)COUNTTIME")
{
field(DESC, "Computes Exposure Time")
field(SCAN, ".1 second")
field(INPA, "$(AI)")
field(INPB, "$(P)SWITCH")
field(INPC, "$(P)SHUTTER")
field(INPD, "$(P)ACCTIME")
field(CALC, "(B >= 1 && C == 0) ? D + 0.1 : D")
field(OUT, "$(P)ACCTIME PP")
field(OOPT, "On Change")
field(DOPT, "Use CALC")
}
record(ai, "$(P)ACCINT")
{
field(DESC, "Beam intensity accumulator")
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
}
record(calcout, "$(P)BEAMINT")
{
field(DESC, "Computes Beam Intensity")
field(SCAN, "Passive")
field(INPA, "$(AI) CP")
field(INPB, "$(P)SWITCH")
field(INPC, "$(P)SHUTTER")
field(INPD, "$(P)ACCINT")
field(CALC, "(B >= 1 && C = 0) ? D + A : D")
field(OUT, "$(P)ACCINT PP")
field(OOPT, "On Change")
field(DOPT, "Use CALC")
field(FLNK, "$(P)PRESET-COUNTER")
}
record(ai, "$(P)PRESET")
{
field(DESC, "max intensity count preset")
field(DTYP, "Soft Channel")
field(LINR, "LINEAR")
field(VAL, 0)
}
record(calcout, "$(P)PRESET-COUNTER")
{
field(DESC, "auto stops measurement at preset")
field(SCAN, "Passive")
field(INPA, "$(P)BEAMINT")
field(INPB, "$(P)SWITCH")
field(INPC, "$(P)SHUTTER")
field(INPD, "$(P)PRESET")
field(CALC, "(B >= 1 && D > 0 && A >= D && C == 0) ? 0 : 1")
field(OUT, "$(P)SWITCH PP")
field(OOPT, "When Zero")
field(DOPT, "Use CALC")
}
record(calcout, "$(P)BEAMAVG")
{
field(SCAN, ".1 second")
field(INPA, "$(P)ACCTIME")
field(INPB, "$(P)ACCINT")
field(CALC, "A > 0 ? B/A : 0")
field(OOPT, "On Change")
field(DOPT, "Use CALC")
}