Update ZMQ Publisher Reference

2026-06-10 16:25:44 +02:00
parent 2efa86b53c
commit a951d0a523
+86 -1
@@ -1 +1,86 @@
Pixelator publishes messages based on various types of events.
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'}]
```