ignition-api 7.9.18.post1

Ignition Scripting API.

Ignition

Ignition is a set of packages and modules that allows developers to get code completion for Ignition Scripting API scripting functions in their IDE of choice.

Releases

Check the releases page and download the one for your current version.

If you can't find it, feel free to submit your request on our Discussions.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed Python 2.5.4 (download here)
• You are familiar with Ignition 7.9 Scripting Functions

Packages

Ignition consists of the following packages:

• com
• java/javax
• system

com

These are libraries for some of Inductive Automation's Java packages and functions that are imported in system packages.

java/javax

These are libraries for some Java packages and functions that are imported in system packages meant to be used on systems where no JDK can be installed, and the project interpreter is Python 2.

system

Is a package that includes all Ignition Scripting Functions.

Installation and usage

Although this version of Ignition depends on Jython 2.5.3, which corresponds to Python 2.5, you may still install it via pip with Python 2.7.18.

$ python2 -m pip install ignition-api==7.9.18.post1

This will install it as package to your Python installation, which will allow you to call Ignition Scripting functions from Python's REPL, and get code completion using an IDE (we recommend PyCharm).

Python 2.7.18 (default, Nov  9 2020, 16:23:15) 
[GCC Apple LLVM 12.0.0 (clang-1200.0.32.21)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import system.util
>>> print system.util.__doc__
Utility Functions.

The following functions give you access to view various Gateway and
Client data, as well as interact with other various systems.

>>> system.util.beep()
>>> quit()

And to uninstall:

$ python2 -m pip uninstall ignition-api

Downloading from releases

You may also download the code targeted to your desired version from the releases page and add it as a dependency to your scripting project.

Contributing to Ignition

To contribute to Ignition, follow these steps:

1. Fork this repository
2. Create a local copy on your machine
3. Create a branch
4. Make your changes and commit them
5. Push to the original branch
6. Create the pull request

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to everyone who has contributed to this project.

Up-to-date list of contributors can be found here.

License

See the LICENSE.

Code of conduct

This project has adopted the Microsoft Open Source Code of Conduct.