Package that extends and wraps Ignition Scripting API
Project description
incendium
(/inˈken.di.um/)
noun
- A fire, inferno, conflagration; heat; torch.
- (heat of) passion, vehemence
Description
:package: Package that extends and wraps some functions from Ignition's Scripting API.
For more information, please refer to the Wiki.
Branches
This repository consists of the following branches:
code
This branch will contain the source code for incendium's scripting functions.
project
This branch will contain the project folder structure as stored under $IGNITION_DIR/data/projects
, and gives you the ability to get the latest code by cloning at the projects
folder.
Installing incendium as a Project on your Gateway
To install incendium on your Gateway follow these steps:
- Download incendium.x.x.x.zip from the latest release or from Ignition Exchange
- Browse to your Ignition Gateway (version 8.0+)
- Go to Config > Projects and click on Import project...
- Click on Choose File and select the downloaded ZIP file
- Enter incendium as the Project Name
- If you're replacing a previous version, make sure to check Allow Overwrite
- Click on Import
Alternatively you could follow the instructions for cloning the project
branch directly into $IGNITION_DIR/data/projects
found here.
Using incendium within your scripting projects
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed Python 2.7.18 (download here)
- You are familiar with Ignition 8.1 System Functions
Installation and usage
To use Ignition, 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 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.gui.vision
>>> print(incendium.gui.vision.__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 incendium
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 incendium
To contribute to incendium, follow these steps:
- Fork this repository
- Create a local copy on your machine
- Create a branch
- Make sure to run
pre-commit install
to install required pre-commit hooks - Make your changes and commit them
- Push to the
code
branch - Create the pull request
Alternatively see the GitHub documentation on creating a pull request.
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.
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
Built Distribution
Hashes for incendium-1.1.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62c1499bea0704000103b83fa744fd6e3eca54e15bebbc14fb698efcf3024118 |
|
MD5 | bdac0bb29d92334476d15d26760fe89a |
|
BLAKE2b-256 | 593bbe48197f8ab79060b0ac8b59d2c316b4863562d3b72d324c50763441a83d |