dl-breadcrumbs__homedl-breadcrumb-item__separatorConfiguration and programmingdl-breadcrumb-item__separator...dl-breadcrumb-item__separatorEngineering interfaces and toolsdl-breadcrumb-item__separatorScripting with Pythondl-breadcrumb-item__separatorUsing Scripts to Access CODESYS Functionalities
dl-pagination__prev-inactivedl-pagination__prev-activedl-pagination__next-inactivedl-pagination__next-active
Using Scripts to Access CODESYS Functionalities dl-permalink__symbolPermalink

All objects and command which CODESYS provides for scripting are also available in the "‎scriptengine‎" Python module. Whenever a script is started, an implicit ‎<code>from scriptengine import *</code>‎ results. This allows for easy access to CODESYS. However, if your script imports modules that require access CODESYS APIs, then these modules have to import the module ‎scriptengine‎ themselves.

In the following table, you will find the main objects (categories) that can be used in Python scripts as entry points. For comprehensive documentation about entry points, see the API reference documentation for the CODESYS ScriptEngine.

Objects

Description

System

Access to general CODESYS functionalities

Examples:

  • Exiting CODESYS

  • Handling the general user interface

  • Access to the message memory (including compiler messages)

  • Control of delay and progress bars

projects

Access to the CODESYS project as an object tree that combines the three navigator views (devices, POUs, modules) in one project tree

Also allows for the loading, creating, saving, and closing of projects

For most objects in a project, there are special methods with detailed functionality, for example compiling, access to ST POUs, export, import, device configuration, etc.

online

Access to online functionalities

Examples:

  • Log in to devices and applications

  • Management of access data (user name, password)

  • Performance of network scans

  • Gateway management

librarymanager

Permits the management of library repositories and viewing, installation, and removal of libraries

device_repository

Handling of device repositories; import and export of device descriptions

modulerepository

Management of CODESYS Application Composer modules and CODESYS Application Composer repositories

See the following specific sample scripts for ways to access CODESYS functionalities. For detailed information, see the API reference documentation for the CODESYS.

  • Example: Printing the device tree of the current project
  • Example: Reading of variables
  • Example: Creating and editing of POUs
  • Example: User interface / Interaction with the user
  • Example: Manipulating the “Project Information” object
  • Example: Calling external commands and importing PLCOpenXML files
  • Advanced example: Calling a library from SVN and installing it in CODESYS