epicsdev 2.1.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

epicsdev/epicsdev.py

@@ -1,7 +1,6 @@
 """Skeleton and helper functions for creating EPICS PVAccess server"""
 # pylint: disable=invalid-name
-__version__= 'v2.1.0 26-01-31'# polling renamed to sleep. Sleep function added.
-#TODO add mandatory PV: host, to identify the server host.
+__version__= 'v2.1.1 26-02-05'# sleep() returns False if a periodic update occurred. Simplified waveform randomization.
 #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.
 
@@ -31,7 +30,7 @@ class C_():
     PVs = {}
     PVDefs = [] 
     serverStateChanged = _serverStateChanged
-    lastCycleTime = time.time()
+    lastCycleTime = timer()
     lastUpdateTime = 0.
     cycleTimeSum = 0.
     cyclesAfterUpdate = 0
@@ -332,13 +331,17 @@ def init_epicsdev(prefix:str, pvDefs:list, verbose=0,
 
 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()
+    and sleeps for the time specified in sleep PV.
+    Returns False if a periodic update occurred.
+    """
+    time.sleep(pvv('sleep'))
+    tnow = timer()
     C_.cycleTimeSum += tnow - C_.lastCycleTime
     C_.lastCycleTime = tnow
     C_.cyclesAfterUpdate += 1
     C_.cycle += 1
     printv(f'cycle {C_.cycle}')
+    sleeping = True
     if tnow - C_.lastUpdateTime > PeriodicUpdateInterval:
         avgCycleTime = C_.cycleTimeSum / C_.cyclesAfterUpdate
         printv(f'Average cycle time: {avgCycleTime:.6f} S.')
@@ -347,7 +350,8 @@ def sleep():
         C_.lastUpdateTime = tnow
         C_.cycleTimeSum = 0.
         C_.cyclesAfterUpdate = 0
-    time.sleep(pvv('sleep'))
+        sleeping = False
+    return sleeping
 
 #``````````````````Demo````````````````````````````````````````````````````````
 if __name__ == "__main__":
@@ -359,20 +363,20 @@ if __name__ == "__main__":
         SET,U,LL,LH = 'setter','units','limitLow','limitHigh'
         alarm = {'valueAlarm':{'lowAlarmLimit':-9., 'highAlarmLimit':9.}}
         return [    # device-specific PVs
-['noiseLevel',  'Noise amplitude',  SPV(1.E-6,'W'), {SET:set_noise, U:'V'}],
+['noiseLevel',  'Noise amplitude',  SPV(1.,'W'), {U:'V'}],
 ['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}],
+['throughput', 'Performance metrics, points per second', SPV(0.), {U:'Mpts/s'}],
 ['c01Offset',   'Offset',  SPV(0.,'W'), {U:'du'}],
-['c01VoltsPerDiv',  'Vertical scale',       SPV(1E-3,'W'), {U:'V/du'}],
+['c01VoltsPerDiv',  'Vertical scale',       SPV(0.1,'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.
     pargs = None
-    rng = np.random.default_rng(nPatterns)
+    rng = np.random.default_rng()
     nPoints = 100
 
     def set_recordLength(value, *_):
@@ -381,18 +385,6 @@ if __name__ == "__main__":
         printi(f'Setting tAxis to {value}')
         publish('tAxis', np.arange(value)*1.E-6)
         publish('recordLength', value)
-        # Re-initialize noise array, because its size depends on recordLength
-        set_noise(pvv('noiseLevel'))
-
-    def set_noise(level, *_):
-        """Noise level have changed. Update noise array."""
-        v = float(level)
-        recordLength = pvv('recordLength')
-        ts = timer()
-        pargs.noise = np.random.normal(scale=0.5*level,
-            size=recordLength+nPatterns)# 45ms/1e6 points
-        printi(f'Noise array[{len(pargs.noise)}] updated with level {v:.4g} V. in {timer()-ts:.4g} S.')
-        publish('noiseLevel', level)
 
     def init(recordLength):
         """Example of device initialization function"""
@@ -401,14 +393,15 @@ if __name__ == "__main__":
 
     def poll():
         """Example of polling function. Called every cycle when server is running."""
-        #pattern = C_.cycle % nPatterns# produces sliding
-        pattern = rng.integers(0, nPatterns)
-        wf = pargs.noise[pattern:pattern+pvv('recordLength')].copy()
+        #ts = timer()
+        wf = rng.random(pvv('recordLength'))*pvv('noiseLevel')# it takes 5ms for 1M points
         wf /= pvv('c01VoltsPerDiv')
         wf += pvv('c01Offset')
+        #print(f'Waveform updated in {timer()-ts:.6g} S.')
         publish('c01Waveform', wf)
         publish('c01Peak2Peak', np.ptp(wf))
         publish('c01Mean', np.mean(wf))
+        #print(f'Polling completed in {timer()-ts:.6g} S.')
 
     # Argument parsing
     parser = argparse.ArgumentParser(description = __doc__,
@@ -449,5 +442,9 @@ if __name__ == "__main__":
             break
         if not state.startswith('Stop'):
             poll()
-        sleep()
+        if not sleep():# Sleep and update performance metrics periodically
+            if not state.startswith('Stop'):
+                pointsPerSecond = len(pvv('c01Waveform'))/(pvv('cycleTime')-pvv('sleep'))/1.E6
+                publish('throughput', round(pointsPerSecond,6))
+                printv(f'periodic update. Performance: {pointsPerSecond:.3g} Mpts/s')
     printi('Server is exited')

epicsdev/multiadc.py

@@ -1,12 +1,11 @@
 """Simulated multi-channel ADC device server using epicsdev module."""
 # pylint: disable=invalid-name
-__version__= 'v2.1.0 26-01-31'# updated for epicsdev v2.1.0
+__version__= 'v2.1.1 26-02-04'# added timing, throughput and c0$VoltOffset PVs
 
 import sys
-import time
 from time import perf_counter as timer
-import numpy as np
 import argparse
+import numpy as np
 
 from .epicsdev import  Server, Context, init_epicsdev, serverState, publish
 from .epicsdev import  pvv, printi, printv, SPV, set_server, sleep
@@ -20,17 +19,20 @@ def myPVDefs():
 ['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'}],
+['noiseLevel',  'Noise amplitude',  SPV(0.05,'W'), {U:'V'}],
 ['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}],
 ['alarm',       'PV with alarm',            SPV(0,'WA'), {U:'du',**alarm}],
+#``````````````````Auxiliary PVs
+['timing',  'Elapsed time for waveform generation, publishing, total]', SPV([0.]), {U:'S'}],
+['throughput', 'Total number of points processed per second', SPV(0.), {U:'Mpts/s'}],
     ]
 
     # Templates for channel-related PVs. Important: SPV cannot be used in this list!
     ChannelTemplates = [
-['c0$VoltsPerDiv',  'Vertical scale',       (1E-3,'W'), {U:'V/du'}],
-#['c0$VoltOffset',  'Vertical offset',       (1E-3,), {U:'V/du'}],
+['c0$VoltsPerDiv',  'Vertical scale',       (0.1,'W'), {U:'V/du'}],
+['c0$VoltOffset',  'Vertical offset',       (0.,'W'), {U:'V'}],
 ['c0$Waveform', 'Waveform array',           ([0.],), {U:'du'}],
 ['c0$Mean',     'Mean of the waveform',     (0.,'A'), {U:'du'}],
 ['c0$Peak2Peak','Peak-to-peak amplitude',   (0.,'A'), {U:'du',**alarm}],
@@ -44,9 +46,11 @@ def myPVDefs():
             pvDefs.append(newpvdef)
     return pvDefs
 
-#``````````````````Module constants
-nPatterns = 100 # number of waveform patterns.
-rng = np.random.default_rng(nPatterns)
+#``````````````````Module attributes
+rng = np.random.default_rng()
+ElapsedTime = {'waveform': 0., 'publish': 0., 'poll': 0.}
+class C_():
+    cyclesSinceUpdate = 0
 
 #``````````````````Setter functions for PVs```````````````````````````````````
 def set_recordLength(value, *_):
@@ -54,18 +58,6 @@ def set_recordLength(value, *_):
     printi(f'Setting tAxis to {value}')
     publish('tAxis', np.arange(value)*1.E-6)
     publish('recordLength', value)
-    # Re-initialize noise array, because its size depends on recordLength
-    set_noise(pvv('noiseLevel'))
-
-def set_noise(level, *_):
-    """Noise level have changed. Update noise array."""
-    v = float(level)
-    recordLength = pvv('recordLength')
-    ts = timer()
-
-    pargs.noise = np.random.normal(scale=0.5*level, size=recordLength+nPatterns)# 45ms/1e6 points
-    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, *_):
     """External control PV have changed. Control the server accordingly."""
@@ -94,21 +86,43 @@ def serverStateChanged(newState:str):
 def init(recordLength):
     """Device initialization function"""
     set_recordLength(recordLength)
+    # Set offset of each channel = channel index
+    for ch in range(pargs.channels):
+        publish(f'c{ch+1:02}VoltOffset', ch)
     #set_externalControl(pargs.prefix + pargs.external)
+    publish('sleep', pargs.sleep)
 
 def poll():
     """Device polling function, called every cycle when server is running"""
+    C_.cyclesSinceUpdate += 1
+    ts0 = timer()
     for ch in range(pargs.channels):
-        pattern = rng.integers(0, nPatterns)
+        ts1 = timer()
         chstr = f'c{ch+1:02}'
-        wf = pargs.noise[pattern:pattern+pvv('recordLength')].copy()
-        #print(f'ch{ch}, {pattern}: {wf[0], wf.sum(), wf.mean(), np.mean(wf)}')
-        wf /= pvv(f'{chstr}VoltsPerDiv')
-        #wf += pvv(f'{chstr}Offset')
-        wf += ch
-        publish(f'{chstr}Waveform', list(wf))
+        rwf = rng.random(pvv('recordLength'))*pvv('noiseLevel')
+        wf = rwf/pvv(f'{chstr}VoltsPerDiv') + pvv(f'{chstr}VoltOffset')# the time is comparable with rng.random
+        ts2 = timer()
+        ElapsedTime['waveform'] += ts2 - ts1
+        #print(f'ElapsedTime: {C_.cyclesSinceUpdate, ElapsedTime["waveform"]}')
+        publish(f'{chstr}Waveform', wf)
         publish(f'{chstr}Peak2Peak', np.ptp(wf))
         publish(f'{chstr}Mean', np.mean(wf))
+        ElapsedTime['publish'] += timer() - ts2
+    ElapsedTime['poll'] += timer() - ts0
+
+def periodic_update():
+    """Perform periodic update"""
+    #printi(f'periodic update for {C_.cyclesSinceUpdate} cycles: {ElapsedTime}')
+    times = [(round(i/C_.cyclesSinceUpdate,6)) for i in ElapsedTime.values()]
+    publish('timing', times)
+    C_.cyclesSinceUpdate = 0
+    for key in ElapsedTime:
+        ElapsedTime[key] = 0.
+    pointsPerSecond = len(pvv('tAxis'))/(pvv('cycleTime')-pvv('sleep'))/1.E6
+    pointsPerSecond *= pvv('channels')
+    publish('throughput', round(pointsPerSecond,6))
+    printv(f'periodic update. Performance: {pointsPerSecond:.3g} Mpts/s')
+
 
 # Argument parsing
 parser = argparse.ArgumentParser(description = __doc__,
@@ -127,6 +141,8 @@ parser.add_argument('-i', '--index', default='0', help=
 # The rest of arguments are not essential, they can be changed at runtime using PVs.
 parser.add_argument('-n', '--npoints', type=int, default=100, help=
 'Number of points in the waveform')
+parser.add_argument('-s', '--sleep', type=float, default=1.0, help=
+'Sleep time per cycle')
 parser.add_argument('-v', '--verbose', action='count', default=0, help=
 'Show more log messages (-vv: show even more)') 
 pargs = parser.parse_args()
@@ -136,10 +152,6 @@ print(f'pargs: {pargs}')
 pargs.prefix = f'{pargs.device}{pargs.index}:'
 PVs = init_epicsdev(pargs.prefix, myPVDefs(), pargs.verbose,
                     serverStateChanged, pargs.list)
-# if pargs.list != '':
-#     print('List of PVs:')
-#     for _pvname in PVs:
-#         print(_pvname)
 
 # Initialize the device, using pargs if needed. 
 # That can be used to set the number of points in the waveform, for example.
@@ -150,12 +162,13 @@ set_server('Start')
 
 #``````````````````Main loop``````````````````````````````````````````````````
 server = Server(providers=[PVs])
-printi(f'Server started. Sleeping per cycle: {repr(pvv("sleep"))} S.')
+printi(f'Server started. Sleeping per cycle: {float(pvv("sleep")):.3f} S.')
 while True:
     state = serverState()
     if state.startswith('Exit'):
         break
     if not state.startswith('Stop'):
         poll()
-    sleep()
-printi('Server is exited')
+    if not sleep():
+        periodic_update()
+printi('Server has exited')

{epicsdev-2.1.0.dist-info → epicsdev-2.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: epicsdev
-Version: 2.1.0
+Version: 2.1.1
 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
@@ -30,10 +30,10 @@ python -m pypeto -c config -f epicsdev
 
 ## Multi-channel waveform generator
 Module **epicdev.multiadc** can generate large amount of data for stress-testing
-the EPICS environment. For example the following command will generate 100 of 
-1000-pont noisy waveforms and 300 of scalar parameters.
+the EPICS environment. For example the following command will generate 10000 of 
+100-pont noisy waveforms and 40000 of scalar parameters per second.
 ```
-python -m epicsdev.multiadc -c100 -n1000
+python -m epicsdev.multiadc -s0.1 -c10000 -n100
 ```
 The GUI for monitoring:<br>
 ```python -m pypeto -c config -f multiadc```
@@ -42,4 +42,4 @@ The graphs should look like this:
 [control page](docs/epicsdev_pypet.png),
 [plots](docs/epicsdev_pvplot.jpg).
 
-
+Example of [Phoebus display](docs/phoebus_epicsdev.jpg), as defined in config/epicsdev.bob.

epicsdev-2.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+epicsdev/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+epicsdev/epicsdev.py,sha256=dVPuuQ0xXF8ibw28DpvxQfkG_9k7WubNp_9rWXRvTVw,17970
+epicsdev/multiadc.py,sha256=2sg_VmIfylG5XHJzx5bgi_Bb9VPiX2TtyI-8JuAiBmQ,7219
+epicsdev-2.1.1.dist-info/METADATA,sha256=2tMnntNmRcksDUO0fAH9PCrmICCWS4ad7GRcGwnnAtc,1382
+epicsdev-2.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+epicsdev-2.1.1.dist-info/licenses/LICENSE,sha256=qj3cUKUrX4oXTb0NwuJQ44ThYDEMUfOeIjw9kkT6Qck,1072
+epicsdev-2.1.1.dist-info/RECORD,,

epicsdev-2.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-epicsdev/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-epicsdev/epicsdev.py,sha256=aOiVWY8sIrEGqxHJ9niyRtGl3z2Qg0ep5MFbnZskWxg,18017
-epicsdev/multiadc.py,sha256=ZVsA1wzl4GfOepC_zQdjisNKQFcpJuEMV6vt1y3zBnw,6520
-epicsdev-2.1.0.dist-info/METADATA,sha256=8bFFHdc7SnDooPlzHZsnzYAy9QnpqkYoZX7VGmVtfrE,1270
-epicsdev-2.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-epicsdev-2.1.0.dist-info/licenses/LICENSE,sha256=qj3cUKUrX4oXTb0NwuJQ44ThYDEMUfOeIjw9kkT6Qck,1072
-epicsdev-2.1.0.dist-info/RECORD,,