ignition-api-jython 8.1.10.post2

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:

• Java 11
  • From Azul
  • Or with Homebrew on macOS

    $ brew install --cask zulu11
    

• Jython
  • 2.7.1 for Ignition 8.0 through 8.1.7
    • Download here
    • Or via Homebrew

      $ brew install coatl-dev/coatl-dev/jython@2.7.1
      

  • 2.7.2 for Ignition 8.1.8 onwards
    • Download here
    • Or via Homebrew

      $ brew install coatl-dev/coatl-dev/jython@2.7.2
      

• You are familiar with Ignition 8.1 System Functions

Packages

Ignition consists of the following packages:

• com
• system

com

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

system

Is a package that includes all Ignition Scripting Functions.

Installation and usage

The preferred method is to install it by running pip by running jython -m pip install like this:

$ jython -m pip install https://github.com/thecesrom/Ignition/archive/refs/tags/v8.1.10-jython.post2.zip

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

$ jython
Jython 2.7.2 (v2.7.2:925a3cc3b49d, Mar 21 2020, 10:03:58)
[OpenJDK 64-Bit Server VM (Azul Systems, Inc.)] on java11.0.12
Type "help", "copyright", "credits" or "license" for more information.
>>> from __future__ import print_function
>>> 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:

$ jython -m pip uninstall ignition-api-jython

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.