AAS Model Design
Asset Administration Shell (AAS) is an industrial standard developed by IDTA. The AAS model is likely the UML Class diagram with the concepts from the AAS standard. This section focus on using Papyrus4Manufacturing to design an AAS model to generate NPB and NPB DT.
Step-by-Step Guide
This section presents three basic steps to design an AAS Model for NPB and NPB DT. You can find the detail description about how to design an AAS model using the cheet sheets of Papyrus4Manufacturing.
Step 1: Create Papyrus Project
Open Papyrus4Manufacturing. In the menu bar, go to File > New > Project... > Papyrus > Papyrus Project, then click Next. In the new appeared window, check AAS Modeling Language, then click Next. Input the required information, including the Project name and location, then click Finish. In the Project Explorer window, a new folder is generated with related files di, notation, and uml.
Step 2: Design an AAS model for NPB
In the Project Explorer window, double click on the Papyrus icon under the new created folder. Next, it is necessary to create an asset (means NPB), its AAS (means NPB DT), and its two AAS submodels Interfaces and Routing.
A. Design Asset (NPB)
In the Model Explorer window, the model folder appears. Right click at the
folder, go to New Package child > Asset.
In the Properties window, you need to input the information of the asset.
The following fields are fundamental:
- Asset: the name of the asset. Choose a name, such as BrxFPGA
- Kind: the type of the model element. Choose Instance.
- Identification: the identifier of the asset. Click the plus button,
choose idType as Custom, then input an id.
- Endpoint: the endpoint that the NPB expose to its NPB DT to connect.
Click the plus button, input the information about the address
and name of the endpoint.
Note: The current version of NPB only supports the WebSocket endpoint.
B. Design AAS (NPB DT)
In the Model Explorer window. Right click at Asset,
go to New Asset child > AAS. In the Properties window, you need
to input the information of the AAS.
In the Properties window, you need to input the information of the AAS.
The following fields are fundamental:
- Name: the name of the AAS. Choose a name, such as BrxFPGA.
- Identification: the identifier of the AAS. Click the plus button,
choose idType as Custom, then input an id.
- Endpoint: the endpoint that the NPB DT expose to external application.
Click the plus button, input the information about the address
and name of the endpoint.
Note: The name of asset and its AAS DT can be the same and should have at least three letters.
C. Design Interfaces and Routing submodels
The two submodels Interfaces and Routing are fundamental and required by the NPB. You can add other submodels to the AAS model.
In the Model Explorer window. Right click at AAS,
go to New AAS child > Submodel to create one submodel.
Repeat the step to create the second one.
In the Properties window, you need to input the information required by
each submodel.
The following fields are fundamental:
- Name: the name of the submodel. Input Interfaces for the
first submodel, and Routing for the second submodel.
- Kind: the type of the submodel. Choose Instance.
- Identification: the identifier of the AAS. Click the plus button,
choose idType as Custom, then input an id.
Note: The submodel must be Interfaces and Routing. If written incorrectly, it will not function properly.
In the Interfaces submodel, add properties related to the network
interfaces that your NPB supports. Right click at Interfaces,
go to New Submodel child > Property.
Likewise, in the Routing submodel, add properties related to
the routing nodes that your NPB supports.
You must use the Properties window to specify each property.
The following fields are fundamental for a property:
- Name: the name of the property.
- Is dynamic: the value of the property is changable or not. Choose true.
- Endpoint: the endpoint related to the property. Choose the endpoint of
the asset.
- Kind: the type of the submodel. Choose Instance.
- Type: the data type of the value of the property. Choose Boolean.
-
Note:
- The property of Interfaces can be ros2, modbustcp, ethernetip, uafx, or canopen. If written incorrectly, it will not function properly
- The property of Routing must follow the format brx_[A]_[B]_[C]. In which, A is device id, B is group id, and C is node id. If using the wrong format, it will not function properly
Step 3: Activate the NPB generation feature
In the Project Explorer window, right click on di file,
go to Open With > Text Editor.
In the appeared editor window, add featureId="ceatmp1015750572" right before
/> in the second line.
Helpful Tips
This section presents some useful tips to design AAS model for NPB and NPB DT.
AAS Model Validation
The validation tool is intergrated into Papyrus4Manufacturing. In the Model Explorer window, right click at the model element needed to be valided, go to Validation > Validation Model. The result of the validation will be shown on the Model Validation window.
Viewing model design with the Class Diagram Designer
An AAS model design can be viewed with the Class diagram. In the Model Explorer window. Right click at the folder Assets, go to New Diagram > AAS Design Diagram. Double click on the diagram to open diagram editor. You can drag-and-drop the element from the Model Explorer window into this editor. Use the pallette to add other elements if necessary.
