Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

admin-shell-io/java-serializer

Repository files navigation

⚠️ Migration to Eclipse Digital Twin Top Level Project

NOTE: We are hounoured to be part of the Eclipse Foundation as Eclipse AAS Model for Java (AAS4J) and this project will be maintained here (Eclipse AAS4J GitHub Repository). See you there!

Please 👉 use our new repository (Eclipse AAS4J GitHub Repository for contributions and subscribe to our mailing list to interact with our community at the Eclipse Foundation.

Java Dataformat Library

The AAS Java Dataformat Library is a collection of software modules to serialize and deserialze instances of the Asset Administration Shell from and to Java instances. De-/serialization works according to the dataformat schemas published in the document 'Details of the Asset Administration Shell', published on www.plattform-i40.de.

Build and Use

Some examples can be found on the documentation webpage.

You can build the project using Maven by simply executing at the repository root:

mvn clean package

or by integrating the respective modules as dependencies from Maven Central Repository, for instance:

<dependency>
  <groupId>io.admin-shell.aas</groupId>
  <artifactId>dataformat-json</artifactId>
  <version>latest-version</version>
<dependency>

Project Structure

The project contains several modules:

  • dataformat-parent Maven parent module that contains the respective de-/serializers for the different data formats.
  • dataformat-core Location of the general classes and interfaces that are used by more than one de-/serializer.
  • dataformat-aasx AASX de-/serializer
  • dataformat-json JSON de-/serializer
  • dataformat-rdf RDF de-/serializer
  • dataformat-xml XML de-/serializer
  • dataformat-uanodeset OPC UA I4AAS NodeSet de-/serializer
  • dataformat-aml AutomationML serializer (deserializer is currently under development)

Additionally, the sources that are used for generating the static documentation using DocFX in the gh-pages branch are located in the docs folder.

How to Contribute

We always look for contributions, bug reports, feature requests etc. Simply open an issue or - even better - directly propose a change through a pull request.

Contributors

Name Affiliation Github Account Parent Core AASX JSON XML RDF UA-Nodeset Validator AutomationML
Mohammad Alreeni Fraunhofer IWU x
Sebastian Bader Fraunhofer IAIS sebbader x x x
Matthias Böckmann Fraunhofer IAIS maboeckmann x x x
Maximilian Conradi Fraunhofer IESE x x
Helge Dickel SAP SE heldic x x x
Daniel Espen Fraunhofer IESE daespen x x x x
Michael Jacoby Fraunhofer IOSB mjacoby x x x x x
Jens Müller Fraunhofer IOSB JensMueller2709 x x
Orthodoxos Kipouridis SAP SE akiskips x x x
Bastian Rössl Fraunhofer IOSB-INA br-iosb x x
Frank Schnicke Fraunhofer IESE frankschnicke x x x
Manuel Sauer SAP SE Manu3756 x
Arno Weiss Fraunhofer IWU alw-iwu x x
Jan Blume Fraunhofer IOSB x

This project was initiated by SAP and Fraunhofer to provide a foundation for the AAS development and to foster its dissemination.