ZEISS INSPECT 2025 App Development Documentation

Welcome to the ZEISS INSPECT 2025 App development documentation. With Apps, you will be able to customize and extend the functionality of your ZEISS INSPECT software. You can include several template configurations from the software, as well as completely new workflows programmed in Python.

Important

Creating Apps is a rather advanced topic, so you should be familiar with the basic inspection concept of ZEISS INSPECT beforehand. New to ZEISS INSPECT? You find an introduction in the ZEISS Quality Tech Guide:

Access Point: ZEISS INSPECT

Or, depending on your application, you might be interested in the specific articles:

• Access Point: ZEISS INSPECT X-Ray

• Access Point: ZEISS INSPECT CMM

• Access Point: ZEISS INSPECT VMM

• Access Point: Airfoil Inspection

• Access Point: ZEISS CORRELATE

If you are new to Apps, you find some introductions in the ZEISS Quality Tech Guide:

• Introduction to Add-ons

• How to Create a Basic Add-on

• How to Create an Advanced Add-on

Check out the ZEISS INSPECT Apps news page!

• What’s New

Furthermore, we recommend following our How-to Guides to get you started.

How-to Guides – Basic

• ZEISS INSPECT Python API Introduction
• Selecting elements in scripts
• Using the App Editor
• App file format
• Selecting a file or folder
• User-defined Dialogs
• Dialog widgets
• Executing dialogs
• Scripting solutions
• Frequently asked questions

How-to Guides – Intermediate

• Using Visual Studio Code as App editor
• Documenting Apps
• Scripted elements
• Using script resources
• Working with stages
• Project keywords handling
• Localization of Apps
• Testing Apps

How-to Guides – Expert

• Creating wizard dialogs
• Using an additional Python GUI library
• Using shared environments
• Using Python wheelhouses
• Adding workspaces to Apps
• Using services
• Using scripted diagrams
• Using Jupyter Notebook
• Using Jupyter Notebook with VSCode
• Software and script starting options
• Scripting with legacy projects (part-less)

If you already know how to create an App and now you are interested in Python programming in ZEISS INSPECT, take a look at our collection of Python examples.

Python API Examples

• Introduction to the Python API Examples
• ZEISS INSPECT App Examples Overview

Available API functions are documented in the Specification.

Python API Specification

• ZEISS INSPECT App Python API documentation
  • gom.api.addons
  • gom.api.dialog
  • gom.api.extensions
  • gom.api.imaging
  • gom.api.interpreter
  • gom.api.introspection
  • gom.api.progress
  • gom.api.project
  • gom.api.script_resources
  • gom.api.scripted_checks_util
  • gom.api.scriptedelements
  • gom.api.selection
  • gom.api.services
  • gom.api.settings
  • gom.api.testing
  • gom.api.tools
• Scripted elements API
  • The dialog function
  • The calculation function
  • Scripted actuals - Return values
  • Scripted checks - Return values
• gom.Resource API
  • Summmary
  • Class definition