Update ZMQ Message Reference

2026-08-14 11:38:27 +02:00
parent cec343977c
commit 548aa2ab23
1 changed files with 17 additions and 2 deletions
@@ -422,11 +422,26 @@ Example message:
 mesg = ['loadFile file',
 '{
 "file":"/home/control/LocalData/2026-08-14/discard/Sample_Image_2026-08-14_002.hdf5"
-,"mode":"previous"
-,"pluginNumber":0
+,"mode":"next"
+,"pluginNumber":4948
 }']
 ```

+Example response where the "pluginNumber" of 4948 is included in the message header:
+```
+['scanFileContent4948',
+{'directory': '/home/control/LocalData/2026-08-14'
+,'filename': 'Sample_Image_2026-08-14_003.hdf5'
+,'regionProfiles': {'coordType': 'without_offset', 'displayedAxes': {'displayedAxisX': {'index': 1, 'name': 'sample_x', 'region': 'inner'}, 'displayedAxisY': {'index': 0, 'name': 'sample_y', 'region': 'inner'}}, 'maxX': 55.0, 'maxY': 55.0, 'minStepX': 10.0, 'minStepY': 10.0, 'minX': 5.0, 'minY': 5.0, 'regionProfiles': [{'axes': [{'max': 55.0, 'min': 5.0, 'minimalStep': 10.0, 'numPts': 5, 'segments': [{'end': 55.0, 'indexOffset': 0, 'max': 55.0, 'maxPoint': 50.0, 'min': 5.0, 'minPoint': 10.0, 'numPts': 5, 'start': 5.0, 'step': 10.0}]}, {'max': 55.0, 'min': 5.0, 'minimalStep': 10.0, 'numPts': 5, 'segments': [{'end': 55.0, 'indexOffset': 0, 'max': 55.0, 'maxPoint': 50.0, 'min': 5.0, 'minPoint': 10.0, 'numPts': 5, 'start': 5.0, 'step': 10.0}]}]}]}
+,'scanData': {'cntChannel': 1, 'cntOuterRegion': 1, 'cntPolarization': 1, 'polarizations': [{'outerRegions': [{'scanDataRegionVec': [{'axesDims': [5, 5], 'channels': {'channelData': [[969.0, 381.0, 770.0, 278.0, 277.0, 61.0, 330.0, 529.0, 925.0, 138.0, 422.0, 967.0, 969.0, 854.0, 203.0, 113.0, 190.0, 103.0, 400.0, 483.0, 589.0, 76.0, 756.0, 17.0, 230.0]]}}]}]}], 'regionDims': [[5, 5]]}
+,'scanRequest': '{"scanType": "Sample", "outerRegions": [{"dwellTime": 0.001, "axes": [{"nPoints": 3, "trajectories": [{"start": 300.0, "end": 301.0, "range": 1.0, "step": 0.5, "positionerName": "Energy"}]}]}, {"dwellTime": 0.001, "axes": [{"nPoints": 5, "trajectories": [{"start": 302.0, "end": 306.0, "range": 4.0, "step": 1.0, "positionerName": "Energy"}]}]}], "innerRegions": [{"axes": [{"nPoints": 5, "trajectories": [{"center": 30.0, "range": 50.0, "step": 10.0, "positionerName": "CoarseY"}]}, {"nPoints": 5, "trajectories": [{"center": 30.0, "range": 50.0, "step": 10.0, "positionerName": "CoarseX"}]}]}], "spatialType": "Image", "lineMode": "Point by Point", "meander": 0, "yAxisFast": 0, "tiling": 0, "accelerationDistance": 1.0, "tileDelay": 0.01, "lineDelay": 0.001, "pointDelay": 0.0, "lineRepetition": 1, "nOuterRegions": 2, "nInnerRegions": 1, "singleOuterRegionValue": true, "displayedAxes": {"x": {"region": "inner", "index": 1}, "y": {"region": "inner", "index": 0}}}'
+,'scanType': 'Sample'
+,'scanTypeArchive': 'archive'
+,'signalList': ['Counter1']}
+]
+```
+
+
 ## 'loadDefinition'

 ## 'change user'