Introduction¶

This document summarizes the most important topics around the area “How to Develop CODESYS Libraries”.

We have carefully defined ten guidelines for you to follow when designing a reusable library. These guidelines ensure that the risk of future compatibility issues with CODESYS or other libraries will be minimized. By following these guidelines, you will produce libraries that are user-friendly, easy to maintain, and include valuable documentation.

In the list of guidelines below, each topic is linked to a chapter containing a detailed description.

• Select a meaningful filename (required)

• Select a unique namespace (required)

• Enter all project information (required)

• Apply the correct method for referencing other libraries (required)

• Design smart interfaces (required)

• Implement user-friendly error handling (required)

• Use the correct method for deployment and licensing (required)

• Ensure consistency by using templates (optional)

• Use a familiar and uniform project structure (optional)

• Ensure clean code by applying a consistent naming conventions (optional)

Every new CODESYS library that is part of the CODESYS setup and intended for use in end-user applications must comply with the guidelines marked as required. All libraries to be uploaded to the CODESYS Store must pass an acceptance test to confirm compliance with these guidelines (see: Optional and Required).