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. aas.model - Python Model of the AssetAdministrationShell Metamodel
  • 2.1. aas.model.aas - High-level structures
  • 2.2. aas.model.base - Abstract Classes and Basic Structures
  • 2.3. aas.model.concept - ConceptDescription and Dictionary
  • 2.4. aas.model.datatypes - Native Python Datatypes for Simple XSD-types
  • 2.5. aas.model.provider - Providers for storing and retrieving AAS-objects
  • 2.6. aas.model.submodel - Meta-model of the submodels and events
• 3. adapter: Adapter of AAS-objects from and to different file-formats
  • 3.1. adapter.json - JSON serialization and deserialization
  • 3.2. adapter.xml - XML serialization and deserialization
  • 3.3. adapter.aasx - Read and write AASX-files
• 4. aas.backend - Storing and Retrieving of AAS-objects in Backends
  • 4.1. aas.backend.backends - Base class and functionality for Backends
  • 4.2. aas.backend.couchdb - Store and Retrieve AAS-objects in an CouchDB Backend
• 5. aas.examples - Example classes
  • 5.1. aas.examples.data.example_aas - Create an example model.AssetAdministrationShell object
  • 5.2. aas.examples.data.example_aas_mandatory_attributes - AAS-objects that only contain mandatory attributes
  • 5.3. aas.examples.data.example_aas_missing_attributes - AAS-objects containing non-mandatory attributes
  • 5.4. aas.examples.data.example_concept_description - Create an example ConceptDescription
  • 5.5. aas.examples.data.example_submodel_template - Create an Example Submodel Template
• 6. aas.compliance_tool - Tool for Creating and Checking JSON, XML and AASX Files’ compliance
  • 6.1. Positional Arguments
  • 6.2. Named Arguments
  • 6.3. aas.compliance_tool.compliance_check_aasx - Check AASX-File compliance
  • 6.4. aas.compliance_tool.compliance_check_json - Check JSON-File compliance
  • 6.5. aas.compliance_tool.compliance_check_xml - Check XML-File compliance
  • 6.6. aas.compliance_tool.state_manager - Store LogRecords in a Compliance Check of the Compliance Tool
• 7. aas.util - Provide helpful utilities
  • 7.1. aas.util.identification - Generate Identifiers
  • 7.2. aas.util.traversal - Functions for Traversing AAS Object structures
• 8. Metamodel-Constraints

Indices and tables

• Index

• Module Index

• Search Page