incendium 2022.2.1

Package that extends and wraps Ignition Scripting API

incendium

(/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.

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:

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.

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

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.

Changelog

All notable changes to this project will be documented in this file.

[2022.2.1] - 2022-02-10

Bug Fixes

• add get_timestamp to __all__ (3cced12)

[2022.2.0] - 2022-02-10

Features

• add get_timestamp function (3172d0e)

Build

• pre-commit autoupdate (#30) (2c877e4)

[2.0.2] - 2022-01-25

Refactor

• fix SonarLint and Sourcery issues (b308e5b)
  • BREAKING: stop checking instance of in_params and out_params

[2.0.1] - 2021-12-18

Bug Fixes

• check instance of out_params (9317a9e)

Documentation

• fix indentation (fee1f1e)
• fix REPL example (fc43f0b)

Miscellaneous Tasks

• :see_no_evil: update .gitignore file (69bcfe4)
• add cliff.toml for changelog generation (b415972)
• format setup.cfg file (29b91e8)

Styling

• set Python 2.7 as standard library (87ebc98)

Build

• update black hook (d41f158)
• pre-commit autoupdate (#28) (e210097)
• deprecate Python 2.7 (091be5f)
• pre-commit autoupdate (ea08729)
• pre-commit autoupdate (55f602e)
• use Python 3.10 (2569a5d)
• pre-commit autoupdate (e1bf0a5)
• update .pylintrc (0365963)
• add setup.py (a28cbc4)
• pre-commit autoupdate (#29) (4396f86)
• add CHANGELOG.md to long_description (59742e5)

[2.0.0] - 2021-10-21

Documentation

• fix typo in Param's docstring (463e96a)

Features

• add InParam, OutParam and Param to db (d6530a3)
  • BREAKING: calls to db functions should switch from passing dict to list[InParam] and list[OutParam] where applicable

Miscellaneous Tasks

• update gitignore (86868e8)
• release 2.0.0 (1f72c46)

Build

• add project_urls (d887fac)

[1.1.2] - 2021-10-18

Bug Fixes

• update icendium.vision.gui constants (13af4f3)

Miscellaneous Tasks

• release 1.1.2 (94b9a30)

[1.1.1] - 2021-10-18

Bug Fixes

• bring back gui.CURSOR* constants (0ebba1e)

Miscellaneous Tasks

• release 1.1.1 (1fb56ba)

[1.1.0] - 2021-10-15

Bug Fixes

• modify Python 2 Only classifier (1956cd7)

CI

• add PyPI upload workflow (d776e35)

Miscellaneous Tasks

• delete dependabot.yml (05615d2)
• prepare for 1.1.0 release (2e7a9c3)

Refactor

• remove copyright from modules (e32f032)
• import unicode_literals (63b141c)
• import and use implementing classes rather than interfaces (263aa71)
• rename _User class to IncendiumUser (106d848)
• move version information into its own module (bf3f464)

Build

• disable consider-using-f-string (722ea27)
• update black and pydocstyle hooks (a007ffc)
• pre-commit autoupdate (fb4d7af)

[1.0.7.post2] - 2021-09-13

Documentation

• update installation instructions (e90c07f)

[1.0.7.post1] - 2021-09-13

Bug Fixes

• include __cycle__ in package version (8c23ce9)

Documentation

• update installation instructions (d567ca6)

Miscellaneous Tasks

• update setup args (0e63e72)

Build

• remove toml dependency as it is not required (36b638f)

[1.0.7] - 2021-09-11

Bug Fixes

• fix path to version.py (7da881d)

Documentation

• add instructions for installing Jython 2.7.2 (ad4ec7a)

Features

• v1.0.7 (b76db29)

Refactor

• add pylint (5549f0c)

Build

• bump Ignition from 6a57209 to 3a3fea8 (#20) (b375669)
• bump Ignition from 3a3fea8 to 7262f72 (#21) (d59a3db)
• pre-commit autoupdate (#22) (0214a00)
• bump Ignition from 7262f72 to c5f1e32 (#23) (234ebec)
• bump Ignition from c5f1e32 to d13416f (#24) (f6104fa)
• update pylint workflow (c30e07d)
• update pylint workflow (75aad2d)
• bump Ignition from d13416f to 0e80df2 (#25) (8e14026)
• bump Ignition from 0e80df2 to 3d50ca4 (#26) (2410b3d)
• remove Ignition submodule (083ce15)
  • BREAKING: switching from using Ignition jython to installing it via jython -m pip install
• update CI tools (a4e671c)
• update CI workflow (0620230)

[1.0.6] - 2021-08-05

Bug Fixes

• break loop after expected conditions have been met (9f0c0e7)

Documentation

• update README (23e8238)
• update README (628d94a)
• update README.md (7cacaef)

Refactor

• conform to snake_case naming style (b1a41de)
  • BREAKING: DisposableConnection's db field has been renamed to database to conform with snake_case naming style and to match the name used in some system.db functions.

Build

• bump Ignition from b63c0ad to 172ffaa (#11) (843cb70)
• pre-commit autoupdate (#13) (8be2b75)
• bump Ignition from 172ffaa to 1a0a0b3 (#14) (df15721)
• pre-commit autoupdate (#15) (8630280)
• bump Ignition from 1a0a0b3 to 5247eef (#16) (54effa2)
• pre-commit autoupdate (#17) (56dd25b)
• bump Ignition from 5247eef to 6a57209 (#18) (04bb5a6)

[1.0.5] - 2021-06-23

Documentation

• update the copyright notice date (65f4533)
• update link to Azul Zulu (958c9c3)
• update README (ad29eba)

Features

• bump flake8 to 3.9.1 (d7629b0)
• update black 20.8b1 -> 21.4b0 (2fd65a7)
• update black 21.4b0 -> 21.4b1 (059e389)
• update black 21.4b1 -> 21.4b2 (faa2d03)
• update black 21.4b2 -> 21.5b0 (5320e5c)
• update flake8 3.9.1 -> 3.9.2 (a17eb42)
• update black 21.5b0 -> 21.5b1 (80f477a)

Miscellaneous Tasks

• update dependabot schedule interval (35b03d9)
• update dependabot schedule interval (09dd8e9)

Refactor

• modify imports (3391f91)

Styling

• update docstrings (c69299c)
• change from single quotes to double quotes (06e4d2b)

Build

• bump flake8 and isort to latest version (5dc44b8)
• rearrange hooks (4014726)
• add pydocstyle hook (a54f4b3)
• remove D209 from ignored codes (4e5c4a1)
• delete ignore codes (6337f97)
• add ci block (322f2d9)
• pre-commit autoupdate (b3c9e98)
• move ci block (9456830)
• create dependabot.yml (40c87c7)
• pre-commit autoupdate (#8) (4899d0a)
• bump Ignition from b94667e to b1f896f (#9) (c7368bb)
• check max complexity (1d0617c)
• bump Ignition from b1f896f to b63c0ad (#10) (c284d7b)

[1.0.4] - 2021-02-25

Features

• add flake8 pre-commit hook (769a240)
• :sparkles: add function to convert Dataset into JSON (ffc2157)

Refactor

• :zap: simplify sequence comparison (93b9b90)

Styling

• Black; started tracking time with WakaTime. (006a45c)
• add link to Ignition Exchange (a3cc644)
• update name (99a0bfa)
• :art: use isort and tell it to use Python27 (09e7a2f)
• :art: apply some pylint fixes (2fbf392)