Eclipse BaSyx Python SDK

The Eclipse BaSyx Python project focuses on providing a Python implementation of the Asset Administration Shell (AAS) for Industry 4.0 Systems.

Please note that the SDK version number is independent of the supported AAS versions!

These are the implemented AAS specifications of the current SDK release, which can be also found on PyPI:

Specification	Version
Part 1: Metamodel	v3.1.2 (01001-3-1-2)
Schemata (JSONSchema, XSD)	v3.1.2 (IDTA-01001-3-1-2)
Part 2: API	v3.1.1 (01002)
Part 3a: Data Specification IEC 61360	v3.1.1 (01003-a)
Part 5: Package File Format (AASX)	v3.1 (01005)

If you need support to an older version of the specifications, please refer to our prior releases. Each of them has a similar table at the top of the release notes.

Features

This repository is structured into separate packages. The sdk directory provides the AAS metamodel as Python objects and fundamental functionalities to handle AAS. The server implements a specification-compliant Docker HTTP server for AASs. The compliance_tool is a command-line tool for checking whether JSON and XML files comply with the AAS specification.

• SDK:
  • Modelling of AASs as Python objects
  • Reading and writing of AASX package files
  • (De-)serialization of AAS objects into/from JSON and XML
  • Experimental serialization to RDF (see branch Experimental/Adapter/RDF). Please refer to discussion of PR #308 for the reasoning behind keeping this feature experimental.
  • Storing of AAS objects in CouchDB, Backend infrastructure for easy expansion
  • Compliance checking of AAS XML and JSON files
• Server: Docker Image of a specification compliant HTTP Server implementing the interfaces:
  • Asset Administration Shell Repository
  • Submodel Repository
  • Asset Administration Shell Registry Service
  • Submodel Registry Service
  • Discovery
• Compliance Tool: A command-line tool for checking compliance of JSON and XML files to the specification of the AAS

License

The BaSyx Python SDK project is licensed under the terms of the MIT License.

SPDX-License-Identifier: MIT

For more information, especially considering the licenses of included third-party works, please consult the NOTICE file.

Release Schedule

The Eclipse BaSyx-Python SDK Team evaluates bi-monthly the newly added commits to the main branch towards the need of releasing a new version. If decided the changes warrant a release, it is initiated, using semantic versioning for the new release number. If the changes do not warrant a release, the decision is postponed to the next meeting.

Additionally, security fixes may be released at any point.

Contributing

For contributing with issues and code, please see our Contribution Guideline.

Eclipse Contributor Agreement

To contribute code to this project you need to sign the Eclipse Contributor Agreement (ECA). This is done by creating an Eclipse account for your git e-mail address and then submitting the following form: https://accounts.eclipse.org/user/eca