epicsdev 2.0.1__tar.gz → 2.1.0__tar.gz

{epicsdev-2.0.1 → epicsdev-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epicsdev
-Version: 2.0.1
+Version: 2.1.0
 Summary: Helper module for creating EPICS PVAccess servers using p4p
 Project-URL: Homepage, https://github.com/ASukhanov/epicsdev
 Project-URL: Bug Tracker, https://github.com/ASukhanov/epicsdev

epicsdev-2.0.1/config/multiadc_pp.py → epicsdev-2.1.0/config/epicsdev_pp.py

@@ -1,7 +1,10 @@
-"""Pypet page for epicdev.multiadc module"""
-# format: pypeto 1.2+
-__version__ = 'v0.0.1 2026-01-23'#
-print(f'epicsScope {__version__}')
+"""Pypet page for epicdev.epicsdev.
+Device instance is configured via environment variable EPICSDEV,
+default instance is epicsdev0:."""
+# pylint: disable=invalid-name
+__version__ = 'v0.1.0 2026-01-31'#
+
+import os
 
 #``````````````````Definitions````````````````````````````````````````````````
 # python expressions and functions, used in the spreadsheet
@@ -18,28 +21,27 @@ LargeFont = {'color':'light gray', **font(18), 'fgColor':'dark green'}
 ButtonFont = {'font':['Open Sans Extrabold',14]}# Comic Sans MS
 LYRow = {'ATTRIBUTES':{'color':'light yellow'}}
 lColor = color('lightGreen')
-
-# definition for plotting cell
 PyPath = 'python -m'
-PaneP2P = ' '.join([f'c{i+1:02d}Mean c{i+1:02d}Peak2Peak' for i in range(1)])
-PaneWF = ' '.join([f'c{i+1:02d}Waveform' for i in range(1)])
-#PaneT = 'timing[1] timing[3]'
-Plot = {'Plot':{'launch':
-  f'{PyPath} pvplot Y-5:5 -aV:multiadc0: -#0"{PaneP2P}" -#1"{PaneWF}"',# -#2"{PaneT}"',
-  **lColor, **ButtonFont}}
-print(f'Plot command: {Plot}')
+
+try:
+    Instance = f"epicsDev{os.environ['EPICSDEV']}:"
+except KeyError:
+    Instance = 'epicsDev0:'
+
 #``````````````````PyPage Object``````````````````````````````````````````````
 class PyPage():
-    def __init__(self, instance='multiadc0:',
-            title="Simulated oscilloscope", channels=6):
+    def __init__(self, instance=None,
+            title="epicsdev", channels=1):
         """instance: unique name of the page.
         For EPICS it is usually device prefix 
         """
+        if instance is None:
+            instance = Instance
         print(f'Instantiating Page {instance,title} with {channels} channels')
 
         #``````````Mandatory class members starts here````````````````````````
         self.namespace = 'PVA'
-        self.title = title
+        self.title = instance[:-1]
 
         #``````````Page attributes, optional`````````````````````````
         self.page = {**color(240,240,240)}
@@ -70,18 +72,22 @@ string or device:parameter and the value is dictionary of the features.
         #``````````Abbreviations, used in cell definitions
         def ChLine(suffix):
             return [f'{D}c{ch+1:02d}{suffix}' for ch in range(channels)]
-        #FOption = ' -file '+logreqMap.get(D,'')
+        PaneP2P = ' '.join([f'c{i+1:02d}Mean c{i+1:02d}Peak2Peak' for i in range(channels)])
+        PaneWF = ' '.join([f'c{i+1:02d}Waveform' for i in range(channels)])
+        #PaneT = 'timing[1] timing[3]'
+        Plot = {'Plot':{'launch':
+          f'{PyPath} pvplot Y-5:5 -aV:{instance} -#0"{PaneP2P}" -#1"{PaneWF}"',# -#2"{PaneT}"',
+          **lColor, **ButtonFont}}
+        print(f'Plot command: {Plot}')
         #``````````mandatory member```````````````````````````````````````````
         self.rows = [
-['Device:', D, {D+'version':span(2,1)},_, 'host:', D+'host',_],
-['State:', D+'server','cycle:', D+'cycle',_,_,Plot], # 'Recall:', D+'setup',],
+['Device:',D, D+'server', D+'version', 'host:',D+'host',_],
 ['Status:', {D+'status': span(8,1)}],
-['Polling Interval:', D+'polling', 'nPoints:', D+'recordLength',
-	'Noise:', D+'noiseLevel',_],
+['Cycle time:',D+'cycleTime', 'Sleep:',D+'sleep', 'Cycle:',D+'cycle', Plot],
+['nPoints:',D+'recordLength','Noise:',D+'noiseLevel',_,_,_],
 [{'ATTRIBUTES':{**color('lightCyan'),**just(1)}},
-	'Channels:','CH1','CH2','CH3','CH4','CH5','CH6'],
+	'Channels:', 'CH1', 'CH2', 'CH3', 'CH4', 'CH5', 'CH6'],
 ['V/div:']+ChLine('VoltsPerDiv'),
 ['Mean:']+ChLine('Mean'),
 ['Peak2Peak:']+ChLine('Peak2Peak'),
-#['Waveform:']+ChLine('Waveform'),
         ]

epicsdev-2.1.0/config/multiadc1_pp.py

@@ -0,0 +1,6 @@
+"""Pypet definition for device multiadc1"""
+import multiadc_pp as module
+
+def PyPage(**_):
+    return  module.PyPage(instance='multiadc1:', title='multiadc1',
+        channels=6)

epicsdev-2.0.1/config/epicsdev_pp.py → epicsdev-2.1.0/config/multiadc_pp.py

@@ -1,7 +1,10 @@
-"""Pypet page for epicdev.epicsdev module"""
-# format: pypeto 1.2+
-__version__ = 'v0.0.1 2026-01-16'# 
-print(f'epicsScope {__version__}')
+"""Pypet page for epicdev.multiadc, simulated multi-channel ADC device server.
+Device instance is configured via environment variable MULTIADC,
+default instance is multiadc0:."""
+# pylint: disable=invalid-name
+__version__ = 'v0.1.0 2026-01-31'#
+
+import os
 
 #``````````````````Definitions````````````````````````````````````````````````
 # python expressions and functions, used in the spreadsheet
@@ -18,28 +21,27 @@ LargeFont = {'color':'light gray', **font(18), 'fgColor':'dark green'}
 ButtonFont = {'font':['Open Sans Extrabold',14]}# Comic Sans MS
 LYRow = {'ATTRIBUTES':{'color':'light yellow'}}
 lColor = color('lightGreen')
-
-# definition for plotting cell
 PyPath = 'python -m'
-PaneP2P = ' '.join([f'ch{i+1:01d}Mean ch{i+1:01d}Peak2Peak' for i in range(1)])
-PaneWF = ' '.join([f'ch{i+1:01d}Waveform' for i in range(1)])
-#PaneT = 'timing[1] timing[3]'
-Plot = {'Plot':{'launch':
-  f'{PyPath} pvplot Y-5:5 -aV:epicsDev0: -#0"{PaneP2P}" -#1"{PaneWF}"',# -#2"{PaneT}"',
-  **lColor, **ButtonFont}}
-print(f'Plot command: {Plot}')
-#``````````````````PyPage Object``````````````````````````````````````````````
+
+try:
+    Instance = f"multiadc{os.environ['EPICSDEV_MULTIADC']}:"
+except KeyError:
+    Instance = 'multiadc0:'
+
+#``````````````````Mandatory object PyPage````````````````````````````````````
 class PyPage():
-    def __init__(self, instance='epicsDev0:',
-            title="Simulated oscilloscope", channels=1):
+    def __init__(self, instance=None,
+            title=None, channels=6):
         """instance: unique name of the page.
         For EPICS it is usually device prefix 
         """
+        if instance is None:
+            instance = Instance
         print(f'Instantiating Page {instance,title} with {channels} channels')
 
         #``````````Mandatory class members starts here````````````````````````
         self.namespace = 'PVA'
-        self.title = title
+        self.title = title if title is not None else instance[:-1]
 
         #``````````Page attributes, optional`````````````````````````
         self.page = {**color(240,240,240)}
@@ -69,18 +71,24 @@ string or device:parameter and the value is dictionary of the features.
 
         #``````````Abbreviations, used in cell definitions
         def ChLine(suffix):
-            return [f'{D}ch{ch+1:01d}{suffix}' for ch in range(channels)]
-        #FOption = ' -file '+logreqMap.get(D,'')
+            return [f'{D}c{ch+1:02d}{suffix}' for ch in range(channels)]
+        PaneP2P = ' '.join([f'c{i+1:02d}Mean c{i+1:02d}Peak2Peak' for i in range(channels)])
+        PaneWF = ' '.join([f'c{i+1:02d}Waveform' for i in range(channels)])
+        #PaneT = 'timing[1] timing[3]'
+        Plot = {'Plot':{'launch':
+          f'{PyPath} pvplot Y-5:5 -aV:{instance} -#0"{PaneP2P}" -#1"{PaneWF}"',# -#2"{PaneT}"',
+          **lColor, **ButtonFont}}
+        print(f'Plot command: {Plot}')
         #``````````mandatory member```````````````````````````````````````````
         self.rows = [
-['Device:', D, {D+'version':span(2,1)},_, 'host:', D+'host',_],
-['State:', D+'server', 'cycle:', D+'cycle',_,_, Plot], # 'Recall:', D+'setup',],
+['Device:',D, D+'server', D+'version', 'host:',D+'host',_],
 ['Status:', {D+'status': span(8,1)}],
-['Polling Interval:', D+'polling', 'nPoints:', D+'recordLength',
-	'Noise:', D+'noiseLevel',_],
+['Cycle time:',D+'cycleTime', 'Sleep:',D+'sleep', 'Cycle:',D+'cycle', Plot],
+['nPoints:',D+'recordLength','Noise:',D+'noiseLevel', 'Channels:',D+'channels',_],
 [{'ATTRIBUTES':{**color('lightCyan'),**just(1)}},
-	'Channels:', 'CH1', 'CH2', 'CH3', 'CH4', 'CH5', 'CH6'],
+    'Channels:','CH1','CH2','CH3','CH4','CH5','CH6'],
 ['V/div:']+ChLine('VoltsPerDiv'),
 ['Mean:']+ChLine('Mean'),
 ['Peak2Peak:']+ChLine('Peak2Peak'),
+#['Waveform:']+ChLine('Waveform'),
         ]

{epicsdev-2.0.1 → epicsdev-2.1.0}/epicsdev/epicsdev.py

@@ -1,12 +1,13 @@
 """Skeleton and helper functions for creating EPICS PVAccess server"""
 # pylint: disable=invalid-name
-__version__= 'v2.0.1 26-01-30'# added mandatory host PV
+__version__= 'v2.1.0 26-01-31'# polling renamed to sleep. Sleep function added.
 #TODO add mandatory PV: host, to identify the server host.
 #Issue: There is no way in PVAccess to specify if string PV is writable.
 # As a workaround we append description with suffix ' Features: W' to indicate that.
 
 import sys
-from time import time, sleep, strftime, perf_counter as timer
+import time
+from time import perf_counter as timer
 import os
 from socket import gethostname
 from p4p.nt import NTScalar, NTEnum
@@ -15,6 +16,8 @@ from p4p.server import Server
 from p4p.server.thread import SharedPV
 from p4p.client.thread import Context
 
+PeriodicUpdateInterval = 10. # seconds
+
 #``````````````````Module Storage`````````````````````````````````````````````
 def _serverStateChanged(newState:str):
     """Dummy serverStateChanged function"""
@@ -28,6 +31,10 @@ class C_():
     PVs = {}
     PVDefs = [] 
     serverStateChanged = _serverStateChanged
+    lastCycleTime = time.time()
+    lastUpdateTime = 0.
+    cycleTimeSum = 0.
+    cyclesAfterUpdate = 0
 
 #```````````````````Helper methods````````````````````````````````````````````
 def serverState():
@@ -35,7 +42,7 @@ def serverState():
     cached in C_ to avoid unnecessary get() calls."""
     return C_.serverState
 def _printTime():
-    return strftime("%m%d:%H%M%S")
+    return time.strftime("%m%d:%H%M%S")
 def printi(msg):
     """Print info message and publish it to status PV."""
     print(f'inf_@{_printTime()}: {msg}')
@@ -81,7 +88,7 @@ def publish(pvName:str, value, ifChanged=False, t=None):
         print(f'WARNING: PV {pvName} not found. Cannot publish value.')
         return
     if t is None:
-        t = time()
+        t = time.time()
     if not ifChanged or pv.current() != value:
         pv.post(value, timestamp=t)
 
@@ -127,7 +134,7 @@ def SPV(initial, meta='', vtype=None):
 
 #``````````````````create_PVs()```````````````````````````````````````````````
 def _create_PVs(pvDefs):
-    ts = time()
+    ts = time.time()
     for defs in pvDefs:
         try:
             pname,desc,spv,extra = defs
@@ -174,7 +181,7 @@ def _create_PVs(pvDefs):
         if spv.writable:
             @spv.put
             def handle(spv, op):
-                ct = time()
+                ct = time.time()
                 vv = op.value()
                 vr = vv.raw.value
                 current = spv._wrap(spv.current())
@@ -259,8 +266,12 @@ def create_PVs(pvDefs=None):
         {'setter':set_server}],
 ['verbose', 'Debugging verbosity', SPV(C_.verbose,'W','u8'),
         {'setter':set_verbose, LL:0,LH:3}],
-['polling', 'Polling interval', SPV(1.0,'W'), {U:'S', LL:0.001, LH:10.1}],
-['cycle',   'Cycle number',         SPV(0,'','u32'), {}],
+['sleep', 'Pause in the main loop, it could be useful for throttling the data output',
+    SPV(1.0,'W'), {U:'S', LL:0.001, LH:10.1}],
+['cycle',   'Cycle number, published every {PeriodicUpdateInterval} S.',
+    SPV(0,'','u32'), {}],
+['cycleTime','Average cycle time including sleep, published every {PeriodicUpdateInterval} S',
+    SPV(0.), {U:'S'}],
     ]
     # append application's PVs, defined in the pvDefs and create map of
     #  providers
@@ -301,7 +312,8 @@ def init_epicsdev(prefix:str, pvDefs:list, verbose=0,
         host = repr(get_externalPV(prefix+'host')).replace("'",'')
         print(f'ERROR: Server for {prefix} already running at {host}. Exiting.')
         sys.exit(1)
-    except TimeoutError:    pass
+    except TimeoutError:
+        pass
 
     # No existing server found. Creating PVs.
     pvs = create_PVs(pvDefs)
@@ -315,8 +327,28 @@ def init_epicsdev(prefix:str, pvDefs:list, verbose=0,
         with open(filepath, 'w', encoding="utf-8") as f:
             for _pvname in pvs:
                 f.write(_pvname + '\n')
+    printi(f'Hosting {len(pvs)} PVs')
     return pvs
 
+def sleep():
+    """Sleep function to be called in the main loop. It updates cycleTime PV
+    and sleeps for the time specified in sleep PV."""
+    tnow = time.time()
+    C_.cycleTimeSum += tnow - C_.lastCycleTime
+    C_.lastCycleTime = tnow
+    C_.cyclesAfterUpdate += 1
+    C_.cycle += 1
+    printv(f'cycle {C_.cycle}')
+    if tnow - C_.lastUpdateTime > PeriodicUpdateInterval:
+        avgCycleTime = C_.cycleTimeSum / C_.cyclesAfterUpdate
+        printv(f'Average cycle time: {avgCycleTime:.6f} S.')
+        publish('cycle', C_.cycle)
+        publish('cycleTime', avgCycleTime)
+        C_.lastUpdateTime = tnow
+        C_.cycleTimeSum = 0.
+        C_.cyclesAfterUpdate = 0
+    time.sleep(pvv('sleep'))
+
 #``````````````````Demo````````````````````````````````````````````````````````
 if __name__ == "__main__":
     import numpy as np
@@ -331,11 +363,11 @@ if __name__ == "__main__":
 ['tAxis',       'Full scale of horizontal axis', SPV([0.]), {U:'S'}],
 ['recordLength','Max number of points',     SPV(100,'W','u32'),
     {LL:4,LH:1000000, SET:set_recordLength}],
-['ch1Offset',   'Offset',  SPV(0.,'W'), {U:'du'}],
-['ch1VoltsPerDiv',  'Vertical scale',       SPV(1E-3,'W'), {U:'V/du'}],
-['ch1Waveform', 'Waveform array',           SPV([0.]), {U:'du'}],
-['ch1Mean',     'Mean of the waveform',     SPV(0.,'A'), {U:'du'}],
-['ch1Peak2Peak','Peak-to-peak amplitude',   SPV(0.,'A'), {U:'du',**alarm}],
+['c01Offset',   'Offset',  SPV(0.,'W'), {U:'du'}],
+['c01VoltsPerDiv',  'Vertical scale',       SPV(1E-3,'W'), {U:'V/du'}],
+['c01Waveform', 'Waveform array',           SPV([0.]), {U:'du'}],
+['c01Mean',     'Mean of the waveform',     SPV(0.,'A'), {U:'du'}],
+['c01Peak2Peak','Peak-to-peak amplitude',   SPV(0.,'A'), {U:'du',**alarm}],
 ['alarm',       'PV with alarm',            SPV(0,'WA'), {U:'du',**alarm}],
         ]
     nPatterns = 100 # number of waveform patterns.
@@ -363,23 +395,20 @@ if __name__ == "__main__":
         publish('noiseLevel', level)
 
     def init(recordLength):
-        """Testing function. Do not use in production code."""
+        """Example of device initialization function"""
         set_recordLength(recordLength)
         #set_noise(pvv('noiseLevel')) # already called from set_recordLength
 
     def poll():
-        """Example of polling function"""
+        """Example of polling function. Called every cycle when server is running."""
         #pattern = C_.cycle % nPatterns# produces sliding
         pattern = rng.integers(0, nPatterns)
-        cycle = pvv('cycle')
-        printv(f'cycle {repr(cycle)}')
-        publish('cycle', cycle + 1)
         wf = pargs.noise[pattern:pattern+pvv('recordLength')].copy()
-        wf /= pvv('ch1VoltsPerDiv')
-        wf += pvv('ch1Offset')
-        publish('ch1Waveform', wf)
-        publish('ch1Peak2Peak', np.ptp(wf))
-        publish('ch1Mean', np.mean(wf))
+        wf /= pvv('c01VoltsPerDiv')
+        wf += pvv('c01Offset')
+        publish('c01Waveform', wf)
+        publish('c01Peak2Peak', np.ptp(wf))
+        publish('c01Mean', np.mean(wf))
 
     # Argument parsing
     parser = argparse.ArgumentParser(description = __doc__,
@@ -389,7 +418,7 @@ if __name__ == "__main__":
 'Device name, the PV name will be <device><index>:')
     parser.add_argument('-i', '--index', default='0', help=
 'Device index, the PV name will be <device><index>:') 
-    parser.add_argument('-l', '--list', default='', nargs='?', help=(
+    parser.add_argument('-l', '--list', nargs='?', help=(
 'Directory to save list of all generated PVs, if no directory is given, '
 'then </tmp/pvlist/><prefix> is assumed.'))
     # The rest of options are not essential, they can be controlled at runtime using PVs.
@@ -413,12 +442,12 @@ if __name__ == "__main__":
 
     # Main loop
     server = Server(providers=[PVs])
-    printi(f'Server started with polling interval {repr(pvv("polling"))} S.')
+    printi(f'Server started. Sleeping per cycle: {repr(pvv("sleep"))} S.')
     while True:
         state = serverState()
         if state.startswith('Exit'):
             break
         if not state.startswith('Stop'):
             poll()
-        sleep(pvv("polling"))
+        sleep()
     printi('Server is exited')

{epicsdev-2.0.1 → epicsdev-2.1.0}/epicsdev/multiadc.py

@@ -1,6 +1,6 @@
 """Simulated multi-channel ADC device server using epicsdev module."""
 # pylint: disable=invalid-name
-__version__= 'v0.0.2 26-01-23'# refactored, adjusted for epicdev 2.0.1
+__version__= 'v2.1.0 26-01-31'# updated for epicsdev v2.1.0
 
 import sys
 import time
@@ -9,7 +9,7 @@ import numpy as np
 import argparse
 
 from .epicsdev import  Server, Context, init_epicsdev, serverState, publish
-from .epicsdev import  pvv, printi, printv, SPV, set_server
+from .epicsdev import  pvv, printi, printv, SPV, set_server, sleep
 
 
 def myPVDefs():
@@ -17,6 +17,7 @@ def myPVDefs():
     SET,U,LL,LH = 'setter','units','limitLow','limitHigh'
     alarm = {'valueAlarm':{'lowAlarmLimit':-9., 'highAlarmLimit':9.}}
     pvDefs = [    # device-specific PVs
+['channels',    'Number of device channels',    SPV(pargs.channels), {}],
 ['externalControl', 'Name of external PV, which controls the server',
     SPV('Start Stop Clear Exit Started Stopped Exited'.split(), 'WD'), {}], 
 ['noiseLevel',  'Noise amplitude',  SPV(1.E-4,'W'), {SET:set_noise, U:'V'}],
@@ -48,7 +49,7 @@ nPatterns = 100 # number of waveform patterns.
 rng = np.random.default_rng(nPatterns)
 
 #``````````````````Setter functions for PVs```````````````````````````````````
-def set_recordLength(value):
+def set_recordLength(value, *_):
     """Record length have changed. The tAxis should be updated accordingly."""
     printi(f'Setting tAxis to {value}')
     publish('tAxis', np.arange(value)*1.E-6)
@@ -56,7 +57,7 @@ def set_recordLength(value):
     # Re-initialize noise array, because its size depends on recordLength
     set_noise(pvv('noiseLevel'))
 
-def set_noise(level):
+def set_noise(level, *_):
     """Noise level have changed. Update noise array."""
     v = float(level)
     recordLength = pvv('recordLength')
@@ -66,7 +67,7 @@ def set_noise(level):
     printi(f'Noise array[{len(pargs.noise)}] updated with level {v:.4g} V. in {timer()-ts:.4g} S.')
     publish('noiseLevel', level)
 
-def set_externalControl(value):
+def set_externalControl(value, *_):
     """External control PV have changed. Control the server accordingly."""
     pvname = str(value)
     if pvname in (None,'0'):
@@ -91,16 +92,12 @@ def serverStateChanged(newState:str):
         publish('cycle', 0)
 
 def init(recordLength):
-    """Testing function. Do not use in production code."""
+    """Device initialization function"""
     set_recordLength(recordLength)
     #set_externalControl(pargs.prefix + pargs.external)
 
 def poll():
-    """Example of polling function"""
-    #pattern = C_.cycle % nPatterns# produces sliding
-    cycle = pvv('cycle')
-    printv(f'cycle {repr(cycle)}')
-    publish('cycle', cycle + 1)
+    """Device polling function, called every cycle when server is running"""
     for ch in range(pargs.channels):
         pattern = rng.integers(0, nPatterns)
         chstr = f'c{ch+1:02}'
@@ -143,7 +140,6 @@ PVs = init_epicsdev(pargs.prefix, myPVDefs(), pargs.verbose,
 #     print('List of PVs:')
 #     for _pvname in PVs:
 #         print(_pvname)
-printi(f'Hosting {len(PVs)} PVs')
 
 # Initialize the device, using pargs if needed. 
 # That can be used to set the number of points in the waveform, for example.
@@ -154,12 +150,12 @@ set_server('Start')
 
 #``````````````````Main loop``````````````````````````````````````````````````
 server = Server(providers=[PVs])
-printi(f'Server started with polling interval {repr(pvv("polling"))} S.')
+printi(f'Server started. Sleeping per cycle: {repr(pvv("sleep"))} S.')
 while True:
     state = serverState()
     if state.startswith('Exit'):
         break
     if not state.startswith('Stop'):
         poll()
-    time.sleep(pvv("polling"))
+    sleep()
 printi('Server is exited')

{epicsdev-2.0.1 → epicsdev-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "epicsdev"
-version = "2.0.1"
+version = "2.1.0"
 authors = [
   { name="Andrey Sukhanov", email="sukhanov@bnl.gov" },
 ]