This lesson is part of the Scripting in Ignition course. You can browse the rest of the lessons below.

LESSON LIST

Autoplay Off
Take topic challenge

Description

See an introduction to the system.* Ignition scripting API.

Video recorded using: Ignition 7.7

Transcript

(open in window)

[00:00] Python has many powerful built in functions. But when you're using Python, inside of ignition as ignition scripting language, oftentimes, some of the most important functions come from the system library, which is ignition scripting API. So when you're in a script editor and you type system., you can hit Ctrl + Space and it'll pop up and autocompletion pop up here, and then it shows you all of the different sections inside of the system API. And so you can see here that there are many, many different categories of system functions that can do all sorts of things. So for example, system.tag is going to have its functions for reading and writing the tags, system.db is going to let you interact with databases by running sequel queries, system.gymf` have to deal with, you know, opening up windows and closing windows and things like that. So there's a large library here available for your use, and throughout the rest of these scripting lessons, we're going to be using bits and pieces of the system library, but it's too big to cover certainly in a single video. But be aware that if you open up the ignition user manual, Appendix C has a reference for all of the different scripting functions under system. So you know, if you wanted to learn how to run a database query, you could come in here and read the documentation of, you know, system.db.runQuery in these examples and things like that. So it's important to remember that this resource is here for you as you're doing your scripting, and it's oftentimes a good idea when encountering a new API just to kind of peruse through the different functions that are available on the user manual so that when you're writing your script, you have a general idea of what sorts of things are possible.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.