Skip to main content

Speos APIs

Speos APIs Introduction

Automation refers to the process of generating tools or scripts meant to automate the execution of tasks.

Speos APIs (Application Programming Interface) are based on the Speos user interface. This means that for any Speos functionality currently available in the GUI, an associated automation function is available. As the automation functions are derived from the GUI, they are completely aligned with the actions that you would have to perform in the software. For instance, creation of new Speos object, edition of existing ones, modification of parameters, etc.

Three interfaces are available to access the different functions:

  • SpeosSim allows you to access all the Light Simulation features
  • SpeosDes allows you to access all the Optical Part Design features
  • SpeosAsm allows you to access the Geometry Update feature

In addition to Speos APIs, you can use the Labs automation to post process simulation results.

Technical Information

The Speos APIs are described using the IDL (Interface Description Language).

The exposed data are called Properties.

The exposed functions are called Methods.

To use the Speos APIs, you need to use IronPython Script language.

You can use the Speos built-in Script Editor to create or edit scripts.

Reading the Speos APIs Documentation

 Use this link to download the Speos API file.

The APIs documentation provides a modular presentation of the Speos API functions:

  • The first column provides you with the method and property name. The method/property hierarchy is simply expressed in the file structure. The name of a section refers to a "parent" method (i.e. a feature level). All dependent methods are listed below it.
  • The second column provides you with the method/property Description.
  • The third column provides the method's Syntax. The syntax corresponds to a template for the use of the methods with its return value and arguments.
    • The return value is used as an intermediary step in the method calculation. These values are, therefore, both indicating which value is expected as a result of the function and what type of input is expected by the method.
    • Arguments are always declared with parenthesis () and correspond to variables that must be provided to obtain the method's result.

In Speos, arguments often correspond to axis system definitions.

In addition to the APIs documentation, some common cross functional and more specific APIs are provided in the Methods section of the Speos User Guide.