diff --git a/ZMQ-Message-Reference.md b/ZMQ-Message-Reference.md new file mode 100644 index 0000000..5ecb73f --- /dev/null +++ b/ZMQ-Message-Reference.md @@ -0,0 +1,85 @@ +This page lists the JSON strings that can be sent to the ZMQ REQ/REP port in order to request actions by Pixelator. The ZMQ messages must be sent in the format: + +`[HEADER, {"key1":"value1","key2":"value2","key3":"value3"}]` + +Request messages are typically responded to by a simple \["status", "ok"\] response on the REQ/REP port and the publication of further data on the PUB/SUB port. + +## 'initialize' + +## 'recordedChannels' + +## 'detectorSettings' + +## 'updateDetectorSettings' + +## 'estimatedTime' + +## 'scanRequest' + +## 'abortScan' + +## 'pauseScan' + +## 'resumeScan' + +## 'scanStatus' + +## 'moveRequest' + +## 'moveStatus' + +## 'homeRequest' + +## 'positionerStatus' + +## 'modified positioner definition' + +* "name": (required) Positioner name. Must exist as a defined positioner. + + Further optional keys correspond to the [positioner base settings](Config_Positioner#base-settings). +* "`positionOffset"` +* `"upperSoftLimit"` +* `"lowerSoftLimit"` +* `"autoOff"` + +Successful modification of the positioner definition will result in the publication of the new positioner definition in full. + +## 'modified zonePlate definition' + +## 'zonePlateFocus' + +## 'oscilloscopeDefinition' + +## 'focusType' + +## 'scanTypeArchive' + +## 'localFileScanTypeArchive' + +## 'allMotorsOff' + +## 'resetInterferometer' + +## 'OSA_IN' + +## 'OSA_OUT' + +## 'ZonePlate IN' + +## 'ZonePlate OUT' + +## 'Sample OUT' + +## 'topupMode' + +## 'beamShutterMode' + +## 'loadFile directory' + +## 'loadFile file' + +## 'loadDefinition' + +## 'change user' + +## 'script info' \ No newline at end of file