Python wrapper for the E3.series API

python e3series is a wrapper library for the E3.series API. The library enhances the automatic code completion and static program verification for python programs that automate E3.series.

This library requires a working instance of the software Zuken E3.series.

Getting Started

Which version to install

The first two sections of the E3.series python libraries version are equal to the version of E3.series version they are meant to be used with. Which means, it is best to use a library version 26.21.XX with a E3.series version 26.21. It is possible to a library version that does not match your E3.series version.

If the version of the library is higher than the version of your E3.series version the library may contain functions your E3.series does not support. In this case you will get an exception whn using such a function. This can be avoided by checking the minimum version required by the function, which is given at the bottom of tooltip of each function.

If the version of your E3.series is higher than the version of your library there might be some functions the library does not support. In this case you cannot use those functions via the library. It is also important to note that, in addition to COM functions, newer versions of the library provide further independent functionality. In addition there might be some bugfixes available only in newer versions.

Some examples:

Installing the library

If neccessary activate your virtual environment first. To do so open your powershell and run "activate":

.\.venv\Scripts\activate

Afterwards your powershell should look like this (note the .venv on the left side):

(.venv) C:\your\active\path\>

Pip will install the package to the currently active virtual enironment. If none was activated the package will be installed to the global environment of your active python installation. If you have installed multiple python installations you can find the active one by executing

Get-Command python

or

(Get-Command python).path

to get only the path.

From Pypi

pip install e3series

From local file

pip install --force-reinstall "C:\Users\<user>\Downloads\e3series-26.0.0.tar.gz"

The option "--force-reinstall" ensures the package is reinstalled, even if it already is up to date

Install a specific version

pip install --force-reinstall "e3series==26.10.0"

In the given example the --force-reinstall ensures to install the specified package even if there is a newer version already installed. By adding "=26.10.0" the version to install in specified.

Using the library

Use the library:

import e3series as e3

app = e3.Application()
app.PutInfo(0, "hello, world!")

The documentation is currently optimised for use with VSCode and may appear poorly formatted in other IDEs.

For more samples you can visit the git repository https://github.com/Zuken-E3-GmbH/E3SeriesPythonExamples.

The Changelog can also be found on github: Link