2.1. aas.model.aas - High-level structures

The main module of the AAS meta-model. It is used to define the class structures of high level elements such as AssetAdministrationShell.

This module contains the following classes from an up-to-down-level:
class basyx.aas.model.aas.AssetAdministrationShell(asset_information: basyx.aas.model.aas.AssetInformation, id_: str, id_short: Optional[str] = None, display_name: Optional[basyx.aas.model.base.MultiLanguageNameType] = None, category: Optional[str] = None, description: Optional[basyx.aas.model.base.MultiLanguageTextType] = None, parent: Optional[basyx.aas.model.base.UniqueIdShortNamespace] = None, administration: Optional[basyx.aas.model.base.AdministrativeInformation] = None, submodel: Optional[Set[basyx.aas.model.base.ModelReference[basyx.aas.model.submodel.Submodel]]] = None, derived_from: Optional[basyx.aas.model.base.ModelReference[basyx.aas.model.aas.AssetAdministrationShell]] = None, embedded_data_specifications: Iterable[basyx.aas.model.base.EmbeddedDataSpecification] = (), extension: Iterable[basyx.aas.model.base.Extension] = ())

An Asset Administration Shell

Variables

  • asset_information – AssetInformation of the asset this AssetAdministrationShell is representing

  • ~.id – The globally unique id (Identifier) of the element. (inherited from Identifiable)

  • id_short – Identifying string of the element within its name space. (inherited from Referable)

  • display_name – Can be provided in several languages. (inherited from Referable)

  • category – The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints. (inherited from Referable)

  • description – Description or comments on the element. (inherited from Referable)

  • parent – Reference to the next referable parent element of the element. (inherited from Referable)

  • administration – AdministrativeInformation of an Identifiable element. (inherited from Identifiable)

  • ~.submodel – Unordered list of submodels to describe typically the asset of an AAS. (Initialization-parameter: submodel_)

  • derived_from – The reference to the AAS the AAs was derived from

  • embedded_data_specifications – List of Embedded data specification.

  • extension – An extension of the element. (from HasExtensions)

class basyx.aas.model.aas.AssetInformation(asset_kind: basyx.aas.model.base.AssetKind = AssetKind.INSTANCE, global_asset_id: Optional[str] = None, specific_asset_id: Iterable[basyx.aas.model.base.SpecificAssetId] = (), asset_type: Optional[str] = None, default_thumbnail: Optional[basyx.aas.model.base.Resource] = None)

In AssetInformation identifying meta data of the asset that is represented by an AAS is defined.

The asset may either represent an asset type or an asset instance. The asset has a globally unique identifier plus – if needed – additional domain specific (proprietary) identifiers. However, to support the corner case of very first phase of lifecycle where a stabilised/constant global asset identifier does not already exist, the corresponding attribute “globalAssetId” is optional.

Constraint AASd-131: The globalAssetId or at least one specificAssetId shall be defined for AssetInformation.

Variables

  • asset_kind – Denotes whether the Asset is of AssetKind “TYPE” or “INSTANCE”. Default is “INSTANCE”.

  • global_asset_id – Identifier modelling the identifier of the asset the AAS is representing. This attribute is required as soon as the AAS is exchanged via partners in the life cycle of the asset. In a first phase of the life cycle the asset might not yet have a global id but already an internal identifier. The internal identifier would be modelled via specificAssetId.

  • specific_asset_id – Additional domain specific, typically proprietary Identifier (Set of SpecificAssetIds for the asset like e.g. serial number etc.

  • asset_type – In case AssetInformation/assetKind is applicable the AssetInformation/assetType is the asset ID of the type asset of the asset under consideration as identified by AssetInformation/globalAssetId. Note: In case AssetInformation/assetKind is “Instance” then the AssetInformation/assetType denotes which “Type” the asset is of. But it is also possible to have an AssetInformation/assetType of an asset of kind “Type”.

  • default_thumbnail – Thumbnail of the asset represented by the asset administration shell. Used as default.