ignition-api 8.3.6

Ignition Scripting API

ignition-api 8.3

ignition-api is a Python package that allows developers to get code completion for Ignition Scripting API scripting functions in their IDE of choice.

Table of contents

• Prerequisites
• Installation and usage
  • Installing with pip
• Stubs
• Project structure
  • Packages
• Contributing
• Discussions
• Contributors
• License
• Code of conduct
• Disclaimer

Prerequisites

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

• You have installed Python 2.7.18
• You are familiar with Ignition System Functions

Installation and usage

Installing with 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

Stubs

ignition-api-stubs is a companion package that provides Python type stubs (.pyi files) for the Ignition Scripting API. Type stubs enable static type checking and enhanced IDE support for code that depends on ignition-api.

The recommended use of ignition-api-stubs is to enable type checking of your Ignition scripting code using mypy. This allows you to catch type-related errors during development before deploying to your Ignition gateway.

Project structure

Packages

This project consists of the following packages:

• com
  • codahale
  • google
  • inductiveautomation
  • palantir
• org
  • apache
  • bson
  • json
  • python
  • slf4j
• system

com.google

This package includes supporting classes and interfaces from Guava: Google Core Libraries for Java 32.0.1-jre API. For more information, see documentation here: https://javadoc.io/doc/com.google.guava/guava/32.0.1-jre/index.html

com.inductiveautomation

This package includes supporting Inductive Automation's classes and interfaces. For more information, see documentation here: https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/index.html.

org.apache

org.apache.commons.lang3

This package includes supporting classes and interfaces from Apache Commons Lang 3.11 API. For more information, see documentation here: https://javadoc.io/doc/org.apache.commons/commons-lang3/3.11/index.html

org.apache.commons.math3

This package includes supporting classes and interfaces from Apache Commons Math 3.6.1 API. For more information, see documentation here: https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/index.html

org.apache.commons.poi

This package includes supporting classes and interfaces from Apache POI 4.1.2 API. For more information, see documentation here: https://www.javadoc.io/doc/org.apache.poi/poi/4.1.2/index.html

org.bson

This package includes supporting classes and interfaces from Mongo Java driver 4.8.1, see documentation here: https://javadoc.io/doc/org.mongodb/bson/4.8.1/index.html

org.json

This package includes supporting classes and interfaces from the Inductive Automation's org.json package, see documentation here: https://sdk.inductiveautomation.com/javadoc/ignition83/8.3.6/org/json/package-summary.html

org.python

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.

org.slf4j

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/2.0.12/index.html.

system

This package includes all Ignition Scripting Functions. For more information, see documentation here: https://docs.inductiveautomation.com/docs/8.3/appendix/scripting-functions.

Contributing

See CONTRIBUTING.md.

Discussions

Feel free to post your questions and/or ideas at Discussions.

Contributors

Thanks to everyone who has contributed to this project.

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

License

See the LICENSE.

Code of conduct

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

Disclaimer

This project is not an official product of Inductive Automation. Ignition is a trademark of Inductive Automation. This package is community-maintained and provided as-is for development assistance purposes.