diff --git a/ZMQ-Publisher-Reference.md b/ZMQ-Publisher-Reference.md index 57554c3..86bd8d9 100644 --- a/ZMQ-Publisher-Reference.md +++ b/ZMQ-Publisher-Reference.md @@ -57,12 +57,27 @@ Example: ``` -## 'recordedChannels' +## 'oscilloscopeDefinition' +Parameters describing the function of the oscilloscope view of periodic detector readings. Data is a dictionary with the following fields: +* "on": Boolean integer stating whether the detector readings will be published. +* "interval": The length of the period (seconds) between detector values being published. +* "countRate": Boolean integer stating whether the published values are per second (1/True), or raw detector values (0/False) Example: ``` -[recordedChannels', []] +['oscilloscopeDefinition', {'countRate': 1, 'interval': 1.0, 'on': 0}] + +``` + +## 'recordedChannels' + +The set of detectors that has been selected to be recorded in scans and displayed in the oscilloscope view. The names and order should be remembered for understanding the "detectorValues" message. + +Examples: +``` +['recordedChannels', []] +['recordedChannels', ['Counter0', 'Counter1']] ``` ## 'scanFileContent'