Object-Oriented Internet
Executive SummarySemantic-Data Processing ArchitectureInternet of Things (IoT) Archetype Reactive Communication
Search…
Introduction
Semantic-Data Processing
Internet of Things (IoT) Archetype
Reactive Communication
Configuration
Global Data Discovery
References
Address Space Prototyping Tool (asp.exe)
Getting Started
The OPC UA Address Space Prototyping (asp.exe) is an engineering tool and can be utilized in several ways:
- creates
UA Address Spacepopulated using input XML files compliant with theUANodeSetschema defined in Part 6 Annex F. - validates an instance of the
UA Address Spaceagainst the OPC UA specification 1.04. - exports XML file compliant with the
ModelDesignschema that may be used as the input for the OPCFoundation/UA-ModelCompiler.
These instructions will get you a copy of the software up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Syntax
1
asp { filePath } [(-e | --export=) filePath] [ (-s | --stylesheet=)*stylesheetName* ] (-n | --namespace=) ns [--nologo]
2
​
3
asp [--help] [--version]
4
​
5
asp [help] [version]
Copied!
Argument
Argument
Description
filePath
Specifies the input file to populate the internal
UA Address Space. At least one file containing UA Address Space model compliant with UANodeSet schema must be specified. Many files can be entered at once.General Options
Option
Description
helpDisplays command syntax and options for the tool. It halts processing and displays the help screen. The help screen is also displayed when the parsing process fails, along with the clear and explicit description of every error encountered. The switch or the built-in
help verb can be used.versionPrints version information. The switch or the built-in
version verb can be used.nologoSuppresses the banner.
ModelDesign Options
Option
Description
e[ xport ] pathSpecifies the output file containing the ModelDesign XML document.
s[ tylesheet ] stylesheetNameName of the stylesheet document (XSLT - eXtensible Stylesheet Language Transformations). With XSLT you can transform an XML document into any text document.
n[ amespace ] nsSpecifies the namespace of the model to be processed.
Command-line Syntax
The following table describes the notation used to indicate command-line syntax.
Notation
Description
Text without brackets or braces
Items you must type as shown
Text Italic
Placeholder for which you must supply a value
[Text inside square brackets]
Optional items
{Text inside braces}
Items that can be repeated
| Vertical bar
Separator for mutually exclusive items; choose one
Deployment
The current binary release containing ready to use application is available on the repository Releases page. Download and run the file to unzip the content to the selected folder. Now you may run the application file
asp.exe. The section Examples cover details on how to get started using attached examples.Examples
Common Task Scrips
There are the following Windows Command shell scripts attached to the software and located in the main folder where the downloaded file has been unzipped:
DoDisplayHelp.cmd- displays a help screen and version informationDoValidate.cmd- validates theUA Address Spacecontent populated using theXMLModels\DataTypeTest.NodeSet2.xmlXML documentDoExport.cmd- validates theUA Address Spacepopulated as above and exports the model to theXMLModels\DataTypeTest.ModelDesign.xml
NOTE: The folderXMLModelsalso contains an exampleDataTypeTest.NodeSet2.xmlXML document compliant withUANodeSetused by above-mentioned scripts. For your convenience, the folder also contains relevant schema files.
How to Display Help
Run the script
DoDisplayHelp.cmd or enter the following command1
asp --help --version
Copied!
It allows you to display a help screen and version information. A similar screen is used to report syntax errors to the end user.
How to validate UA Address Space consistency
UA Address Space consistencyRun the script
DoValidate.cmd or enter the following command1
asp "XMLModels\DataTypeTest.NodeSet2.xml"
Copied!
The screen will contain a verbose listing of diagnostic messages related to the processing of the input file
DataTypeTest.NodeSet2.xml The messages can be examined to improve the files used to populate the UA Address Space and remove any inconsistency against the OPC UA Specification 1.04.How to Export Selected Model to ModelDesign
Run the script
DoExport.cmd or enter a similar command to the following one1
asp "XMLModels\DataTypeTest.NodeSet2.xml" -e "XMLModels\DataTypeTest.ModelDesign.xml" -s XMLstylesheet
Copied!
The screen will contain a verbose listing of diagnostic messages related to the processing of the input file -
DataTypeTest.NodeSet2.xml in this example. All inconsistency problems will be fixed on a best-effort attempt basis. Finally, the model will be exported to the file XMLModels\DataTypeTest.ModelDesign.xml.The model contains the XSLT instruction
1
<?xml-stylesheet type="text/xsl" href="XMLstylesheet"?>
Copied!
to transform XML documents into other formats (like transforming XML into HTML, PDF, mark-down, etc).
- XSL (eXtensible Stylesheet Language) is a styling language for XML.
- XSLT stands for XSL Transformations.
Remarks
- Versioning
We use Semantic Versioning 2.0.0 for versioning. For the versions available, see the releases page of the project.
- Related work
- Contributing
Please read CONTRIBUTING.md for details, and the process for submitting pull requests to us. Let me know in case any problems related to documentation, application asp.exe or the libraries is encountered.
- License
- Version limitations
