The OPC Foundation Model Compiler will generate C# and ANSI C source code from XML files which include the UA Services, data-types, error codes, etc.; and numerous CSV files that contain NodeIds, error codes, and attributes etc.
The input format for the tool is a file that conforms to the schema defined in UA Model Design.xsd.
The output of the tool includes:
- A NodeSet which conforms to the schema defined in Part 6 Annex F;
- An XSD and BSD (defined in Part 3 Annex C) that describes any datatypes;
- Class and constant definitions suitable for use with the .NET sample libraries;
- Other data files used to load an information model into a Server built with the .NET sample libraries;
- A CSV file which contains numeric identifiers.
The UA Model Design.xsd has more information about the schema itself.
The tool only produces ANSI C output for the stack.
All of the standard outputs are published in the Nodeset GitHub repository
Developers should never need to build the standard outputs themselves.
Tutorial by Stefan Profanter here.
|2.0||Intial release with version tracking and .NET 5.0 support.|
|2.1||Added UA 1.05.00 support.
Switched to Microsoft.Extensions.CommandLineUtils.
Arguments are the same, however, the command 'compile' must be specified.
Use --help for more details.
Fixed bug in generating the 'uanodes' input for the .NET codebase.
The executable file version has the form 2.0.YYMM.DDHH where the last two fields are based on the time that it was built.
About this Repository
This repository contains sub-modules, which are independently tracked. Please clone this repository as shown:
git clone https://github.com/OPCFoundation/UA-ModelCompiler --recursive
This repository is not updated directly. All changes are first made in a member-only version that can be found here.
The version in the member-only repository includes content that is only available to OPC Foundation members such as draft versions of the specifications. When a new version of the OPC UA specification is released, the member-only content is removed and copied to the public repository.
In many cases, updates to the UA-ModelCompiler will require updates to UA-.NETStandard codebase. This means a complete release of the UA-ModelCompiler will need to wait for a update to UA-.NETStandard NuGet packages. The member only version links to a member only fork of UA-.NETStandard allows the changes to be viewed before they are merged with the public baseline.
The public repository is updated as frequently as the OPC UA Specification (once every 3-5 months). When a release starts, all issues reported on the public repository will be reviewed and, if appropricate, incorporated into the member-only codebase. This includes any pull requests to this public repository, which are subject to the OPC Foundation Contributor License Agreement (CLA). When the process completes all accepted public contributions will be merged back into the public codebase along with updates from the member-only codebase.
The ModelCompiler code is MIT license, however, it links to the UA-.NETStandard NuGet packages which is covered under the OPC Foundation Redistributables licence. If a user chooses the version that links directly to the UA-.NETStandard submodule then the license the UA-.NETStandard dual license applies.
The compiled version of this model compiler is available in DockerHub as sailavid/ua-modelcompiler. TODO: Change URL to use official OPCF Docker container!
If you like to build your own container, just use the provided Dockerfile in this repo.
We assume you have your
myModel.csv on your host system in
$HOME/myModel. If not change the path in the next command.
The Docker container uses the model compiler executable as entry point.
This means that any parameter you pass to the
docker run command will be directly passed to the model compiler executable.
This is an examplary call to docker run:
docker run \ --mount type=bind,source=$HOME/myModel,target=/model \ sailavid/ua-modelcompiler -- \ -console -d2 /model/myModel.xml -cg /model/myModel.csv -o2 /model/Published/my_model
Note that here we are binding
$HOME/myModel to the path
/model inside the container.
You need to make sure that the output directory already exists before running this command.
The expected output is:
Trying file: /model/OpcUaDiModel.xml Trying file: ./Design/OpcUaDiModel.xml Trying file: /model/OpcUaDiModel.csv Trying file: ./Design/OpcUaDiModel.csv
Note, there's no final success message.
To use the
PublishModel.sh script you can also override the entrypoint. The PublishModel script is a wrapper around the model compiler executable and is handling directory creation and copying the original model files.
docker run \ --mount type=bind,source=$HOME/myModel,target=/model \ --entrypoint "/app/PublishModel.sh" \ sailavid/ua-modelcompiler \ /model/myModel my_model /model/Published
The expected output is:
Building Model for 'my_model' /app/Opc.Ua.ModelCompiler.exe -console -d2 /model/myModel.xml -cg /model/myModel.csv -o2 /model/Published/my_model Trying file: /model/OpcUaDiModel.xml Trying file: ./Design/OpcUaDiModel.xml Trying file: /model/OpcUaDiModel.csv Trying file: ./Design/OpcUaDiModel.csv Copying Model files to /model/Published/my_model
The following process will demonstrate how to generate code using the supplied nodeset files:
- Clone the repository and then build the source in Visual Studio 2015, in Release mode.
- Open a Command prompt and then launch the BuildStandardTypes.bat
- After the script completes, navigate to the .\Published folder to view the output.
- Optionally, modify the BAT file and specify the location of your UA Stack(s) to automatically copy the generated files.
Model Design example
An excerpt of the Model Design file is shown here:
?xml version="1.0" encoding="utf-8" ?> <opc:ModelDesign xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:opc="http://opcfoundation.org/UA/ModelDesign.xsd" xmlns:ua="http://opcfoundation.org/UA/" xmlns="http://opcfoundation.org/UA/" xmlns:uax="http://opcfoundation.org/UA/2008/02/Types.xsd" TargetNamespace="http://opcfoundation.org/UA/" TargetNamespaceVersion="1.02" > <opc:Namespaces> <opc:Namespace Name="OpcUa" Prefix="Opc.Ua" InternalPrefix="Opc.Ua.Server" XmlNamespace="http://opcfoundation.org/UA/2008/02/Types.xsd">http://opcfoundation.org/UA/</opc:Namespace> </opc:Namespaces> <opc:Property SymbolicName="NodeVersion" DataType="ua:String" PartNo="3"> <opc:Description>The version number of the node (used to indicate changes to references of the owning node).</opc:Description> </opc:Property> <opc:Property SymbolicName="ViewVersion" DataType="ua:UInt32" PartNo="3"> <opc:Description>The version number of the view.</opc:Description> </opc:Property>
This ModelCompiler is used to generate the content of the Nodeset GitHub repository.
This ModelCompiler is used to generate the content of the .NET Samples GitHub repository.