Skip to content

Latest commit

 

History

History
 
 

basyx.aasenvironment

Eclipse BaSyx - AAS Environment

Eclipse BaSyx provides the AAS Environment as off-the-shelf component:

docker run --name=aas-env -p:8081:8081 -v C:/tmp/application.properties:/application/application.properties eclipsebasyx/aas-environment:2.0.0-SNAPSHOT 

Disclaimer: In this example, configuration files are located in C:/tmp

Disclaimer: The binding of volume C:/tmp/application.properties to /application/application.properties is tested using Windows Powershell. Other terminals might run into an error.

It aggregates the AAS Repository, Submodel Repository and ConceptDescription Repository into a single component. For its features and configuration, see the documentation of the respective components.

In addition, it supports the following endpoint defined in DotAAS Part 2 V3 - Serialization Interface:

  • GenerateSerializationByIds

The Aggregated API endpoint documentation is available at:

http://{host}:{port}/v3/api-docs

The Aggregated Swagger UI for the endpoint is available at:

http://{host}:{port}/swagger-ui/index.html

For a configuration example, see application.properties The Health Endpoint and CORS Documentation can be found here.

Preconfiguration of AAS Environments

The AAS Environment Component supports the preconfiguration of AAS Environments (e.g., XML, JSON, AASX) via the basyx.environment parameter.

The feature supports both preconfiguring explicit files (e.g., file:myDevice.aasx) as well as directories (e.g., file:myDirectory) that will be recursively scanned for serialized environments.

For examples, see application.properties