epicsdev_ps_caen_fastps 0.0.2__tar.gz

epicsdev_ps_caen_fastps-0.0.2/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Electron-Ion Collider
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

epicsdev_ps_caen_fastps-0.0.2/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.5
+Name: epicsdev_ps_caen_fastps
+Version: 0.0.2
+Summary: EPICS PVAccess server for CAEN FAST-PS power supplies
+License-File: LICENSE

epicsdev_ps_caen_fastps-0.0.2/README.md

@@ -0,0 +1,99 @@
+# epicsdev_ps_caen_fastps
+
+EPICS PVAccess server for CAEN FAST-PS power supplies, implemented with `epicsdev`.
+
+Main server module: [caen_fastps/__main__.py](caen_fastps/__main__.py)  
+IOC reference DB: [ioc/fastps.db](ioc/fastps.db)  
+Phoebus screen generator: [opi/generate_screen.py](screens/generate_screen.py)
+- Main server module: [epicsdev_ps_caen_fastps/__main__.py](epicsdev_ps_caen_fastps/__main__.py)
+- IOC reference DB: [docs/fastps.db](docs/fastps.db)
+- Phoebus screen generator: [opi/generate_opi.py](opi/generate_opi.py)
+
+## Features
+
+- TCP remote control interface to FAST-PS (default port `10001`)
+- PV set modeled after the IOC records in [docs/fastps.db](docs/fastps.db)
+- Setpoint control with optional ramping:
+  - `Voltage`, `Current`, `RampEnable`
+- Output and diagnostic readback:
+  - `OutputVoltage`, `OutputCurrent`, `GroundCurrent`, `DCLinkVoltage`, `HeatsinkTemp`
+- Status and state control:
+  - `StatusMSB`, `StatusLSB`, `StatusReset`, `Enable`, `RegulationMode`, `Upmode`
+- Ramp-rate control:
+  - `RampRateV`, `RampRateI`
+- Device identity and inferred limits:
+  - `Model`, `Version`, `Limits`
+- Generic command passthrough:
+  - `instrCmdS`, `instrCmdR`
+
+## FAST-PS protocol mapping
+
+Implemented command families:
+
+- `VER`
+- `MON`, `MOFF`
+- `LOOP`, `LOOP ?`
+- `MWV`, `MWV ?`, `MWVR`
+- `MWI`, `MWI ?`, `MWIR`
+- `MRESET`
+- `MST`
+- `UPMODE:?`, `UPMODE:<mode>`
+- `MSRV:?`, `MSRV:<value>`
+- `MSRI:?`, `MSRI:<value>`
+- `MRV`, `MRI`, `MGC`, `MRP`, `MRT`
+
+## Requirements
+
+- Python 3.10+
+- `epicsdev` and its runtime dependencies (including `p4p`)
+- Network access to the CAEN FAST-PS device
+
+## Run
+
+From this project directory:
+
+- `python -m epicsdev_ps_caen_fastps`
+
+Useful arguments:
+
+- `--host` FAST-PS IP/hostname (default: `130.199.104.57`)
+- `--port` TCP port (default: `10001`)
+- `--timeout` socket timeout in seconds (default: `2.0`)
+- `-d, --device` PV prefix device root (default: `caen_fastps`)
+- `-i, --index` PV prefix index (default: `0`)
+- `-v` increase verbosity (`-vv` for more)
+- `-a, --autosave` enable autosave with optional directory
+- `-c, --recall` disable restoring autosaved values on startup
+
+Example:
+
+- `python -m epicsdev_ps_caen_fastps --host 130.199.104.57 -d caen_fastps:`
+
+Default PV prefix:
+
+- `caen_fastps0:`
+
+## Generate a Phoebus screen
+
+Generate `.bob` OPI file:
+
+- `python generate_opi.py -t FAST-PS pva://caen_fastps:0:`
+
+Options:
+
+- `-t, --title` screen title
+- `prefix` PV prefix macro/value (default: `$(DEV):`)
+
+Output:
+
+- [opi/caen_fastps.bob](opi/caen_fastps.bob)
+
+## Screenshot
+
+- [docs/opi_caen_fastps.jpg](docs/opi_caen_fastps.jpg)
+
+## Notes
+
+- The server uses common `epicsdev` control PVs such as `server`, `sleep`, `status`, and `HEARTBEAT`.
+- `Enable` is synchronized from bit 0 of `StatusLSB` during polling.
+- For unsupported/custom diagnostics, use `instrCmdS` and read the reply from `instrCmdR`.

epicsdev_ps_caen_fastps-0.0.2/docs/fastps.db

@@ -0,0 +1,283 @@
+
+record(bo, "$(P)$(R)RegulationMode")
+{
+    field(DESC, "Selects between voltage/current reg")
+    field(DTYP, "stream")
+    field(OUT,  "@fastps.proto setRegulationMode L0")
+    field(ZNAM, "V")
+    field(ONAM, "I")
+}
+
+record(ao, "$(P)$(R)Voltage")
+{
+    field(DESC, "Voltage control (in V reg mode)")
+    field(DTYP, "stream")
+    field(EGU,  "V")
+    field(OUT,  "@fastps.proto setVoltage($(P)$(R)) L0")
+    field(PREC, "5")
+}
+
+record(ao, "$(P)$(R)Current")
+{
+    field(DESC, "Current control (in V reg mode)")
+    field(DTYP, "stream")
+    field(EGU,  "A")
+    field(OUT,  "@fastps.proto setCurrent($(P)$(R)) L0")
+    field(PREC, "5")
+}
+
+record(bo, "$(P)$(R)StatusReset")
+{
+    field(DESC, "Reset status register/clear faults")
+    field(DTYP, "stream")
+    field(OUT,  "@fastps.proto resetStatus L0")
+}
+
+record(bo, "$(P)$(R)RampEnable")
+{
+    field(DESC, "Enables/disables ramping to setpoint")
+    field(ZNAM, "Off")
+    field(ONAM, "On")
+    field(DOL,  "0")
+    field(PINI, "YES")
+}
+
+################################################################################
+record(bi, "$(P)$(R)ReadbackPoll_")
+{
+    field(DESC, "Head of readback chain")
+    field(FLNK, "$(P)$(R)OutputVoltage")
+    field(PINI, "YES")
+    field(INP,  "0")
+    field(SCAN, "1 second")
+}
+
+record(ai, "$(P)$(R)OutputVoltage")
+{
+    field(DESC, "Output voltage")
+    field(DTYP, "stream")
+    field(EGU,  "V")
+    field(FLNK, "$(P)$(R)OutputCurrent")
+    field(INP,  "@fastps.proto getOutputVoltage L0")
+    field(PREC, "5")
+}
+
+record(ai, "$(P)$(R)OutputCurrent")
+{
+    field(DESC, "Output current")
+    field(DTYP, "stream")
+    field(EGU,  "A")
+    field(FLNK, "$(P)$(R)GroundCurrent")
+    field(INP,  "@fastps.proto getOutputCurrent L0")
+    field(PREC, "5")
+}
+
+record(ai, "$(P)$(R)GroundCurrent")
+{
+    field(DESC, "Ground current")
+    field(DTYP, "stream")
+    field(EGU,  "A")
+    field(FLNK, "$(P)$(R)DCLinkVoltage")
+    field(INP,  "@fastps.proto getGroundCurrent L0")
+    field(PREC, "3")
+}
+
+record(ai, "$(P)$(R)DCLinkVoltage")
+{
+    field(DESC, "DC Link voltage")
+    field(DTYP, "stream")
+    field(EGU,  "V")
+    field(FLNK, "$(P)$(R)HeatsinkTemp")
+    field(INP,  "@fastps.proto getDCLinkVoltage L0")
+    field(PREC, "2")
+}
+
+record(ai, "$(P)$(R)HeatsinkTemp")
+{
+    field(DESC, "Heatsink temperature")
+    field(DTYP, "stream")
+    field(EGU,  "deg C")
+    field(FLNK, "$(P)$(R)StatusMSB")
+    field(INP,  "@fastps.proto getTemperature L0")
+    field(PREC, "2")
+}
+
+record(mbbiDirect, "$(P)$(R)StatusMSB")
+{
+    field(DESC, "Status MSB")
+    field(DTYP, "stream")
+    field(FLNK, "$(P)$(R)StatusLSB")
+    field(INP,  "@fastps.proto getStatusMSB L0")
+}
+
+record(mbbiDirect, "$(P)$(R)StatusLSB")
+{
+    field(DESC, "Status LSB")
+    field(DTYP, "stream")
+    field(FLNK, "$(P)$(R)Limits")
+    field(INP,  "@fastps.proto getStatusLSB L0")
+}
+
+record (aai, "$(P)$(R)Limits")
+{
+    field(DESC, "Limits")
+    field(DTYP, "stream")
+
+    field(FTVL, "FLOAT")
+    field(NELM, "4")
+    field(INP,  "@fastps.proto getLimits L0")
+    field(FLNK, "$(P)$(R)LimitMinV")
+}
+
+record (ai, "$(P)$(R)LimitMinV")
+{
+    field(DESC, "Low limit of voltage")
+    field(DTYP, "stream")
+    field(EGU,  "V")
+    field(FLNK, "$(P)$(R)LimitMaxV")
+    field(INP, "@fastps.proto getMinV L0")
+}
+
+record (ai, "$(P)$(R)LimitMaxV")
+{
+    field(DESC, "High limit of voltage")
+    field(DTYP, "stream")
+    field(EGU,  "V")
+    field(FLNK, "$(P)$(R)LimitMinI")
+    field(INP, "@fastps.proto getMaxV L0")
+}
+
+record (ai, "$(P)$(R)LimitMinI")
+{
+    field(DESC, "Low limit of current")
+    field(DTYP, "stream")
+    field(EGU,  "A")
+    field(FLNK, "$(P)$(R)LimitMaxI")
+    field(INP, "@fastps.proto getMinI L0")
+}
+
+record (ai, "$(P)$(R)LimitMaxI")
+{
+    field(DESC, "High limit of current")
+    field(DTYP, "stream")
+    field(EGU,  "A")
+    field(FLNK, "$(P)$(R)LimitMinV_")
+    field(INP, "@fastps.proto getMaxI L0")
+}
+
+record (calcout, "$(P)$(R)LimitMinV_")
+{
+    field(DESC, "Low limit for Voltage")
+    field(INPA, "$(P)$(R)LimitMinV")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)Voltage.LOPR")
+    field(FLNK, "$(P)$(R)LimitMinVOutput_")
+}
+
+record (calcout, "$(P)$(R)LimitMinVOutput_")
+{
+    field(DESC, "Low limit for output Voltage")
+    field(INPA, "$(P)$(R)LimitMinV")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)OutputVoltage.LOPR")
+    field(FLNK, "$(P)$(R)LimitMaxV_")
+}
+
+record (calcout, "$(P)$(R)LimitMaxV_")
+{
+    field(DESC, "High limit for Voltage")
+    field(INPA, "$(P)$(R)LimitMaxV")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)Voltage.HOPR")
+    field(FLNK, "$(P)$(R)LimitMaxVOutput_")
+}
+
+record (calcout, "$(P)$(R)LimitMaxVOutput_")
+{
+    field(DESC, "High limit for output Voltage")
+    field(INPA, "$(P)$(R)LimitMaxV")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)OutputVoltage.HOPR")
+    field(FLNK, "$(P)$(R)LimitMinI_")
+}
+
+record (calcout, "$(P)$(R)LimitMinI_")
+{
+    field(DESC, "Low limit for Current")
+    field(INPA, "$(P)$(R)LimitMinI")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)Current.LOPR")
+    field(FLNK, "$(P)$(R)LimitMinIOutput_")
+}
+
+record (calcout, "$(P)$(R)LimitMinIOutput_")
+{
+    field(DESC, "Low limit for output Current")
+    field(INPA, "$(P)$(R)LimitMinI")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)OutputCurrent.LOPR")
+    field(FLNK, "$(P)$(R)LimitMaxI_")
+}
+
+record (calcout, "$(P)$(R)LimitMaxI_")
+{
+    field(DESC, "High limit for Current")
+    field(INPA, "$(P)$(R)LimitMaxI")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)Current.HOPR")
+    field(FLNK, "$(P)$(R)LimitMaxIOutput_")
+}
+
+record (calcout, "$(P)$(R)LimitMaxIOutput_")
+{
+    field(DESC, "High limit for output Current")
+    field(INPA, "$(P)$(R)LimitMaxI")
+    field(CALC,  "A")
+    field(OUT,  "$(P)$(R)OutputCurrent.HOPR")
+    field(FLNK, "$(P)$(R)Model")
+}
+
+record (stringin, "$(P)$(R)Model")
+{
+    field(DESC, "Model")
+    field(DTYP, "stream")
+    field(INP,  "@fastps.proto getModel L0")
+    field(FLNK, "$(P)$(R)Version")
+}
+
+record (stringin, "$(P)$(R)Version")
+{
+    field(DESC, "Version")
+    field(DTYP, "stream")
+    field(INP,  "@fastps.proto getVersion L0")
+    field(FLNK, "$(P)$(R)_EnableInit")
+}
+
+record(mbbiDirect, "$(P)$(R)_EnableInit")
+{
+    field(DESC, "Initialization for Enable")
+    field(DTYP, "stream")
+    field(PINI, "YES")
+    field(INP,  "@fastps.proto getStatusLSB L0")
+    field(FLNK, "$(P)$(R)_EnableInitCalc")
+}
+
+record(calcout, "$(P)$(R)_EnableInitCalc")
+{
+    field(DESC, "Initialization for Enable")
+    field(INPA, "$(P)$(R)StatusLSB")
+    field(CALC, "A & 0x1")
+    field(OUT,  "$(P)$(R)Enable.VAL")
+}
+
+record(bo, "$(P)$(R)Enable")
+{
+    field(DESC, "Turn supply off/on")
+    field(DTYP, "stream")
+    field(OUT,  "@fastps.proto setEnable L0")
+    field(ZNAM, "Off")
+    field(ONAM, "On")
+    # the field gets initialized from status, clear UDF
+    field(STAT, "NO_ALARM")
+    field(SEVR, "NO_ALARM")
+}

epicsdev_ps_caen_fastps-0.0.2/docs/prompt.txt

@@ -0,0 +1,4 @@
+## Initial prompt for caen_fastps
+Add code to implement EPICS PVAccess server, using epicsdev module.
+Use programming manual at docs/'Remote Control Manual Rev3.1.pdf'.
+Create PVs similar to ones, described in IOC db file ioc/fastps.db