Package: incendium
incendium(/inˈken.di.um/)noun.A fire, inferno, conflagration; heat; torch.(heat of) passion, vehemence:package: Package that extends and wraps some functions from Ignition's Scripting API.For more information, please refer to theWiki.incendiumProjectWe have moved theprojectbranch to its own repo,incendium-projectPrerequisitesBefore you begin, ensure you have met the following requirements:You have installed Python 2.7.18 (download here)You are familiar withIgnition 8.1 System FunctionsInstallation and usageTo use incendium, you may install it by doing any of the following.Installing withpipThe preferred method is to install it by runningpip. It requires Python 2.7.18.python2-mpipinstallincendiumThis will install it as package to your Python installation, which will allow you to callincendium's Scripting functions from Python's REPL, and get code completion using an IDE (Pycharm or Visual Studio Code).$python2
Python2.7.18(default,Nov92020,16:23:15)[GCCAppleLLVM12.0.0(clang-1200.0.32.21)]ondarwin
Type"help","copyright","credits"or"license"formoreinformation.
>>>from__future__importprint_function
>>>importincendium.vision.gui
>>>print(incendium.vision.gui.__doc__)GUImodule.
>>>incendium.vision.gui.warning("This one is a warning")Thisoneisawarninges_MXFalse
Warninges_MXFalse
NoneThisoneisawarningWarning2NoneAnd to uninstall:python2-mpipuninstallincendiumDownloading from releasesYou may also download the code targeted to your desired version from thereleases pageand add it as a dependency to your scripting project.Using as a dependency in PyCharmTo includeincendiumas a dependency in PyCharm, you will need to attach it to your project.Clone the repo or download fromreleasesWith your project open where you want to includeincendium, navigate toFile > Openand select theincendiumproject folderChooseAttachwhen promptedUnder theincendiumproject folder, right-click on thesrc/folder and chooseMark Directory as > Sources RootInstallingincendiumas a Project on your GatewayTo install incendium on your Gateway follow these steps:Downloadincendium.x.x.x.zipfrom thelatest releaseor fromIgnition ExchangeBrowse to your Ignition Gateway (version 8.0+)Go toConfig > Projectsand click onImport project...Click onChoose Fileand select the downloaded ZIP fileEnterincendiumas theProject NameIf you're replacing a previous version, make sure to check Allow OverwriteClick onImportAlternatively you could follow the instructions for cloning theprojectbranch directly into$IGNITION_DIR/data/projectsfoundhere.Contributing toincendiumSeeCONTRIBUTING.md.DiscussionsFeel free to post your questions and/or ideas atDiscussions.ContributorsThanks to everyone who has contributed to this project.Up-to-date list of contributors can be foundhere.LicenseSeeLICENSE.Code of conductSeeCODE_OF_CONDUCT.md.v2023.4.0 (2023-04-18)Featdb: handle concurrent DisposableConnection connections (#142)v2023.3.0 (2023-03-30)Featdataset: add from_list_of_dicts (#140)Refactorhelper: move SProcResult from helper.types to db module (#141)v2023.2.0 (2023-02-25)Featvision: add authentication and authorization (#137)Refactorci: remove matrix strategy (#116)v2023.1.0 (2023-01-09)Refactoradd call to super in base classes (#111)ci: run on ubuntu-20.04 (#98)v2022.9.2 (2022-09-21)Refactordb: cast return value to str (#78)db: return BasicDataset on get_data and o_get_data (#77)v2022.9.1 (2022-09-03)Fixdb: fix o_get_data docstring (#72)v2022.9.0.post1 (2022-09-03)v2022.9.0 (2022-09-02)Featdb: add repr and str functions to Param (#70)date: add functions to get first and last day of the month (#69)db: add functions to get OUTPUT parameters (#68)Fixdb: accept unicode type for [In|Out]Param (#67)exceptions: fix inner_exception warning (#66)Refactorexceptions: improve repr and str functions (#71)v2022.8.2.post1 (2022-08-23)Fixdb: refactor types module (#61)v2022.8.2 (2022-08-05)Refactordataset: work with nested Datasets on to_jsonobject (#56)v2022.8.1 (2022-08-05)Refactordb: remove unnecessary str castv2022.8.0 (2022-08-05)Featadd type hints (#52)dataset: add to_jsonobject function (#50)Refactordataset: use Dataset instance functions (#51)dataset: remove default value forroot(#49)dataset: use Dataset to check instancev2022.3.2 (2022-03-24)Feataddget_usersfunction (#36)Fixci: runcion all PRs (#40)Refactorci: updateci.yml(#38)apply multiple refactorings todataset(#34)v2022.3.1 (2022-03-03)RefactorfixperflintW8202reduce cognitive complexityv2022.2.1 (2022-02-09)Fixaddget_timestampto__all__v2022.2.0 (2022-02-09)Feataddget_timestampfunctionv2.0.2 (2022-01-25)BREAKING CHANGEstop checking instance ofin_paramsandout_paramsRefactorfix SonarLint and Sourcery issuesv2.0.1 (2021-12-17)Fixdb: check instance ofout_paramsv2.0.0 (2021-10-20)BREAKING CHANGEcalls todbfunctions should switch from  passingdicttolist[InParam]andlist[OutParam]where applicableFeatadd InParam, OutParam and Param to dbv1.1.2 (2021-10-18)Fixupdate icendium.vision.gui constantsv1.1.1 (2021-10-18)Fixbring back gui.CURSOR* constantsv1.1.0 (2021-10-15)BREAKING CHANGEthis project has turned into a pure Python project.
Jython is no longer recommended.Fixsetup: modify Python 2 Only classifierRefactormove version information into its own modulerename_Userclass toIncendiumUserimport and use implementing classes rather than interfacesimport unicode_literalsremove copyright from modulesv1.0.7.post2 (2021-09-13)v1.0.7.post1 (2021-09-13)Fixsetup: include__cycle__in packageversionv1.0.7 (2021-09-11)Featrelease: v1.0.7Fixsetup: fix path toversion.pyRefactoradd pylintv1.0.6 (2021-08-04)BREAKING CHANGEDisposableConnection'sdbfield has been renamed todatabaseto conform with snake_case naming style and to match the name
used in somesystem.dbfunctions.Fixbreak loop after expected conditions have been metRefactorconform to snake_case naming stylev1.0.5 (2021-06-22)Featpre-commit: update black 21.5b0 -> 21.5b1pre-commit: update flake8 3.9.1 -> 3.9.2pre-commit: update black 21.4b2 -> 21.5b0pre-commit: update black 21.4b1 -> 21.4b2pre-commit: update black 21.4b0 -> 21.4b1pre-commit: update black 20.8b1 -> 21.4b0pre-commit: bump flake8 to 3.9.1Refactormodify importsv1.0.4 (2021-02-24)Feat:sparkles: add function to convert Dataset into JSONadd flake8 pre-commit hookRefactor:zap: simplify sequence comparisonv1.0.3 (2020-11-12)v1.0.2 (2020-10-17)