BaSyx / Examples
- 1 Examples
- 1.1 Code snippets
- 1.2 Deployment with Docker
Code snippets are simple, isolated use-cases that illustrate the use of Eclipse BaSyx. They provide focused recipes that document the intended use of the BaSyx SDK and our reference implementations of Industrie 4.0 middleware components. To keep functional examples simple, code snippets only address selected aspects of Industrie 4.0 implementations. Selected snippets provide a page with documentation. For all snippets, links to executable source code files in the git repository are provided. The source code may contain required drivers and stubs for running the code, as well as testing routines that validate the results of the execution.
Please keep in mind that not all features are available with all language versions of Eclipse BaSyx. Snippets therefore may only be available for selected languages.
The code for the snippets is available via the Eclipse BaSyx GIT repository:
- For Java, the code is located in the basyx.example project in package org.eclipse.basyx.examples.snippets
Virtual Automation Bus (VAB)
The Virtual Automation Bus provides end-to-end connection capabilities. The VAB uses gateways to connect network technologies into one virtual, and fully connected network. The network consists of objects, e.g. Asset Administration Shells and sub models that are accessible through unqiue IDs. The following code snippets illustrate VAB operations and the use of the Virtual Automation Bus.
|CRUD operations||Illustrate creation of VAB object and use of create/update/retrieve/delete operations to manipulate it.||Java|
|Manual HTTP calls||Illustrate manual HTTP operations to access VAB objects via HTTP REST interface||Java|
|Dynamic property (Lambda)||Illustrate dynamic properties (Lambda expression) in VAB objects.||Java|
|Dynamic property (Class)||Illustrate the dynamic properties (Class) in VAB objects.|
Asset Administration Shell (AAS)
The Asset Administration Shell snippets illustrate the creation of Asset Administration Shells using tools of the BaSyx SDKs.
|Create AAS||(Java)||Creation of Asset Administration Shell by extending SDK class||Java|
|Create AAS on the fly||Creation of Asset Administration Shell by setting properties of predefined AAS class||Java|
Asset Administration Shell HTTP server deployment
These code snippets illustrate Asset Administration Shells in context of HTTP servers. It is common to deploy an Asset Administration Shell to the IT to ensure its presence when a device fails. HTTP servers are available hosts for Asset Administration Shells. The following code snippets illustrate the dynamic creation of an Asset Administratuion Shell, its transfer, and its use from Industrie 4.0 applications.
|Connect to remote AAS||(Java)||Illustrate connection to Asset Administration Shell with SDK connector||Java|
Asset Administration Shell deployment on Device
Instead of an HTTP server, Asset Administration Shells may be deployed to devices that run their own servers to enable access to an AAS. The following code snippets illustrate SDK features to host Asset Administration Shells and sub models on devices.
|Device AAS deployment||Dynamic Asset Administration Shell deployment with BaSyx/TCP|
|Device AAS deployment (VAB)||Dynamic Asset Administration Shell deployment with BaSyx/TCP using low-level VAB access||Java|
|Device sub model deployment||Dynamic deployment of sub model on Device using a BaSyx/TCP protocol server||Java|
|Device sub model deployment (VAB)||Dynamic deployment of sub model on Device using a BaSyx/TCP protocol server (VAB access)||Java|
AAS Sub models
Asset Administration Shell sub models may be distributed through the network. While an AAS resides on the IT and remains accessible in case of device failures, sub models may be distributed. Sub models containing static data or information about devices that needs to remain available in case of device failure may be hosted on the IT as well; sub models containing live data may be hosted on devices, and possibly on products. The following code snippets illustrate the creation, transfer, hosting, and use of AAS sub models.
|Create AAS sub model (SDK)||(Java)||Illustrate creation of AAS sub model with SDK factory||Java|
|Create AAS sub model (VAB)||(Java)||Illustrate creation of AAS sub model with VAB primitives||Java|
|Dynamic sub model deployment (SDK)||Illustrate dynamic sub model creation and deployment on BaSyx sub model server|
|Dynamic sub model deployment (HTTP)||Illustrate dynamic sub model creation and deployment on BaSyx sub model server|
|Connect to AAS sub model via SDK||(Java)||Illustrate connection to AAS sub model using SDK connector||Java|
|Connect to AAS sub model via VAB||(Java)||Illustrate connection to AAS using low-level virtual automation bus (VAB) primitives|
|Invoke sub model operation (SDK)||Define sub model operation and invoke them via SDK connector|
AAS Sub model providers
Eclipse BaSyx provides pre-created AAS sub model providers. These servlets connect existing data sources, such as textual configuration files and SQL data bases into Industrie 4.0 environments as AAS sub models. BaSyx sub model providers are configured with a configuration API and do not require programming knowledge to integrate data sources into Industrie 4.0 environments as AAS sub models.
AAS Sub models (Dynamic)
Asset Administration Shell sub models may contain dynamic properties and operations. Dynamic properties are properties whose values are generated dynamically at runtime. This may happen for example periodically, or whenever a specific information is requested. Dynamic operations are operations that may be updated at runtime. The following code snippets illustrate dynamic sub model properties and operations.
|Dynamic property (Lambda)||Illustrate dynamic sub model properties (Lambda expression)||N/A|
|Dynamic property (Class)||Illustrate the dynamic sub model properties (Class)||N/A|
The Asset Administration Shell registry enables registration of AAS and sub models, as well as retrieving previously registered AAS and sub models by their IDs.
|Register and lookup AAS||Register and retrieve AAS descriptors from registry||Java|
|Register AAS descriptor||Register an AAS descriptor in AAS registry, lookup AAS by ID, and connect to AAS||Java|
|Register AAS sub models||Register an AAS descriptor with sub models, lookup and connect to AAS sub models||Java|
Eclipse BaSyx advocates the use of URNs as unique identifiers for AAS. Code snippets illustrate the creation and use of URNs.
|Construct URNs||Create URNs for AAS and globally idenfied sub models||Java|
Deployment with Docker
The deployment of the different SDKs and components with docker is explained in its own page.