ignition-api 7.9.18

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:

• java/javax
• system

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.7.

system

Is a package that includes all Ignition Scripting Functions.

Installation and usage

To use Ignition, download the code targeted to your desired version from the releases page and add it as a dependency to your scripting project.

Also, once you've downloaded and unzipped the source code you may install it using the setup.py:

$ cd ~/Downloads/v7.9.X
$ python setup.py install --record files.txt 

This will install it as package to your Python installation, which will allow you to call Ignition Scripting functions from Python's REPL.

$ python
Python 2.5.6 (r256, Sep  5 2021, 17:50:57) 
[GCC Apple LLVM 12.0.0 (clang-1200.0.32.29)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import system.gui
>>> print system.gui.__doc__
GUI Functions.

The following functions allow you to control windows and create popup
interfaces.
>>> system.gui.warningBox("This one is a warning.")
['This one is a warning.', 'Warning']
>>> quit()

And to uninstall:

$ cd ~/Downloads/v7.9.X
$ cat files.txt | xargs rm -rf

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.