chore(nidaq): improve readbability of nidaq signal definition

.copier-answers.yml

@@ -2,7 +2,7 @@
 # It is needed to track the repo template version, and editing may break things.
 # This file will be overwritten by copier on template updates.
 
-_commit: v1.2.8
+_commit: v1.4.0
 _src_path: https://github.com/bec-project/plugin_copier_template.git
 make_commit: false
 project_name: debye_bec

.gitea/workflows/create_update_pr.yml

@@ -17,16 +17,22 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-    
-      - name: Install tools
-        run: |
-          pip install copier PySide6
 
       - name: Checkout
         uses: actions/checkout@v4
-    
+
+      - name: Create virtualenv
+	    run: |
+	      python -m virtualenv .venv
+
+      - name: Install tools
+        run: |
+          source .venv/bin/activate
+          pip install copier PySide6 bec_lib
+
       - name: Perform update
         run: |
+          source .venv/bin/activate
           git config --global user.email "bec_ci_staging@psi.ch"
           git config --global user.name "BEC automated CI"
 
@@ -35,8 +41,10 @@ jobs:
           git checkout -b $branch
 
           echo "Running copier update..."
-          output="$(copier update --trust --defaults --conflict inline 2>&1)"
-          echo "$output"
+          copier update --trust --defaults --conflict inline 2>&1 | tee copier.log
+          status=${PIPESTATUS[0]}
+          output="$(cat copier.log)"
+          echo $output
           msg="$(printf '%s\n' "$output" | head -n 1)"
 
           if ! grep -q "make_commit: true" .copier-answers.yml ; then

debye_bec/devices/nidaq/nidaq.py

@@ -32,46 +32,23 @@ class NidaqError(Exception):
 class NidaqControl(Device):
     """Nidaq control class with all PVs"""
 
+    # fmt: off
     ### Readback PVs for EpicsEmitter ###
     energy = Cpt(SetableSignal, value=0, kind=Kind.normal)
 
-    smpl_abs = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream sample absorption"
-    )
-    smpl_fluo = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream sample fluorescence"
-    )
-    ref_abs = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream reference absorption"
-    )
-    cisum = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter sum"
-    )
+    smpl_abs = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream sample absorption")
+    smpl_fluo = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream sample fluorescence")
+    ref_abs = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream reference absorption")
+    cisum = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter sum")
 
-    ai0_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 0, MEAN"
-    )
-    ai1_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 1, MEAN"
-    )
-    ai2_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 2, MEAN"
-    )
-    ai3_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 3, MEAN"
-    )
-    ai4_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 4, MEAN"
-    )
-    ai5_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 5, MEAN"
-    )
-    ai6_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 6, MEAN"
-    )
-    ai7_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 7, MEAN"
-    )
+    ai0_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 0, MEAN")
+    ai1_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 1, MEAN")
+    ai2_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 2, MEAN")
+    ai3_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 3, MEAN")
+    ai4_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 4, MEAN")
+    ai5_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 5, MEAN")
+    ai6_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 6, MEAN")
+    ai7_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 7, MEAN")
 
     di0_max = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream digital input 0, MAX")
     di1_max = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream digital input 1, MAX")
@@ -79,377 +56,91 @@ class NidaqControl(Device):
     di3_max = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream digital input 3, MAX")
     di4_max = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream digital input 4, MAX")
 
-    ci0_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 0, MEAN"
-    )
-    ci1_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 1, MEAN"
-    )
-    ci2_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 2, MEAN"
-    )
-    ci3_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 3, MEAN"
-    )
-    ci4_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 4, MEAN"
-    )
-    ci5_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 5, MEAN"
-    )
-    ci6_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 6, MEAN"
-    )
-    ci7_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 7, MEAN"
-    )
-    ci8_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 8, MEAN"
-    )
-    ci9_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 9, MEAN"
-    )
-    ci10_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 10, MEAN"
-    )
-    ci11_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 11, MEAN"
-    )
-    ci12_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 12, MEAN"
-    )
-    ci13_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 13, MEAN"
-    )
-    ci14_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 14, MEAN"
-    )
-    ci15_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 15, MEAN"
-    )
-    ci16_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 16, MEAN"
-    )
-    ci17_mean = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 17, MEAN"
-    )
+    ci0_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 0, MEAN")
+    ci1_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 1, MEAN")
+    ci2_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 2, MEAN")
+    ci3_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 3, MEAN")
+    ci4_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 4, MEAN")
+    ci5_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 5, MEAN")
+    ci6_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 6, MEAN")
+    ci7_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 7, MEAN")
+    ci8_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 8, MEAN")
+    ci9_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 9, MEAN")
+    ci10_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 10, MEAN")
+    ci11_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 11, MEAN")
+    ci12_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 12, MEAN")
+    ci13_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 13, MEAN")
+    ci14_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 14, MEAN")
+    ci15_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 15, MEAN")
+    ci16_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 16, MEAN")
+    ci17_mean = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 17, MEAN")
 
-    ai0 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI0",
-        kind=Kind.normal,
-        doc="EPICS analog input 0",
-        auto_monitor=True,
-    )
-    ai1 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI1",
-        kind=Kind.normal,
-        doc="EPICS analog input 1",
-        auto_monitor=True,
-    )
-    ai2 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI2",
-        kind=Kind.normal,
-        doc="EPICS analog input 2",
-        auto_monitor=True,
-    )
-    ai3 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI3",
-        kind=Kind.normal,
-        doc="EPICS analog input 3",
-        auto_monitor=True,
-    )
-    ai4 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI4",
-        kind=Kind.normal,
-        doc="EPICS analog input 4",
-        auto_monitor=True,
-    )
-    ai5 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI5",
-        kind=Kind.normal,
-        doc="EPICS analog input 5",
-        auto_monitor=True,
-    )
-    ai6 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI6",
-        kind=Kind.normal,
-        doc="EPICS analog input 6",
-        auto_monitor=True,
-    )
-    ai7 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-AI7",
-        kind=Kind.normal,
-        doc="EPICS analog input 7",
-        auto_monitor=True,
-    )
+    ai0 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI0", kind=Kind.normal, doc="EPICS analog input 0", auto_monitor=True)
+    ai1 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI1", kind=Kind.normal, doc="EPICS analog input 1", auto_monitor=True)
+    ai2 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI2", kind=Kind.normal, doc="EPICS analog input 2", auto_monitor=True)
+    ai3 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI3", kind=Kind.normal, doc="EPICS analog input 3", auto_monitor=True)
+    ai4 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI4", kind=Kind.normal, doc="EPICS analog input 4", auto_monitor=True)
+    ai5 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI5", kind=Kind.normal, doc="EPICS analog input 5", auto_monitor=True)
+    ai6 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI6", kind=Kind.normal, doc="EPICS analog input 6", auto_monitor=True)
+    ai7 = Cpt(EpicsSignalRO, suffix="NIDAQ-AI7", kind=Kind.normal, doc="EPICS analog input 7", auto_monitor=True)
 
-    ci0 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI0",
-        kind=Kind.normal,
-        doc="EPICS counter input 0",
-        auto_monitor=True,
-    )
-    ci1 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI1",
-        kind=Kind.normal,
-        doc="EPICS counter input 1",
-        auto_monitor=True,
-    )
-    ci2 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI2",
-        kind=Kind.normal,
-        doc="EPICS counter input 2",
-        auto_monitor=True,
-    )
-    ci3 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI3",
-        kind=Kind.normal,
-        doc="EPICS counter input 3",
-        auto_monitor=True,
-    )
-    ci4 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI4",
-        kind=Kind.normal,
-        doc="EPICS counter input 4",
-        auto_monitor=True,
-    )
-    ci5 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI5",
-        kind=Kind.normal,
-        doc="EPICS counter input 5",
-        auto_monitor=True,
-    )
-    ci6 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI6",
-        kind=Kind.normal,
-        doc="EPICS counter input 6",
-        auto_monitor=True,
-    )
-    ci7 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI7",
-        kind=Kind.normal,
-        doc="EPICS counter input 7",
-        auto_monitor=True,
-    )
-    ci8 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI8",
-        kind=Kind.normal,
-        doc="EPICS counter input 8",
-        auto_monitor=True,
-    )
-    ci9 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI9",
-        kind=Kind.normal,
-        doc="EPICS counter input 9",
-        auto_monitor=True,
-    )
-    ci10 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI10",
-        kind=Kind.normal,
-        doc="EPICS counter input 0",
-        auto_monitor=True,
-    )
-    ci11 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI11",
-        kind=Kind.normal,
-        doc="EPICS counter input 1",
-        auto_monitor=True,
-    )
-    ci12 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI12",
-        kind=Kind.normal,
-        doc="EPICS counter input 2",
-        auto_monitor=True,
-    )
-    ci13 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI13",
-        kind=Kind.normal,
-        doc="EPICS counter input 3",
-        auto_monitor=True,
-    )
-    ci14 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI14",
-        kind=Kind.normal,
-        doc="EPICS counter input 4",
-        auto_monitor=True,
-    )
-    ci15 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI15",
-        kind=Kind.normal,
-        doc="EPICS counter input 5",
-        auto_monitor=True,
-    )
-    ci16 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI16",
-        kind=Kind.normal,
-        doc="EPICS counter input 6",
-        auto_monitor=True,
-    )
-    ci17 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-CI17",
-        kind=Kind.normal,
-        doc="EPICS counter input 7",
-        auto_monitor=True,
-    )
+    ci0 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI0", kind=Kind.normal, doc="EPICS counter input 0", auto_monitor=True)
+    ci1 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI1", kind=Kind.normal, doc="EPICS counter input 1", auto_monitor=True)
+    ci2 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI2", kind=Kind.normal, doc="EPICS counter input 2", auto_monitor=True)
+    ci3 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI3", kind=Kind.normal, doc="EPICS counter input 3", auto_monitor=True)
+    ci4 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI4", kind=Kind.normal, doc="EPICS counter input 4", auto_monitor=True)
+    ci5 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI5", kind=Kind.normal, doc="EPICS counter input 5", auto_monitor=True)
+    ci6 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI6", kind=Kind.normal, doc="EPICS counter input 6", auto_monitor=True)
+    ci7 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI7", kind=Kind.normal, doc="EPICS counter input 7", auto_monitor=True)
+    ci8 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI8", kind=Kind.normal, doc="EPICS counter input 8", auto_monitor=True)
+    ci9 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI9", kind=Kind.normal, doc="EPICS counter input 9", auto_monitor=True)
+    ci10 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI10", kind=Kind.normal, doc="EPICS counter input 0", auto_monitor=True)
+    ci11 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI11", kind=Kind.normal, doc="EPICS counter input 1", auto_monitor=True)
+    ci12 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI12", kind=Kind.normal, doc="EPICS counter input 2", auto_monitor=True)
+    ci13 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI13", kind=Kind.normal, doc="EPICS counter input 3", auto_monitor=True)
+    ci14 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI14", kind=Kind.normal, doc="EPICS counter input 4", auto_monitor=True)
+    ci15 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI15", kind=Kind.normal, doc="EPICS counter input 5", auto_monitor=True)
+    ci16 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI16", kind=Kind.normal, doc="EPICS counter input 6", auto_monitor=True)
+    ci17 = Cpt(EpicsSignalRO, suffix="NIDAQ-CI17", kind=Kind.normal, doc="EPICS counter input 7", auto_monitor=True)
 
-    di0 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-DI0",
-        kind=Kind.normal,
-        doc="EPICS digital input 0",
-        auto_monitor=True,
-    )
-    di1 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-DI1",
-        kind=Kind.normal,
-        doc="EPICS digital input 1",
-        auto_monitor=True,
-    )
-    di2 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-DI2",
-        kind=Kind.normal,
-        doc="EPICS digital input 2",
-        auto_monitor=True,
-    )
-    di3 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-DI3",
-        kind=Kind.normal,
-        doc="EPICS digital input 3",
-        auto_monitor=True,
-    )
-    di4 = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-DI4",
-        kind=Kind.normal,
-        doc="EPICS digital input 4",
-        auto_monitor=True,
-    )
+    di0 = Cpt(EpicsSignalRO, suffix="NIDAQ-DI0", kind=Kind.normal, doc="EPICS digital input 0", auto_monitor=True)
+    di1 = Cpt(EpicsSignalRO, suffix="NIDAQ-DI1", kind=Kind.normal, doc="EPICS digital input 1", auto_monitor=True)
+    di2 = Cpt(EpicsSignalRO, suffix="NIDAQ-DI2", kind=Kind.normal, doc="EPICS digital input 2", auto_monitor=True)
+    di3 = Cpt(EpicsSignalRO, suffix="NIDAQ-DI3", kind=Kind.normal, doc="EPICS digital input 3", auto_monitor=True)
+    di4 = Cpt(EpicsSignalRO, suffix="NIDAQ-DI4", kind=Kind.normal, doc="EPICS digital input 4", auto_monitor=True)
 
-    enc_epics = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-ENC",
-        kind=Kind.normal,
-        doc="EPICS Encoder reading",
-        auto_monitor=True,
-    )
+    enc_epics = Cpt(EpicsSignalRO, suffix="NIDAQ-ENC", kind=Kind.normal, doc="EPICS Encoder reading", auto_monitor=True)
 
-    energy_epics = Cpt(
-        EpicsSignalRO,
-        suffix="NIDAQ-ENERGY",
-        kind=Kind.normal,
-        doc="EPICS Energy reading",
-        auto_monitor=True,
-    )
+    energy_epics = Cpt(EpicsSignalRO, suffix="NIDAQ-ENERGY", kind=Kind.normal, doc="EPICS Energy reading", auto_monitor=True)
 
     ### Readback for BEC emitter ###
-    ai0_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 0, STD"
-    )
-    ai1_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 1, STD"
-    )
-    ai2_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 2, STD"
-    )
-    ai3_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 3, STD"
-    )
-    ai4_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 4, STD"
-    )
-    ai5_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 5, STD"
-    )
-    ai6_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 6, STD"
-    )
-    ai7_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 7, STD"
-    )
+    ai0_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 0, STD")
+    ai1_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 1, STD")
+    ai2_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 2, STD")
+    ai3_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 3, STD")
+    ai4_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 4, STD")
+    ai5_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 5, STD")
+    ai6_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 6, STD")
+    ai7_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream analog input 7, STD")
 
-    ci0_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 0. STD"
-    )
-    ci1_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 1. STD"
-    )
-    ci2_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 2. STD"
-    )
-    ci3_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 3. STD"
-    )
-    ci4_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 4. STD"
-    )
-    ci5_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 5. STD"
-    )
-    ci6_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 6. STD"
-    )
-    ci7_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 7. STD"
-    )
-    ci8_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 8. STD"
-    )
-    ci9_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 9. STD"
-    )
-    ci10_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 10. STD"
-    )
-    ci11_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 11. STD"
-    )
-    ci12_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 12. STD"
-    )
-    ci13_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 13. STD"
-    )
-    ci14_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 14. STD"
-    )
-    ci15_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 15. STD"
-    )
-    ci16_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 16. STD"
-    )
-    ci17_std_dev = Cpt(
-        SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 17. STD"
-    )
+    ci0_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 0. STD")
+    ci1_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 1. STD")
+    ci2_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 2. STD")
+    ci3_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 3. STD")
+    ci4_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 4. STD")
+    ci5_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 5. STD")
+    ci6_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 6. STD")
+    ci7_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 7. STD")
+    ci8_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 8. STD")
+    ci9_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 9. STD")
+    ci10_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 10. STD")
+    ci11_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 11. STD")
+    ci12_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 12. STD")
+    ci13_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 13. STD")
+    ci14_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 14. STD")
+    ci15_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 15. STD")
+    ci16_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 16. STD")
+    ci17_std_dev = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream counter input 17. STD")
 
     xas_timestamp = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream XAS timestamp")
     xrd_timestamp = Cpt(SetableSignal, value=0, kind=Kind.normal, doc="NIDAQ stream XRD timestamp")
@@ -510,6 +201,8 @@ class NidaqControl(Device):
     ref_abs_de = Cpt(EpicsSignal, suffix="NIDAQ-ref_abs_de", kind=Kind.config, auto_monitor=True)
     ref_abs_de_string = Cpt(EpicsSignal, suffix="NIDAQ-ref_abs_de", kind=Kind.config, string=True, auto_monitor=True)
 
+    # fmt: on
+
 
 class Nidaq(PSIDeviceBase, NidaqControl):
     """NIDAQ ophyd wrapper around the NIDAQ backend currently running at x01da-cons-05
@@ -528,7 +221,9 @@ class Nidaq(PSIDeviceBase, NidaqControl):
         super().__init__(name=name, prefix=prefix, scan_info=scan_info, **kwargs)
         self.scan_info: ScanInfo
         self.timeout_wait_for_signal = 5  # put 5s firsts
-        self._timeout_wait_for_pv = 5  # 5s timeout for pv calls. editted due to timeout issues persisting 
+        self._timeout_wait_for_pv = (
+            5  # 5s timeout for pv calls. editted due to timeout issues persisting
+        )
         self.valid_scan_names = [
             "xas_simple_scan",
             "xas_simple_scan_with_xrd",

debye_bec/scans/scan_customization/scan_components.py

@@ -0,0 +1,12 @@
+"""
+Scan components for debye_bec.
+
+The scan components module allows you to define custom components that can be used in your scans.
+These components can be used to encapsulate reusable logic, interact with devices, or perform specific actions during the scan lifecycle.
+"""
+
+from bec_server.scan_server.scans.scan_components import ScanComponents
+
+
+class DebyeBecScanComponents(ScanComponents):
+    """Scan components for debye_bec."""

debye_bec/scans/scan_customization/scan_modifier.py

@@ -0,0 +1,33 @@
+"""
+Scan modifier plugin for debye_bec.
+
+The scan modifier allows you to modify the scan lifecycle and run custom actions before or after the scan hook or replace the scan hook entirely.
+Note that the scan_modifier module must be registered as a plugin in the pyproject.toml file for it to be recognized by the BEC framework and that
+there can only be one scan_modifier plugin registered at a time. If you need to run multiple scan modifiers, you can create a single scan
+modifier plugin that runs multiple actions in sequence with conditional logic to determine which actions to run based on the scan context.
+"""
+
+from bec_server.scan_server.scans.scan_modifier import ScanModifier, scan_hook_impl
+
+
+class DebyeBecScanModifier(ScanModifier):
+    """
+    Scan modifier for debye_bec.
+    
+    By inheriting from the ScanModifier base class, you get access to currently running scan (self.scan), the devices (self.dev), the scan info (self.scan_info),
+    the scan components (self.components) and the scan actions (self.actions).
+    """
+
+    def __init__(self, **kwargs):
+        """Initialize the scan modifier."""
+        super().__init__(**kwargs)
+
+    # Example of running code before the scan stage for a specific scan
+    # @scan_hook_impl("stage", "before")
+    # def before_stage(self):
+    #     """Run before the stage hook."""
+    #     self.actions.send_client_info("Custom stage logic executed by ScanModifier.")
+    #     if self.scan_info.scan_name == "example_scan":
+    #         self.dev.samx.set(20)
+
+    

pyproject.toml

@@ -46,6 +46,9 @@ plugin_file_writer = "debye_bec.file_writer"
 [project.entry-points."bec.scans"]
 plugin_scans = "debye_bec.scans"
 
+[project.entry-points."bec.scans.scan_modifier"]
+plugin_scan_modifier = "debye_bec.scans.scan_customization.scan_modifier"
+
 [project.entry-points."bec.scans.metadata_schema"]
 plugin_metadata_schema = "debye_bec.scans.metadata_schema"