📦 Package for the Ignition Scripting API version 8.1
MIT License
ignition-api is a Python package that allows developers to get code completion for Ignition Scripting API scripting functions in their IDE of choice.
Before you begin, ensure you have met the following requirements:
To use ignition-api, you may install it by doing any of the following.
pip
The preferred method is to install it by running pip
. It requires Python
2.7.18.
python2 -m pip install ignition-api
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 such as PyCharm and Visual Studio Code.
$ python2
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.
>>> 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:
python2 -m pip uninstall ignition-api
You may also download the code targeted to your desired version from releases and add it as a dependency to your scripting project.
To include ignition-api as a dependency in PyCharm, you will need to attach it to your project.
ignition-api
, navigate toFile > Open
and select the ignition-api
project folderAttach
when promptedignitition-api
project folder, right-click on the src/
folderMark Directory as > Sources Root
This project consists of the following packages:
This package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here: https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.43/index.html.
These packages include supporting Java classes and interfaces. For more information, see documentation here: https://docs.oracle.com/en/java/javase/17/docs/api/index.html.
This package includes supporting classes and interfaces from Apache Commons Math API. For more information, see documentation here: https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/index.html
This package includes supporting classes and interfaces from the Inductive
Automation's org.json
package, see documentation here:
https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.43/org/json/package-summary.html
This package includes supporting Jython classes and interfaces. For more information, see documentation here: https://www.javadoc.io/doc/org.python/jython-standalone/2.7.3/index.html.
This package includes supporting classes and interfaces from SLF4J API Module. For more information, see documentation here: https://www.javadoc.io/doc/org.slf4j/slf4j-api/1.7.26/overview-summary.html.
This package includes all Ignition Scripting Functions. For more information, see documentation here: https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions.
See CONTRIBUTING.md.
Feel free to post your questions and/or ideas at Discussions.
Thanks to everyone who has contributed to this project.
Up-to-date list of contributors can be found here: CONTRIBUTORS.
See the LICENSE.
This project has adopted the Microsoft Open Source Code of Conduct.