View on GitHub

incendium

📦 Package that extends and wraps Ignition scripting API

incendium

GitHub contributors Downloads PyPI GitHub last commit (code) time tracker Sourcery Code style: black Imports: isort Imports: flake8 Imports: pydocstyle linting: pylint pre-commit.ci status Join us on GitHub discussions

(/inˈken.di.um/)

noun.

  1. A fire, inferno, conflagration; heat; torch.
  2. (heat of) passion, vehemence

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

Prerequisites

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

Installation and usage

To use incendium, 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.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

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.

Using as a dependency in PyCharm

To include incendium 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 incendium, navigate to File > Open and select the incendium project folder
  3. Choose Attach when prompted
  4. Under the incendium project folder, right-click on the src/ folder and choose Mark Directory as > Sources Root

Installing incendium as a Project on your Gateway

To install incendium on your Gateway follow these steps:

  1. Download incendium.x.x.x.zip from the latest release or from Ignition Exchange
  2. Browse to your Ignition Gateway (version 8.0+)
  3. Go to Config > Projects and click on Import project…
  4. Click on Choose File and select the downloaded ZIP file
  5. Enter incendium as the Project Name
    1. If you’re replacing a previous version, make sure to check Allow Overwrite
  6. Click on Import

Alternatively you could follow the instructions for cloning the project branch directly into $IGNITION_DIR/data/projects found here.

Contributing to incendium

To contribute to incendium, follow these steps:

  1. Fork this repository
  2. Create a local copy on your machine
  3. Create a branch
  4. Make sure to run pre-commit install to install required pre-commit hooks
  5. Make your changes and commit them
  6. Push to the code branch
  7. 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.