use the INSTR environment variable instead of PREFIX

This commit is contained in:
2025-04-29 15:58:32 +02:00
parent d4b111ce6d
commit d81105551d
13 changed files with 202 additions and 184 deletions

View File

@ -1,7 +1,8 @@
Counterbox Epics Module
SINQDAQ Epics Module
-----------------------
A Stream and Asyn based driver for configuring the Counterboxes at SINQ.
A Stream and Asyn based driver for configuring the Data Acquisition Systems at
SINQ.
This supports the older 4 and 8 channel EL737 models and the new 10CH 2nd
generation systems.
@ -15,7 +16,7 @@ Required Variables
| Environment Variable | Purpose |
|----------------------|-----------------------------------------|
| PREFIX | Prefix of all device specific PVs |
| INSTR | Prefix of all device specific PVs |
| NAME | First field in all PVs after Prefix |
| CNTBOX\_IP | Network IP of device |
| CNTBOX\_PORT | Network Port of device |
@ -23,7 +24,7 @@ Required Variables
All PVs take the form
```
$(PREFIX):$(NAME):*
$(INSTR)$(NAME):*
```
Available device startup scripts
@ -35,25 +36,25 @@ Available device startup scripts
A device can be configured using one of the startup scripts as follows
```
epicsEnvSet("PREFIX", "SQ:INSTRUMENT") # can also be set in runScript call
epicsEnvSet("INSTR", "SQ:INSTRUMENT:") # can also be set in runScript call
runScript "$(counterbox_DIR)counterbox_v2.cmd" "NAME=COUNTERBOX, CNTBOX_IP=TestInst-DAQ1, CNTBOX_PORT=2000"
```
## PVs of Interest
| PV | Description |
|---------------------------------------|----------------------------------------------------------------------|
| \$(PREFIX):\$(NAME):MsgTxt | Contains unexpected response to executed command |
| \$(PREFIX):\$(NAME):STATUS | 0: Idle, 1: Counting, 2: Low rate, 3: Paused, 4: Error |
| \$(PREFIX):\$(NAME):MONITOR-CHANNEL | Channel that PRESET-COUNT monitors (has RBV, only v2 can be changed) |
| \$(PREFIX):\$(NAME):PRESET-COUNT | Run count until specified pv value reached |
| \$(PREFIX):\$(NAME):PRESET-TIME | Run count until specified pv value in seconds reached |
| \$(PREFIX):\$(NAME):THRESHOLD | Minimum rate for counting to preceed. (has RBV) |
| \$(PREFIX):\$(NAME):THRESHOLD-MONITOR | Channel monitored for minimum rate (has RBV) |
| \$(PREFIX):\$(NAME):ELAPSED-TIME | Time Counterbox has been measuring for |
| \$(PREFIX):\$(NAME):M_ | Current count on channel. (1-10 depending on box) |
| \$(PREFIX):\$(NAME):CHANNELS | Number of available channels (4, 8 or 10) |
| PV | Description |
|-------------------------------------|----------------------------------------------------------------------|
| \$(INSTR)\$(NAME):MsgTxt | Contains unexpected response to executed command |
| \$(INSTR)\$(NAME):STATUS | 0: Idle, 1: Counting, 2: Low rate, 3: Paused, 4: Error |
| \$(INSTR)\$(NAME):MONITOR-CHANNEL | Channel that PRESET-COUNT monitors (has RBV, only v2 can be changed) |
| \$(INSTR)\$(NAME):PRESET-COUNT | Run count until specified pv value reached |
| \$(INSTR)\$(NAME):PRESET-TIME | Run count until specified pv value in seconds reached |
| \$(INSTR)\$(NAME):THRESHOLD | Minimum rate for counting to preceed. (has RBV) |
| \$(INSTR)\$(NAME):THRESHOLD-MONITOR | Channel monitored for minimum rate (has RBV) |
| \$(INSTR)\$(NAME):ELAPSED-TIME | Time Counterbox has been measuring for |
| \$(INSTR)\$(NAME):M_ | Current count on channel. (1-10 depending on box) |
| \$(INSTR)\$(NAME):CHANNELS | Number of available channels (4, 8 or 10) |
## Generating Test Signals