Skip to main content

Ignition Scripting API

Project description

ignition-api 8.1

Downloads ignition-api

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

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

Installation and usage

To use ignition-api, you may install it by doing any of the following.

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

Downloading from releases

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

Using as a dependency in PyCharm

To include ignition-api as a dependency in PyCharm, you will need to attach it to your project.

  1. Clone the repo or download from releases
  2. With your project open where you want to include ignition-api, navigate to File > Open and select the ignition-api project folder
  3. Choose Attach when prompted
  4. Under the ignitition-api project folder, right-click on the src/ folder and choose Mark Directory as > Sources Root

Project structure

Packages

This project consists of the following packages:

com.inductiveautomation

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

java/javax

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.

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

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.48/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.1/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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ignition_api-8.1.48.post2.tar.gz (199.7 kB view details)

Uploaded Source

Built Distribution

ignition_api-8.1.48.post2-py2-none-any.whl (269.7 kB view details)

Uploaded Python 2

File details

Details for the file ignition_api-8.1.48.post2.tar.gz.

File metadata

  • Download URL: ignition_api-8.1.48.post2.tar.gz
  • Upload date:
  • Size: 199.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.3 requests/2.27.1 setuptools/44.1.1 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/2.7.18

File hashes

Hashes for ignition_api-8.1.48.post2.tar.gz
Algorithm Hash digest
SHA256 acf8a6bd0d14c3da1ca6c686651c4c48df759258facb0a1274092014bd3480bf
MD5 904b9d9de9abc5cce712b0bd689a1306
BLAKE2b-256 2dec7672e6fdf4dafb6de40ea4d205b27d1c7b47949d22f8d09901f5547e92d8

See more details on using hashes here.

File details

Details for the file ignition_api-8.1.48.post2-py2-none-any.whl.

File metadata

  • Download URL: ignition_api-8.1.48.post2-py2-none-any.whl
  • Upload date:
  • Size: 269.7 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.3 requests/2.27.1 setuptools/44.1.1 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/2.7.18

File hashes

Hashes for ignition_api-8.1.48.post2-py2-none-any.whl
Algorithm Hash digest
SHA256 7146a19c37a6b268383cc4eeb6d391609e5b68a35b95b7ec2921437d5ec1e42e
MD5 84a61faa1ca188a85ac9fc93e5d18771
BLAKE2b-256 2906730a9ba0aadaccb3c213d25b01fa33947b5cd74b55165d42a31cec39ab59

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page