From c1504819682edfca0385a1d917539508ac3afe7f Mon Sep 17 00:00:00 2001 From: soederqvist_a Date: Wed, 8 Apr 2026 16:04:43 +0200 Subject: [PATCH] Improvements to shutter Based on work with NEUTRA N-Shutter or experiment shutter. --- db/readbit.db | 1 + db/shutter.db | 121 ++++++++++++++++---------------- scripts/shutter.cmd | 4 +- templates/shutter.substitutions | 33 +++++---- 4 files changed, 83 insertions(+), 76 deletions(-) diff --git a/db/readbit.db b/db/readbit.db index c69cc0b..35176bc 100644 --- a/db/readbit.db +++ b/db/readbit.db @@ -7,4 +7,5 @@ record(bi,"$(INSTR)$(SPS_REGISTER_NAME):$(BIT_NAME)") field(SCAN, "I/O Intr") field(ZNAM, "$(ZNAM=0)") field(ONAM, "$(ONAM=1)") + field(FLNK, "$(FLNK=)") } diff --git a/db/shutter.db b/db/shutter.db index 65df2bf..d0c5733 100644 --- a/db/shutter.db +++ b/db/shutter.db @@ -14,9 +14,19 @@ record(bo, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER") field(OMSL, "supervisory") field(ZNAM, "Closed") field(ONAM, "Open") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SET-BUSY PP") + field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SET-BUSY") } +record(longout, "$(INSTR)$(SPS_REGISTER_NAME):SET-BUSY") +{ + field(DESC, "Trigger Internal Busy Status") + # This determines the number of max retry ticks + field(VAL, 5) + field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):BUSY PP") + field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-CONTROL") +} + + record(seq, "$(INSTR)$(SPS_REGISTER_NAME):RESET") { field(DESC, "NICOS can't write to PROC field") @@ -30,25 +40,7 @@ record(bo, "$(INSTR)$(SPS_REGISTER_NAME):RESETTER") { field(DESC, "PV For Resetting internal state") field(DOL, 0) - field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):BUSY PP") -} - -record(bo, "$(INSTR)$(SPS_REGISTER_NAME):SET-BUSY") -{ - field(DESC, "Trigger Internal Busy Status") - field(VAL, 1) - field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):BUSY PP") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):CLEAR-CONTROL PP") -} - -record(seq, "$(INSTR)$(SPS_REGISTER_NAME):SET-READY") -{ - field(DESC, "Trigger Returned to Ready Status") - field(LNK1, "$(INSTR)$(SPS_REGISTER_NAME):BUSY PP") - field(DO1, 0) - field(SELM, "Specified") - field(SELL, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS.VAL") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):INTERNAL-STATUS PP") + field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):STATUS PP") } record(bi, "$(INSTR)$(SPS_REGISTER_NAME):BUSY") @@ -59,44 +51,49 @@ record(bi, "$(INSTR)$(SPS_REGISTER_NAME):BUSY") field(ONAM, "Busy") } -# The Exposed SPS Interface has an open register and a close register. You need -# to write 1 to the corresponding register to perform said action and make sure -# that the other bit is set back to 0. These two records, in combination with -# "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER", first clear both control bits and -# then maps the binay 0/1 to writing a 1 to the required register. -record(dfanout, "$(INSTR)$(SPS_REGISTER_NAME):CLEAR-CONTROL") -{ - field(DOL, 0) - field(OUTA, "$(INSTR)$(SPS_REGISTER_NAME):CLOSE-SHUTTER PP") - field(OUTB, "$(INSTR)$(SPS_REGISTER_NAME):OPEN-SHUTTER PP") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-DELAY PP") - field(SELM, "All") -} - -record(seq, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-DELAY") -{ - field(DESC, "Delays Internal Trigger as SPS too slow") - field(DOL0, 1) - field(LNK0, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-CONTROL.PROC PP") - field(DLY0, 0.5) - field(SELM, "All") - field(PINI, "NO") -} - record(seq, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-CONTROL") { field(SELM, "Specified") field(SELL, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER.VAL NPP") - field(DO0, 1) - field(DO1, 1) - field(LNK0, "$(INSTR)$(SPS_REGISTER_NAME):CLOSE-SHUTTER PP") - field(LNK1, "$(INSTR)$(SPS_REGISTER_NAME):OPEN-SHUTTER PP") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):MAP-STATUS.PROC PP") + field(DO0, 0x02) + field(DO1, 0x01) + field(LNK0, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-TRIGGER PP") + field(LNK1, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-TRIGGER PP") + field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS") +} + +# This is a hack, the SPS sometimes doesn't registers the open/close +# command. +# +record(calcout, "$(INSTR)$(SPS_REGISTER_NAME):RETRY") +{ + field(INPA, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER") + field(INPB, "$(INSTR)$(SPS_REGISTER_NAME):OPEN") + field(INPC, "$(INSTR)$(SPS_REGISTER_NAME):BUSY") + field(INPD, "$(INSTR)$(SPS_REGISTER_NAME):MOVES") + field(CALC, "A#B&&C#0&&D=0?1:0") + field(DOPT, "Use CALC") + field(OOPT, "When Non-zero") + field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-CONTROL.PROC PP") + field(SCAN, "1 second") + field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):DECREASE-BUSY-TICK") +} + +record(calcout, "$(INSTR)$(SPS_REGISTER_NAME):DECREASE-BUSY-TICK") +{ + field(INPA, "$(INSTR)$(SPS_REGISTER_NAME):BUSY") + field(CALC, "A") + field(OOPT, "When Non-zero") + field(DOPT, "Use OCAL") + field(OCAL, "A-1") + field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):BUSY PP") } # We can't just compare the Write and Readback values, as the readback # seems to change instantly, and doesn't wait for the shutter to # actually be open. +# This record has a FLNK from MOVES bit, processing it when all +# Status bits are freshly arrived. record(calc, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS") { field(DESC, "Maps Status Variables to singular status") @@ -109,23 +106,13 @@ record(calc, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS") field(INPG, "$(INSTR)$(SPS_REGISTER_NAME):ConnStatusFetch NPP") field(INPH, "$(INSTR)$(SPS_REGISTER_NAME):ConnStatusWrite NPP") field(CALC, "(G=0||H=0||E=0||B=0)?3:(A=0||D=0)?2:(F=1)?1:C=0?3:0") - field(SCAN, ".1 second") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SET-READY PP") -} - -record(calc, "$(INSTR)$(SPS_REGISTER_NAME):INTERNAL-STATUS") -{ - field(DESC, "Maps Status Variables to singular status") - field(INPA, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS NPP") - field(INPB, "$(INSTR)$(SPS_REGISTER_NAME):BUSY NPP") - field(CALC, "( A<2 && B=1 ) ? 1 : A") - field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):STATUS PP") + field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):STATUS") } record(mbbi, "$(INSTR)$(SPS_REGISTER_NAME):STATUS") { field(DESC, "Status of Shutter") - field(INP, "$(INSTR)$(SPS_REGISTER_NAME):INTERNAL-STATUS NPP") + field(INP, "$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS NPP") field(ZRVL, "0") field(ZRST, "Okay") field(ONVL, "1") @@ -174,4 +161,16 @@ record(scalcout, "$(INSTR)$(SPS_REGISTER_NAME):STATUS-Msg") field(INHH, "$(INSTR)$(SPS_REGISTER_NAME):MOTION-Msg NPP") field(INII, "$(INSTR)$(SPS_REGISTER_NAME):Connection-Msg NPP") field(CALC, '(I=0||J=0)?II:(H=1||K=1)?HH:G=0?DD:D=0?(EE+": "+FF):F=0?GG:C=0?CC:E=0?BB:AA') + field(FLNK, "$(INSTR)$(SPS_REGISTER_NAME):SET-READY") } + +record(calcout, "$(INSTR)$(SPS_REGISTER_NAME):SET-READY") +{ + field(INPA, "$(INSTR)$(SPS_REGISTER_NAME):MOVES") + field(CALC, "A") + field(OOPT, "Transition To Zero") + field(DOPT, "Use OCAL") + field(OCAL, "0") + field(OUT, "$(INSTR)$(SPS_REGISTER_NAME):BUSY PP") +} + diff --git a/scripts/shutter.cmd b/scripts/shutter.cmd index be826d2..b09fa2e 100644 --- a/scripts/shutter.cmd +++ b/scripts/shutter.cmd @@ -23,13 +23,13 @@ $(SET_SIM_MODE=#) $(SET_SIM_MODE) system "$(sinqSPS_DIR)shutter_sim.py $(FETCH_P $(SET_SIM_MODE=#) $(SET_SIM_MODE) sleep 3 -s7plcFWConfigure("$(SPS_REGISTER_NAME)", "$(SPS_IP)", "$(FETCH_PORT=2000),1,$(FETCH_DB),0,$(SPS_FETCH_SIZE)", "$(WRITE_PORT=2001),1,$(WRITE_DB=$(FETCH_DB)),0,$(SPS_WRITE_SIZE)", "$(SPS_ENDIANNESS=1)", "$(SPS_RECEIVE_TIMEOUT=1000)", "$(SPS_RECEIVE_DELAY=200)", "0") +s7plcFWConfigure("$(SPS_REGISTER_NAME)", "$(SPS_IP)", "$(FETCH_PORT=2000),1,$(FETCH_DB),0,$(SPS_FETCH_SIZE)", "$(WRITE_PORT=2001),1,$(WRITE_DB=$(FETCH_DB)),0,$(SPS_WRITE_SIZE)", "$(SPS_ENDIANNESS=1)", "$(SPS_RECEIVE_TIMEOUT=1000)", "$(SPS_RECEIVE_DELAY=600)", "0", 1) # Provides Connection Status PVs dbLoadRecords("$(sinqSPS_DB)/sps_status.db", "INSTR=$(INSTR), SPS_REGISTER_NAME=$(SPS_REGISTER_NAME)") # Shutter PVs -dbLoadTemplate("$(sinqSPS_DB)/shutter.substitutions", "INSTR=$(INSTR), SPS_REGISTER_NAME=$(SPS_REGISTER_NAME)") +dbLoadTemplate("$(sinqSPS_DB)/shutter.substitutions", "INSTR=$(INSTR), SPS_REGISTER_NAME=$(SPS_REGISTER_NAME), STATUS_FLNK=$(INSTR)$(SPS_REGISTER_NAME):SHUTTER-STATUS") # Additional Mapping PVs dbLoadRecords("$(sinqSPS_DB)/shutter.db", "INSTR=$(INSTR), SPS_REGISTER_NAME=$(SPS_REGISTER_NAME)") diff --git a/templates/shutter.substitutions b/templates/shutter.substitutions index 62e4ab9..519de98 100644 --- a/templates/shutter.substitutions +++ b/templates/shutter.substitutions @@ -1,23 +1,30 @@ -file "$(sinqSPS_DB)/writebit.db" +#file "$(sinqSPS_DB)/writebit.db" +#{ +# pattern +# {OFFSET, BIT, BIT_NAME , DESC } +# {0 , 0 , "OPEN-SHUTTER" , "Opens the Shutter" } +# {0 , 1 , "CLOSE-SHUTTER", "Closes the Shutter"} +#} + +file "$(sinqSPS_DB)/writeusint.db" { pattern - {OFFSET, BIT, BIT_NAME , DESC } - {0 , 0 , "OPEN-SHUTTER" , "Opens the Shutter" } - {0 , 1 , "CLOSE-SHUTTER", "Closes the Shutter"} + {OFFSET, UINT_NAME, DESC } + {0 , "SHUTTER-TRIGGER" , "Trigger Shutter" } } file "$(sinqSPS_DB)/readbit.db" { pattern - {OFFSET, BIT, BIT_NAME , ZNAM , ONAM , DESC} - {1 , 0 , "PSYS-OK" , "" , "" , "" } - {1 , 1 , "SHUTTER-READY" , "No" , "Yes" , "" } - {1 , 2 , "EMERGENCY-STOP-OFF", "" , "" , "" } - {1 , 3 , "NOT-LOCKED" , "" , "" , "" } - {1 , 4 , "CLOSED" , "Open" , "Closed" , "" } - {1 , 5 , "OPEN" , "Closed" , "Open" , "" } - {1 , 6 , "REMOTE-OKAY" , "" , "" , "" } - {1 , 7 , "MOVES" , "Stationary" , "Moving" , "" } + {OFFSET, BIT, BIT_NAME , ZNAM , ONAM , DESC, FLNK} + {1 , 0 , "PSYS-OK" , "" , "" , "", ""} + {1 , 1 , "SHUTTER-READY" , "No" , "Yes" , "", ""} + {1 , 2 , "EMERGENCY-STOP-OFF", "" , "" , "", ""} + {1 , 3 , "NOT-LOCKED" , "" , "" , "", ""} + {1 , 4 , "CLOSED" , "Open" , "Closed" , "", ""} + {1 , 5 , "OPEN" , "Closed" , "Open" , "", ""} + {1 , 6 , "REMOTE-OKAY" , "" , "" , "", ""} + {1 , 7 , "MOVES" , "Stationary" , "Moving" , "", "$(STATUS_FLNK)"} } # The way that the strings are currently implemented in the SPS, the first two