Package that extends and wraps Ignition Scripting API
Project description
incendium
:package: Package that extends and wraps some functions from Ignition's Scripting API.
For more information, please refer to the Wiki.
Prerequisites
Before you begin, ensure you have met the following requirements:
- You are familiar with Ignition 8.1 System Functions
Installation and usage
Installing as a dependency for your scripting projects
To use incendium
in your scripting projects, you may install it by doing any
of the following.
[!TIP] To install
incendium
as a Jython package for your Gateway, follow these instructions
The preferred method is to install it by running pip
on a virtual environment
using Python 2.7.18.
python2 -m pip install incendium
This will install it as package to your Python installation, which will allow
you to call incendium
's Scripting functions from Python's REPL, and get code
completion using an IDE (PyCharm or 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 incendium.vision.gui
>>> print(incendium.vision.gui.__doc__)
GUI module.
>>> incendium.vision.gui.warning("This one is a warning")
This one is a warning es_MX False
Warning es_MX False
None This one is a warning Warning 2 None
And to uninstall:
python2 -m pip uninstall incendium
Using as a dependency in PyCharm
To include incendium
as a dependency in PyCharm, you will need to attach it to
your project.
- Clone the repo or download from releases
- With your project open where you want to include
incendium
, navigate toFile > Open
and select theincendium
project folder - Choose
Attach
when prompted - Under the
incendium
project folder, right-click on thesrc/
folder and chooseMark Directory as > Sources Root
Installing incendium
on your Gateway
As a Jython package
Starting with version 2024.4.0, this package can be installed using Jython. You may use the Python in Ignition guide as reference. But here are the basic steps:
- Install Java 17
- Install Jython 2.7.3
- Run
jython -m pip install incendium
- Copy the
incendium
directory andtyping.py
from$JYTHON_HOME/Lib/site-packages
to$IGNITION_DIR/user-lib/pylib/site-packages
- Done
$ jython
Jython 2.7.3 (tags/v2.7.3:5f29801fe, Sep 10 2022, 18:52:49)
[OpenJDK 64-Bit Server VM (Azul Systems, Inc.)] on java17.0.11
Type "help", "copyright", "credits" or "license" for more information.
>>> from __future__ import print_function
>>> import incendium
>>> print(incendium.__doc__)
incendium.
incendium is a package that extends and wraps some functions from
Ignition Scripting API.
For more information, please refer to the Wiki.
https://github.com/ignition-incendium/incendium/wiki
As a Python package
To install incendium
as a Python package on your Gateway, simply follow these
steps:
- Install Python 2.7.18
- Run
python -m pip install incendium
- Copy the
incendium
directory andtyping.py
from$PYTHON2_HOME/Lib/site-packages
to$IGNITION_DIR/user-lib/pylib/site-packages
- Done
Contributing to incendium
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.
License
See LICENSE.
Code of conduct
See CODE_OF_CONDUCT.md.
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
Built Distribution
Hashes for incendium-2024.5.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a9aa1c7f9a2b6e1bc75f98904d5f794213ffd6fafb486650587b5fb9c15bd02 |
|
MD5 | 542b52991598ef0ef802b684558c44b7 |
|
BLAKE2b-256 | b5dc4765f1f7cbfc163c305e428007a03a7ccfc03bba9ca02bdb7a4aca23f6be |