Skip to content

Commit

Permalink
Add references to the Address Space Model Designer on GitHub #390
Browse files Browse the repository at this point in the history
- fixes #390
  • Loading branch information
mpostol committed Nov 16, 2019
1 parent 8dcccbc commit 3af9748
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 37 deletions.
5 changes: 3 additions & 2 deletions Configuration/DataBindings/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ This project is aimed at implementing an editor of the `OOI Reactive Application
The schema of the configuration files is available at: [ConfigurationData.xsd](../../Configuration/Networking/Serialization/ConfigurationData.xsd) and detailed description of the configuration is captured in the document [UA Data Networking Configuration](../../Configuration/Networking/README.MD#ua-data-networking-configuration).

The code help documentation is available at:
[UAOOI.Configuration.DataBindings Namespace](http://www.commsvr.com/download/OPC-UA-OOI/index.html)

- [UAOOI.Configuration.DataBindings Namespace](http://www.commsvr.com/download/OPC-UA-OOI/index.html)

The main changes and Version History are provided by the document [ReadMe.txt](./ReadMe.txt)

Expand All @@ -19,7 +20,7 @@ To install OPC UA DataBindings Library, run the following command in the Packag
## Getting Started Tutorial

The topics contained in this section are intended to give you quick exposure to the `OOI Reactive Application` network based data exchange programming experience. Working through this tutorial gives you an introductory understanding of the steps required to create `OOI Reactive Application` configuration custom editor. The editor is to be used by an universal tool supporting OPC UA Information Model design process. For more information on deploying OPC UA Information Model read the document: [OPC UA Information Model Deployment](http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/20140301E_DeploymentInformationModel.pdf)
The topics contained in this section are intended to give you quick exposure to the `OOI Reactive Application` network based data exchange programming experience. Working through this tutorial gives you an introductory understanding of the steps required to create `OOI Reactive Application` configuration custom editor. The editor is to be used by an universal tool supporting OPC UA Information Model design process. For more information on deploying OPC UA Information Model read the document: [Information Models Development](../../SemanticData/InformationModelsDevelopment.md)

The configuration files are managed using the `UAOOI.Configuration.Networking` component.

Expand Down
3 changes: 2 additions & 1 deletion Configuration/Networking/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The proposed solution supports also possibility to handle the configuration chan

I hope the interface is ready to fulfill the following design time scenarios allowing for configuration in context of selected OPC Information Model/Address Space:

1. Plug in to a modeler (UA Information Model design tool) as the configuration editor tool (preferred for me) - now it is compatible with the [Address Space Model Designer](http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx)
1. Plug in to a modeler (UA Information Model design tool) as the configuration editor tool (preferred for me) - now it is compatible with the [Address Space Model Designer][ASMD]
2. OPC UA Server as an local editor – using server local GUI, Address Space and the UANetworkingConfiguration plug-in (in this case OPC UA server is just modeler)
3. OPC UA Client as an editor - using client local GUI/UANetworkingConfiguration on the client side, and remote access to the Address Space
4. OPC UA Server as a remote editor – using custom configuration Information Model/UANetworkingConfiguration plug-in on the server side, and generic configuration OPC UA Clint as the remote configuration tool,
Expand All @@ -50,3 +50,4 @@ The XML schema of the configuration files is available at: [ConfigurationData.xs
- [API Browser][API Browser]: the preliminary code help documentation.

[API Browser]:http://www.commsvr.com/download/OPC-UA-OOI/index.html
[ASMD]:https://github.com/mpostol/ASMD
10 changes: 5 additions & 5 deletions Networking/Simulator.Boiler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The main goal of this proof of concept is to demonstrate the feasibility of proc

By design it is composable component of the [`ReferenceApplication`](../../Networking/ReferenceApplication/README.MD). This component may be integrated with the `ReferenceApplication` as the `Producer`.

The source code of the OPC UA Information Model is added to the project and is located in the folder `UAInformationModel`. The folder also contains the solution file that can be opened using the Address Space Model Designer [\[ 2\]][CAS.ASMD]. A detailed description of the OPC UA Information Model deployment is covered in [\[1\]][CAS.OPCUAIMD].
The source code of the OPC UA Information Model is added to the project and is located in the folder `UAInformationModel`. The folder also contains the solution file that can be opened using the Address Space Model Designer [\[ 2\]][CAS.ASMD]. A detailed description of the OPC UA Information Model deployment is covered by [\[1\]][CAS.OPCUAIMD].

## Informal Model of Boiler

Expand All @@ -23,7 +23,7 @@ This example considers a real process in a boiler producing steam from water. Th

## OPC UA Information Model of Boiler

One purpose of this example is to illustrate modeling against OPC UA Information Model . A simplified model of the presented process is illustrated in Figure 2 showing part of an OPC UA Information Model where the `BoilerType` type is defined.
One purpose of this example is to illustrate modeling against OPC UA Information Model. A simplified model of the presented process is illustrated in Figure 2 showing part of an OPC UA Information Model where the `BoilerType` type is defined.

![Figure 2. Boiler simplified model](../../CommonResources/Media/Boiler/image003.png)

Expand Down Expand Up @@ -51,10 +51,10 @@ After instantiation of the `BoilerType` and adding reference to it in the `Objec

## See also

> - [ 1] [Mariusz Postol. OPC UA Information Model Deployment][CAS.OPCUAIMD]. 2016. Version 1.2, DOI: 10.5281/zenodo.2586616 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2586616.svg)](https://doi.org/10.5281/zenodo.2586616)
> - [ 1] Mariusz Postol. OPC UA Information Model Deployment, 2016. Version 1.2, DOI: 10.5281/zenodo.2586616 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2586616.svg)](https://doi.org/10.5281/zenodo.2586616)
> - [ 2] [OPC UA Address Space Model Designer, 2019][CAS.ASMD]
> - [ 3] [OPC UA Information Model How to Create Instances Video][CAS.VideoInstances]
[CAS.ASMD]:http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx
[CAS.OPCUAIMD]:http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/20140301E_DeploymentInformationModel.pdf
[CAS.ASMD]:https://github.com/mpostol/ASMD
[CAS.OPCUAIMD]:https://zenodo.org/record/2586616#.XdAUQFdKiUk
[CAS.VideoInstances]:https://youtu.be/LvGHl-hRwZw
6 changes: 2 additions & 4 deletions OPCUAMainTechnologyFeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,12 @@ Sessions are defined as logical connections between clients and servers. What is

## See also

More you can find in the eBook at:

- [1] [OPC UA Address Space Model Designer, 2019][CAS.ASMD]
- [1] [OPC UA Address Space Model Designer][CAS.ASMD]
- [2] [OPC Unified Architecture e-book, 2010][CAS.EBOOK]
- [3] [Part 5: Information Model, OPC Foundation, Rel. 1.04, 2017-11-22][OPC.UA.Part5]
- [4] [Semantic-Data Processing Architecture][SDPA]

[SDPA]:SemanticData/README.MD
[OPC.UA.Part5]:https://opcfoundation.org/developer-tools/specifications-unified-architecture/part-5-information-model/
[CAS.ASMD]: http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx
[CAS.ASMD]: https://github.com/mpostol/ASMD
[CAS.EBOOK]:http://www.commsvr.com/UAModelDesigner/
28 changes: 24 additions & 4 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,17 @@ To get more details visit the section [Internet of Things (IoT) Communication](.
The `SemanticData` folder contains projects related to support the [OOI Semantic-Data Processing Architecture](./SemanticData/README.MD). Processing of the OPC UA Data Outside of the Server context is based on the **Semantic-Data** concept. This project is aimed to workout deliverables supporting Process Data handling over Internet including but not limiting to:

- Data edition ֠UI allowing display and edition of any custom data
- Data serialization and deserialization - see white-paper [Address Space Interchange XML](http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/P-150101E-AddressSpaceInterchangeXML.pdf)
- Data serialization and deserialization - see white-paper [Address Space Interchange XML][CAS.InterchangeXML]
- Data prototyping - methods and tools to design custom data types
- Exposition of the process data in the context of metadata [OPC UA Address Space Model Designer](http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx)
- Browsing of the Metadata to selectively access requested Process Data
- Modeling and representation of the metadata - see white-paper [OPC UA Information Model Deployment](http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/20140301E_DeploymentInformationModel.pdf) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2586616.svg)](https://doi.org/10.5281/zenodo.2586616)
- Modeling and representation of the metadata - detailed description is covered by the section [OPC UA Information Model Deployment](SemanticData/InformationModelsDevelopment.md)
- Validation of the semantics and consistency of the metadata - see project [USNodeSetValidationUnitTestProject](./SemanticData/UANodeSetValidation/README.MD)
- Data Oriented Architecture (DOA)

#### Project `AddressSpaceComplianceTestTool`

It is command line application aimed to validate XML files compliant with the [UANodeSet schema](https://opcfoundation.org/UA/2011/03/UANodeSet.xsd) defined in Part 6 of the OPC UA Specification. The description of this schema is captured in the document [Address Space Interchange XML](http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/P-150101E-AddressSpaceInterchangeXML.pdf)
It is a command-line application aimed at the validation of the XML files compliant with the [UANodeSet schema](https://opcfoundation.org/UA/2011/03/UANodeSet.xsd) defined in Part 6 of the OPC UA Specification. The description of this schema is captured by the document [Address Space Interchange XML][CAS.InterchangeXML]

#### Project `UANodeSetValidation`

Expand All @@ -133,6 +133,20 @@ The project is dedicated to develop the OPC UA Information Model Factory Library

Detailed description is covered by the document [InformationModelFactory Library](./SemanticData/InformationModelFactory/README.md)

## Related work

### OPC UA Address Space Model Designer

The main challenge of the project [OPC UA Address Space Model Designer (ASMD)][ASMD] is to offer the designers a user-friendly tool supporting all aspects of the OPC UA Address Space model designing process. It brings together: designing, learning, and deploying. Description of the main features of the tool is covered by the section [Design and Deployment Support][DDSupport].

The OPC UA Address Space Model Designer ([ASMD][ASMD]) implements conceptual containers called solutions and projects to apply their settings. Any solution contains one or more projects and it manages the way the designer configures, builds, and deploys sets of related projects. Any project includes source files containing the model representation and related metadata such as properties and references to other projects. The designer Integrated Development Environment (IDE) provides tools that help you edit and manipulate models, namespaces, and add references to external resources.

### CommServer

### Object Oriented Internet Reactive Networking Configuration Editor

[Object Oriented Internet Reactive Networking Configuration Editor](https://github.com/mpostol/OPC-UA-OOI.ConfigEditor)

## How to cite the software and associated documentation files

To be compliant with the license of the repository the below copyright notice shall be included in all copies or substantial portions of the software and associated documentation files (the "Software").
Expand All @@ -157,15 +171,21 @@ I hope it is a good place to prototype and converge the OPC UA communication tec

The presented approach is a real proposal for a new technology wave based on the existing Internet infrastructure because it allows vendors to provide generic off-the-shelf products tested independently for interoperability.

## Read more
## See Also

- ebook **Object Oriented Internet** contains description of this project - it is auto-generated content gathered from *.md files [![ebook](https://img.shields.io/badge/Gitbook-Release-brightgreen.svg)](https://commsvr.gitbook.io/ooi/tableofcontent)
- Mariusz Postol, [Object Oriented Internet](https://ieeexplore.ieee.org/abstract/document/7321562), [3rd International Conference on Innovative Network Systems and Applications](https://fedcsis.org/2015/inetsapp), 2015, [IEEE Xplore Digital Library](https://ieeexplore.ieee.org/abstract/document/7321562) [![DOI](https://img.shields.io/badge/DOI-10.15439%2F015F160-blue)](https://fedcsis.org/proceedings/2015/pliks/160.pdf)
- Mariusz Postol, [Machine to Machine Semantic-Data Based Communication: Comprehensive Survey](https://www.researchgate.net/publication/331633195_Machine_to_Machine_Semantic-Data_Based_Communication) in [Computer Game Innovations 2018](https://www.researchgate.net/publication/335524620_Computer_Game_Innovations_2018), Publisher: Lodz University of Technology Press; ISBN: 978-83-7283-999-2, 2018
- [WIKI of this project](https://github.com/mpostol/OPC-UA-OOI/wiki)
- [Library API Browser](http://www.commsvr.com/download/OPC-UA-OOI/index.html)
- [OPC UA Address Space Model Designer (ASMD)][ASMD]
- [My Blog: About enablers of future solutions](http://wwww.mpostol.wordpress.com/)
- [About me on LinkedIn](https://pl.linkedin.com/in/mpostol)
- [OPC Foundation](https://opcfoundation.org/)
- [References](REFERENCES.md) - this section contains links to selected internal and external resources.
- [Sponsored by commsvr.com](http://www.commsvr.com/)

[ASMD]:https://github.com/mpostol/ASMD
[DDSupport]:SemanticData/DesignDeploymentSupport.md
[CAS.InterchangeXML]: http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/P-150101E-AddressSpaceInterchangeXML.pdf

6 changes: 5 additions & 1 deletion REFERENCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@

<!--OOI on GitHub-->

- [OPC UA Address Space Model Designer (ASMD) - GitHub Open Source Software][ASMD]

[ASMD]:https://github.com/mpostol/ASMD

- [GitHub UAOOI.Networking.UDPMessageHandler][OOI.Networking.UDPMessageHandler]

[OOI.Networking.UDPMessageHandler]:https://github.com/mpostol/OPC-UA-OOI/tree/master/Networking/UDPMessageHandler
Expand Down Expand Up @@ -60,7 +64,7 @@

[CAS.OPCUAIMD]: http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/20140301E_DeploymentInformationModel.pdf

- [OPC UA Address Space Model Designer, 2019][CAS.ASMD]
- [CAS OPC UA Address Space Model Designer, CommServer software family][CAS.ASMD]

[CAS.ASMD]: http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx

Expand Down
4 changes: 2 additions & 2 deletions SemanticData/AddressSpaceAddressSpaceModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ Accessing information by clients is the first aspect of controlling the informat

## See also

- [1] [OPC UA Address Space Model Designer, 2019][CAS.ASMD]
- [1] [Address Space Model Designer (ASMD)][CAS.ASMD]
- [2] Wolfgang Mahnke, Stefan Helmut Leitner, Matthias Damm. OPC Unified Architecture. Berlin: Springer, 2009.
- [3] [OPC Unified Architecture Specification Part 3: Address Space Model, OPC Foundation, Rel. 1.04, 2017-11-22][Opc.UA.Part3]
- [4] [Address Space Model Life-cycle][ASMLC]
- [5] [UA Information Model - Concept][UAInformationModelConcept]

[Opc.UA.Part3]:https://opcfoundation.org/developer-tools/specifications-unified-architecture/part-3-address-space-model/
[CAS.ASMD]: http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx
[CAS.ASMD]:https://github.com/mpostol/ASMD
[UAInformationModelConcept]:InformationModelConcept.md
[ASMLC]:InformationModelLifecycle.md

6 changes: 3 additions & 3 deletions SemanticData/AddressSpaceComplianceTestTool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,12 @@ This software is licensed under the MIT License - see the [LICENSE.md][LICENSE.m
- [OPC Unified Architecture][wordpress.opc-ua]
- [OPC Unified Architecture - Main Technological Features][wordpress.OPCUAMTF]
- [OPC UA Makes Complex Data Processing Possible][wordpress.OPCUACD]
- [OPC UA Address Space Model Designer, 2019][CAS.ASMD]
- [OPC UA Address Space Model Designer][CAS.ASMD]
- [XSLT Introduction][XSLT Introduction]
- [OPCFoundation/UA-ModelCompiler] - `ModelCompiler` converts XML files into C# and ANSI C
- [How to contribute][CONTRIBUTING.md]

[CAS.OPCUAIMD]: http://www.commsvr.com/InternetDSL/commserver/P_DowloadCenter/P_Publications/20140301E_DeploymentInformationModel.pdf
[CAS.OPCUAIMD]: https://zenodo.org/record/2586616#.XdAT5FdKiUk

[wordpress.opc-ua]: https://mpostol.wordpress.com/opc-ua/

Expand All @@ -164,7 +164,7 @@ This software is licensed under the MIT License - see the [LICENSE.md][LICENSE.m

[OOI.Releases]:https://github.com/mpostol/OPC-UA-OOI/releases

[CAS.ASMD]: http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx
[CAS.ASMD]: https://github.com/mpostol/ASMD

[OPCFoundation/UA-ModelCompiler]:https://github.com/OPCFoundation/UA-ModelCompiler

Expand Down
6 changes: 3 additions & 3 deletions SemanticData/DesignDeploymentSupport.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,18 @@ Concluding the above the most important requirements of the development environm
- No XML file editing is required.
- No programming skills are required.

An example of the tool meeting all this requirements is [OPC UA Address Space Model Designer, 2019][CAS.ASMD].
An example of the tool meeting all this requirements is [OPC UA Address Space Model Designer][CAS.ASMD] the open source available on GitHub.

## See also

- [1] [OPC UA Address Space Model Designer, 2019][CAS.ASMD]
- [1] [OPC UA Address Space Model Designer][CAS.ASMD]
- [2] [OPC Unified Architecture Specification Part 3: Address Space Model, OPC Foundation, Rel. 1.04, 2017-11-22][Opc.UA.Part3]
- [3] [OPC Unified Architecture Specification Part 5: Information Model, OPC Foundation, Rel. 1.04, 2017-11-22][OPC.UA.Part5]
- [4] [Address Space Model Life-cycle][Address Space Model Life-cycle]
- [5] [Address Space and Address Space Model][Address Space and Address Space Model]
- [6] [UA Information Model - Concept][UA Information Model - Concept]

[CAS.ASMD]: http://www.commsvr.com/Products/OPCUA/UAModelDesigner.aspx
[CAS.ASMD]: https://github.com/mpostol/ASMD
[Opc.UA.Part3]:https://opcfoundation.org/developer-tools/specifications-unified-architecture/part-3-address-space-model/
[Opc.UA.Part4]:https://opcfoundation.org/developer-tools/specifications-unified-architecture/part-4-services/
[OPC.UA.Part5]:https://opcfoundation.org/developer-tools/specifications-unified-architecture/part-5-information-model/
Expand Down
Loading

0 comments on commit 3af9748

Please sign in to comment.