Metadata-Version: 2.1
Name: pymm-eventserver
Version: 0.1.11
Summary: Micro-Manager PythonEventServer
Home-page: https://github.com/leb-epfl/pymm-eventserver
Author: Willi L. Stepp
Author-email: willi.stepp@epfl.ch
Project-URL: Bug Tracker, https://github.com/leb-epfl/pymm-eventserver/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# pymm-eventserver
Event Server to receive Micro-Manager events in python via zeromq

This module functions as a plugin for Micro-Manager and takes a lot of inspiration and some
functionality from PycroManager (https://pycro-manager.readthedocs.io/en/latest/index.html)

The server follows the logic of Pycromanager:


```mermaid
sequenceDiagram
    MicroManager->>ZMQ: Event
    activate MicroManager
    Note over MicroManager: Store java object
    ZMQ->>PythonEventServer: Event-ID
    PythonEventServer->>Code: pyqtSignal
    Code-->>ZMQ: Function call (Event-ID)
    ZMQ-->>MicroManager: Call on Java object
    MicroManager->>ZMQ: Output
    ZMQ->>Code: Output
    Note over MicroManager: Keep object for <br> later calls
    deactivate MicroManager
```

The exception are events that contain image data. As keeping those object in memory on the java
side will lead to pretty heavy memory usage in the ImageJ heap space pretty quickly. So these are
sent directly over the zeromq bus. If they are not received correctly, the image data will be lost.
