View on GitHub

incendium

📦 Package that extends and wraps Ignition scripting API

incendium

GitHub contributors GitHub total downloads GitHub last commit (code) GitHub license GitHub release (latest) time tracker Sourcery Code style: black Imports: isort Imports: flake8 Join us on GitHub discussions

(/inˈken.di.um/)

noun

  1. A fire, inferno, conflagration; heat; torch.
  2. (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.

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
    • If you’re replacing a previous version, make sure to check Allow Overwrite
  6. Click on Import

Using incendium within your scripting projects

Prerequisites

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

Including incendium as a dependency

To use incendium as a dependency for your scripting projects, do the following:

  1. Download Source code (zip) from the latest release
  2. Add it as a dependency on your scripting project

NOTE: This project depends on Ignition’s jython branch 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 your changes and commit them
  5. Push to the original branch
  6. Create the pull request

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the 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.