diff --git a/ZMQ-Publisher-Reference.md b/ZMQ-Publisher-Reference.md index 953cfc8..d291db8 100644 --- a/ZMQ-Publisher-Reference.md +++ b/ZMQ-Publisher-Reference.md @@ -1 +1,86 @@ -Pixelator publishes messages based on various types of events. \ No newline at end of file +Pixelator publishes messages based on various types of events. Some events are periodic, others depend on scanning and others are prompted by [ZMQ requests](ZMQ-Message-Reference). Messages are always structured as a list, with the first element being a string that identifies the type of message. + + +## 'beamShutterMode' + + +Example: +``` +['beamShutterMode', 'Auto'] + +``` + +## 'beamShutterStatus' + + +Example: +``` +['beamShutterStatus', 'red'] +``` + +## 'focalStatus' + +Provides the maximum OSA gap (distance between sample and OSA) that would fit the current FZP focal length and OSA diameter. + + +Examples: +``` +['focalStatus', {'maxDOsa': nan}] +['focalStatus', {'maxDOsa': 422.446144433878}] +``` + +## 'focusType' + + +Example: +``` +['focusType', 'Static'] + +``` + +## 'recordedChannels' + + +Example: +``` +[recordedChannels', []] + +``` + +## 'scanTypeArchive' + + +Example: +``` +['scanTypeArchive', {'attrActual': '', 'attrNew': ''}] + +``` + +## 'topupMode' + + +Example: +``` +['topupMode', 'On'] + +``` + +## 'topupStatus' + + + +Example: +``` +['topupStatus', 'green'] +``` + +## 'userStatus' + + + +Example: +``` +['userStatus', {'saveLocal': 'on', 'username': 'stxm'}] + +``` +