This page contains frequently asked questions about the Pulsonix Scripting API.
An FAQ specific to the Pulsonix Python client is available here.
What is the “Scripting API”?
The Scripting API (Application Programming Interface) is a system which enables other programs on your computer to interact with Pulsonix by making requests to it. These can be requests for modifying application data, or retrieving information.
How does this system relate to Legacy Scripting?
Both Legacy Scripting and the API provide ways for you to write scripts which read and write to internal Pulsonix data.
Legacy Scripting and is built on the deprecated ActiveX Scripting Framework by Microsoft.
The Scripting API provides easy access to external applications and a richer set of functionality.
The two systems are entirely separate, but the API provides similar classes and functionality to Legacy Scripting.
Which scripting system should I use?
New scripts should be written to use the Scripting API. Old scripts should be upgraded to use the scripting API to benefit from more performance, stability and feature updates.
Can I use Legacy Scripting scripts with the API?
When using the Python client, Python scripts written for the Legacy Scripting can be used with only minor modifications. A guide on the required changes is available.
Pulsonix does not provide immediate support for using other scripting languages with the API. The simplest way to upgrade these scripts is to translate them to Python.
What API functionality is available?
See the Scripting Reference.
What programming languages can I use with the API?
The API is language agnostic, which means that it can be used by any language or system that can communicate with it. It is possible to add support for most languages by writing a custom client.
Pulsonix provides a Python client library which can be used to write Python scripts that make full use of API functionality.
How do I run scripts?
A guide on running Python scripts is available here.
What distance units are used in the Scripting API?
Distance values returned as integers are typically in “Design Space Units” (DSUs), which are hundredths of
a micron. Functions which use floating point distances typically use the current design’s active user-defined
unit system. Point and Rectangle values are always in terms of DSUs.