Workflow automation scripts for CODESYS
Collection of scripts meant for Codesys that automate workflow inside of the IDE.
Available scripts
Save project and export to xml
This script will save your active project and export all of its objects in wanted format. Supported formats are PLC Open Xml and Codesys native Xml. The resulting file will be exported to the same folder the active project is located. This script must be run from CODESYS by its script engine. Due to a bug in CODESYS script parameters(arguments) cannot be passed to the script if ran from the UI so two separate scripts are created just to pass in arguments.
-
saveAndExport_plcopenxml.py for PLC Open Xml
-
saveAndExport_native.py for Codesys Native Xml
Create Namespace POUs and Data types from JSON data
This script will take in a predefined JSON format description of the components and it will build the source code components inside of the Codesys environment. In src folder you can find an example of the JSON data. JSON is really just because it maps really nicely to the Python dictionary, which this script is using. It could very well be XML, Csv and so on. I don't recommend generating the data.json file manually as it was designed to be created programmatically by another program. The script can be used for transpiling a project from non-Codesys to Codesys environment if the non-Codesys environment doesn't support PlcOpenXml.
Installation
Manual installation
-
Create the Script Commands folder in one of the storage locations. I recommend C:\ProgramData\CODESYS\Script Commands
-
Copy the Python, config.json and the .ico files there.
-
Start CODESYS. The script files, configuration file, and symbol files are read and provided in the Tools -> Customize dialog in the Command Icons tab, ScriptEngine Commands category. Add the scripts to wanted shortcuts
More on codesys scripting on Codesys Online Help
Automatic build script
In the repo I have provided the build.py script that can be ran and it will install all necessary scripts, icons and config.json to the C:\ProgramData\CODESYS\Script Commands folder. In case the folder already exists, the script will update the config.json and update the scripts that have the same name as in the new config.json. If you have scripts of your own already mapped to config.json, they will not be overwritten if they have a different name. Automatic build must be ran with administrative rights. If you have a problem with that, the build script is python so you can read what it does, or you can always install manually.
WARNING: If the config.json is corrupted or json is not valid, the script will overwrite the contents
License
MIT
Contribution
Raise a pull request with the modified config.json, icons and the script if you want to add some useful scripts to the project.
All objects and command that CODESYS provides for scripting are also in the Python module “scriptengine”. Whenever a script is started, an implicit from scriptengine import * 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.