eclipse-basyx / basyx-java-server-sdk

Eclipse BaSyx Java V2 SDK

In this repository, the BaSyx Java V2 components fully compatible with Details of the Asset Administration Shell V3 are as well as their respective Clients are contained. For each component, a multitude of backends (e.g., InMemory, MongoDB) as well as further features (MQTT, ...) are provided. All components are available on DockerHub as off-the-shelf components and can be easily configured and extended. Additionally, the server SDK of this repository can be used for implementation of further components.

Server SDK

The following off-the-shelf components are available:

• AAS Repository
• Submodel Repository
• ConceptDescription Repository
• AAS Environment
• AAS Registry
• Submodel Registry
• AAS Discovery

In addition, a blueprint for a Type 2/ Type 3 standalone submodel is provided:

• Type 2/Type 3 Submodel

Client SDK

In addition, the following Clients are available:

• AAS Repository Client
• Submodel Repository Client
• AAS Service Client
• Submodel Service Client

Documentation, Roadmap & Examples

In addition to the general documentation, each component has its own specific documentation that can be found in the respective folders. Additionally, we provide a general documentation on readthedocs. Furthermore, we are providing easy to use examples that can be leveraged for setting up your own AAS infrastructure. The future roadmap of BaSyx is described here.

Snapshot Releases

We're distributing our SNAPSHOT releases via DockerHub and Maven Central. For using the snapshots from Maven Central, add the following part to your project's POM:

<repository>
	<id>sonatype.snapshots</id>
	<name>Sonatype Snapshot Repository</name>
	<url>https://oss.sonatype.org/content/repositories/snapshots</url>
	<releases>
		<enabled>false</enabled>
	</releases>
	<snapshots>
		<enabled>true</enabled>
	</snapshots>
</repository>

Getting Involved & Contributing

If you would like to get involved with the BaSyx Community, the BaSyx Open Hour (every first Friday of the month) is an excellent starting point.

We encourage you to contribute to BaSyx! Please check out the Contributing to BaSyx guide for guidelines about how to proceed.

Trying to report a possible security vulnerability in BaSyx? Please check out our security policy for guidelines about how to proceed.

Everyone interacting in BaSyx and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the BaSyx code of conduct.

License

BaSyx is released under the MIT License.