Welcome to the Eclipse BaSyx Python SDK’s documentation!

Contents:

• 1. Tutorials for working with the Eclipse BaSyx Python SDK
  • 1.1. Tutorial: Create a Simple AAS
  • 1.2. Tutorial: Serialization Deserialization
  • 1.3. Tutorial: Storage
  • 1.4. Tutorial: Backend Couchdb
  • 1.5. Tutorial: AASX
• 2. basyx.aas.model - Python Model of the AssetAdministrationShell Metamodel
  • 2.1. aas - High-level structures
  • 2.2. base - Abstract Classes and Basic Structures
  • 2.3. concept - ConceptDescription and Dictionary
  • 2.4. datatypes - Native Python Datatypes for Simple XSD-types
  • 2.5. provider - Providers for storing and retrieving AAS-objects
  • 2.6. submodel - Meta-model of the submodels and events
  • 2.7. _string_constraints - Constraint Functions for Constrained String Types
• 3. basyx.aas.adapter: Adapter of AAS-objects from and to different file-formats
  • 3.1. json - JSON serialization and deserialization
  • 3.2. xml - XML serialization and deserialization
  • 3.3. aasx - Read and write AASX-files
• 4. basyx.aas.backend - Storing and Retrieving of AAS-objects in Backends
  • 4.1. backends - Base class and functionality for Backends
  • 4.2. couchdb - Store and Retrieve AAS-objects in a CouchDB
  • 4.3. local_file - Store and Retrieve AAS-objects as JSON Files
• 5. basyx.aas.examples - Example classes
  • 5.1. data.example_aas - Create an example model.AssetAdministrationShell object
  • 5.2. data.example_aas_mandatory_attributes - AAS-objects that only contain mandatory attributes
  • 5.3. data.example_aas_missing_attributes - AAS-objects containing non-mandatory attributes
  • 5.4. data.example_submodel_template - Create an Example Submodel Template
  • 5.5. data._helper - Helper Classes for AAS Class Comparison
• 6. basyx.aas.util - Provide helpful utilities
  • 6.1. identification - Generate Identifiers
  • 6.2. traversal - Functions for Traversing AAS Object structures
• 7. Metamodel-Constraints

Indices and tables

• Index

• Module Index