Library Generator

From Axel Public Wiki
Revision as of 11:24, 16 January 2018 by Axelpwiki (talk | contribs)
Jump to navigation Jump to search

FOREWORD

The purpose of this functionality is to provide, to firmware developers, the necessary tool to declare IEC blocks, including embedded ones, to be distributed as PLCLIB libraries.

Availability

The library generator feature is available on LogicLab BETA releases starting from 5.7.x.

GENERAL INFORMATION

Prerequisites

Library generation requires a ".plcprj" project with custom workspace option enabled ("Project" + "Options" + "General" + "Use customizable workspace").

Enabling customizablee worskpace

Library generator folders

To mark a workspace folder as library generator, check the specific voice on the context menu (Right click on folder then "Edit folder properties").

Library generator special folder menu

Once done, a special icon appears to mark the folder.

Library generator special folder overlay

Options

You can define some library options by editing those folder properties.

Folder properties
Option Description
Enabled mark selected folder as library generator.
Version Must be in X.Y.Z format (empty corresponds to default 1.0.0)
Password for encryption Password used to crypt library content.
Crypt all contents Library contents will be encrypted using the password above.

Encrypted POUs

As mentioned above you can crypt all POUs contained in the library.Otherwise you can select individually each POU that has to be encrypted.
Check "Crypt with password" option on the POU edit properties dialog (Right click on the POU then "Edit POU properties").
The POU will be encrypted using the password given for the parent container folder.

POU encryption

Hidden POUs

POUs can be included as hidden on the generated library. Check "Generate as hidden" option on the POU edit properties dialog (Right click on the POU then "Edit POU properties").

Embedded blocks

Embedded blocks can be declared only in Library generator folders and its subfolders. Those special blocks don't contain any IEC code but only I/O variables declarations.

Make libraries

To trigger the libraries generation select "Generate library" on selected folder or "Generate libraries" of project root.
All libraries are created, in .PLCLIB format, on the PRJPATH/AutoGenerated libraries folder.


Header files

WORK IN PROGRESS

A more useful and user friendly method to customize the generated header files is under development.