CAUTION
Risk of Crushing Fingers
The drive of a microscope stage with a motorized horizontal stage axis (stage drive) is strong enough to crush fingers or objects between the stage and nearby objects (e.g. a wall).
- Before using ZEN API to move the stage, ensure that people stand clear of the instrument and that the full travel range is not obstructed by any objects.
ZEN API is an interface to connect a running ZEN application from an external process. API interface supports both, extracting information from a ZEN instance (monitoring API) and actively taking control of a ZEN instance (controlling API). Examples of ZEN API interactions include:
- Monitoring of ZEN acquisition and processing tasks, including push-based architecture.
- Control of ZEN processes.
- Data streaming from ZEN to API clients, e.g., image and pixel data.
- Simultaneous connection from multiple API clients.
ZEN API is a foundation for integration of ZEISS instruments and software into third-party workflows and automation. It allows concurrent usage of UI and API (monitoring and controlling APIs), that is, it allows critical actions that may cause conflicts or errors when executed inattentively, for example, moving the stage. It is therefore advisable to proceed with care and thorough understanding.
To call ZEN API as a client, the following prerequisites must be fulfilled:
- The API client must always be connected to the gateway.
- The API client must send API tokens.
- The API client must be connected to the gateway via TLS.
- The API client must trust or know the certificate of the gateway.