What external tools do you use for Ignition development, and why?

[kgamble]

@Ryan_Deardorff

What are the projectPaths relative to?

They should be relative to the position of the saved VS Code workspace.

So if you do "Save Workspace As" in VS Code, wherever you choose to put that file (We typically do it in the root) of the repo, then it would be relative to that.

Typically we are using this extension with gateways running in docker containers, and not on direct windows installs, so arguably I have not ran through that specific scenario before.

You could try creating a VS Code Workspace in your C:\Program Files\Inductive Automation\Ignition\data directory, and then setting the paths to just be projects?

Or you could try making the workspace in your home directory for your user, and then putting in a full hardcoded projectPath for C:\Program Files\Inductive Automation\Ignition\data\projects? Here is a proposed workspace file for that setup. If you make a folder (wherever you typically use as a working directory, lets pretends its C:\Users\username\ignition

With the file at C:\Users\username\ignition\ignition.code-workspace.json

{
	"folders": [
    {
      "name": "Root", # Reference to C:\Users\username\ignition
      "path": "."
    },
    {
      "name": "Projects Directory",
      "path": "C:\Program Files\Inductive Automation\Ignition\data\projects"
    }
  ],
	"settings": {
    "ignitionFlint.ignitionGateways": [
      {
        "label": "Ignition",
        "address": "http://localhost:8088",
        "projectPaths": [
          "C:\Program Files\Inductive Automation\Ignition\data\projects"
        ],
        "updateDesignerOnSave": true,
        "forceUpdateDesigner": true,
        "supportsProjectScanEndpoint": true
      }
    ]
	}
}

Caveat, that I dont have access to a windows computer at the moment and so I did not test that at all.

[chandler]

Would it ever be possible to allow other JVM languages as the scripting language? It would be nice to write scripts directly in Java or Kotlin.

[Kevin.Herron]

Technically it may be; Kotlin at one point had support for the now defunct JSR-223 scripting engine thing.

Whether we would actually pursue that is another thing.

[jacob_geers]

Could be a designer feature tbh - Visual Studio lets you type cw then tab to auto type console.writeLine(). Would be huge for system.perspective.print().

[Ryan_Deardorff]

@jacob_geers

Would be huge for system.perspective.print()

I use AutoHotKey for that, as well as my Ignition login/pwd. Together they have undoubtedly saved me hours worth of time over just the last couple years.

[brownd18]

When you are using VScode for Project Scripting edits, how do you get VScode to recognize system or other local scripting functions.

Notifications is another Scripting folder within the project.

[PGriffith]

@thecesrom.git has a set of Python "stubs" that you can import to a modern Python editor corresponding to the system functions:

GitHub - ignition-devs/ignition-api-8.1: 📦 Package for the Ignition Scripting API version...

thecesrom/Ignition repo has moved to ignition-api GitHub org

What started as a personal project I uploaded to GitHub back in January 2018, a few months passed and the repo found a new home. Two years later it grew branches, and later it became a Python Package. And this week the project reached a new milestone gaining 1,000 downloads in a month. Now, onto announcements. First, I’d like to thank all who have cloned, forked, and installed the package, and second, I’d like to announce that (hopefully) the project has moved to its final home unde…

You will probably still have to manually import system in your editor to convince it things are in scope. You don't want import system to end up in your final script, though it's not really catastrophic if it does.

[brownd18]

Why don't you want import system to end up in the final script?

[PGriffith]

From import system many people end up with import MyProjectLibraryScript, which does cause problems ^{[1] [2]}.

It's also unnecessary and can lead to "cargo culting", where people just assume they have to import system for system functions to work, which is not true anywhere ^[3].

---

1. [IGN-6503]Project Library Script Initialization Races

   Are you annoyed by pseudo-random breakage in Ignition project library scripting? Odd top-level constants being garbled, or operations in the top level that have side effects running twice? Or more? Not happening much, but always around project edits, and sometimes even on gateway restart? Yeah, me too. Poking around under the hood back in the spring, for a module development task, I ran across some problematic IA bytecode and pinged some people. But it went nowhere, as I co…

   ↩︎

2. [IGN-4437] Ignition occasionally forgets how Python works?

   If you cannot do my option 4, consider this option 5, superior to option 3: c = Constants system.db.runNamedQuery(c.GET_PATH, {c.XYZ_ID_COLUMN_NAME:variable}) The fundamental issue is that Ignition is extremely multi-threaded, including for the jython interpreters. Note the "s" on interpreters. Some multi-threading issues that cannot occur in CPython, due to its single interpreter lifetime, absolutely can occur with jython in Ignition. A piece of your code that triggers the lookup of Constan…

   ↩︎

3. except in gateway scoped event scripts, until 8.3.0 is released ↩︎