diff --git a/ZMQ-Message-Reference.md b/ZMQ-Message-Reference.md index fd3ba3e..2926555 100644 --- a/ZMQ-Message-Reference.md +++ b/ZMQ-Message-Reference.md @@ -80,7 +80,7 @@ Reply Messages: Data is a JSON scan request. For example: ``` - msg = ['estimatedTime', Scan_Request ] + msg = ['estimatedTime', "{'scanType': 'Sample', 'spatialType': 'Image', 'meander': 1, 'tiling': 1, 'yAxisFast': 0, 'lineMode': 'Constant Velocity', 'accelerationDistance': 0.5, 'tileDelay': 0.05, 'lineDelay': 0.05, 'outerRegions': [{'dwellTime': 0.005, 'axes': [{'nPoints': 2, 'trajectories': [{'start': 900.0, 'end': 320.0, 'range': -580.0, 'step': -580.0, 'positionerName': 'Energy'}]}]}], 'innerRegions': [{'axes': [{'nPoints': 1200, 'trajectories': [{'center': 4282.670215322501, 'range': 12.0, 'step': 0.01, 'positionerName': 'FineY'}]}, {'nPoints': 140, 'trajectories': [{'center': 37.8280758446287, 'range': 28.0, 'step': 0.2, 'positionerName': 'FineX'}]}]}, {'axes': [{'nPoints': 10, 'trajectories': [{'center': 5571.33258869908, 'range': 1.0, 'step': 0.1, 'positionerName': 'FineY'}]}, {'nPoints': 10, 'trajectories': [{'center': -5400.94023907363, 'range': 1.0, 'step': 0.1, 'positionerName': 'FineX'}]}]}], 'nOuterRegions': 1, 'nInnerRegions': 1, 'singleOuterRegionValue': 1, 'displayedAxes': {'x': {'region': 'inner', 'index': 1}, 'y': {'region': 'inner', 'index': 0}}, 'positionPrecision': {'precision': 200.0}, 'defocus': {'diameter': 0.0}}" ] ``` Reply Messages: @@ -88,12 +88,45 @@ Reply Messages: ## 'abortScan' +Message only needs the header, no data required. For example: +``` + msg = ['abortScan' ] +``` + +Reply Messages: +- `["status","ok"]` + ## 'pauseScan' +Message only needs the header, no data required. For example: +``` + msg = ['pauseScan' ] +``` + +Reply Messages: +- `["status","ok"]` + ## 'resumeScan' +Message only needs the header, no data required. For example: +``` + msg = ['resumeScan' ] +``` + +Reply Messages: +- `["status","ok"]` + ## 'scanStatus' +Message only needs the header, no data required. For example: +``` + msg = ['scanStatus' ] +``` + +Reply Messages: +- `["status","ok"]` +- `["scanStatus", JSON_array]` detailing the current line and pixel, etc. + ## 'moveRequest' ## 'moveStatus'