i40-aas

⚠️ i40-aas is alpha ⚠️

i40-aas welcomes contributions. Please read about known issues and upcoming changes.

Contents

• i40-aas
  • Contents
  • Main Features
  • Prerequisites
  • Instructions
    • Getting Started
    • Cleanup
  • Configuration
  • Known Issues
  • Get Support
  • Contributing
  • Upcoming Changes
  • License

Main Features

The AAS-Service provides an implementation of the RAMI 4.0 reference architecture as specified by Plattform Industrie 4.0. Main features include:

• Standardized communication interfaces and API to access Asset Administration Shells of the digital representation of a physical asset (Digital Twin), that enable:

  • use of a single AAS information model
  • access to asset information from cloud and edge
  • integration of assets without a communication interface (i.e. passive), e.g. via barcodes or QR-codes pointing to asset management solutions

• Facilitate Interoperability:

  • The AAS-Service can act as a mediator between assets and applications that use different languages/standards
  • Enable interactions between administration shells based on semantic protocols (VDI/VDE 2193-1)
  • Information in the AAS can be exchanged between all partners in a value chain (e.g. system manufacturers, operators, engineering and service partners, system integrators)

• Provide registry and discovery services that:

  • hold digital models of various aspects submodels that describe the technical functionality exposed by the asset
  • implement endpoint handling for communication
  • unambiguously identify an asset in network

• Support of statefull communication patterns for well defined or proprietary interactions (see skills).

• Enable integration of applications (eg. Asset stores, datalake) through application adapters

• Deploy everywhere (cloud, on-premise, edge) providing a simple developer experience with docker and K8s

SAP's AAS Service as Integrator and Enabler for Interoperability - representation based on RAMI 4.0

Prerequisites

You need to install Docker and Docker Compose. Docker Compose comes with Docker if you're on Mac or Windows (check here for Linux). Check the installation by executing:

$ docker --version
## tested with: 19.03.8

$ docker-compose version
## tested with: 1.25.4, build 8d51620a

For easier usage, install Make and verify as follows:

$ make --version
## tested with: GNU Make 3.81

Optionally, you can download and install Postman to test the services.

Instructions

Getting Started

Service interactions can be deployed, tested and developed locally using Docker Compose as described below. For further instructions & information about i40-aas check the documentation

Run i40-aas locally using any of these options:

• Pull and run prebuilt images from our Docker Hub repository. Pulling can last several minutes depending on your internet connection.

## 'up' (start) the composed setup
$ make install

• Build the i40-aas images from source first, then pull external dependencies and continue to run everything. Builds are executed in parallel, thus build logs can appear cluttered. Building all i40-aas images can last several minutes.

## build i40-aas images
$ make

## 'up' (start) the composed setup
$ make install

Cleanup

Once done, one can stop & clean up locally by executing:

$ make clean

Configuration

The local setup uses the default configurations specified in the .env file.

See here how to join other service containers locally.

Known Issues

Please refer to the list of issues on GitHub.

Get Support

Please study the help provided and use the GitHub issue tracker for further assistance, bug reports or feature requests.

Contributing

You are welcome to join us in our efforts to improve and increase the set of tools to realize the Asset Administration Shell for Industrie 4.0!

Simply check the Contribution Guidelines.

Upcoming Changes

This project follows the specification "Details of the AssetAdministrationShell" part 1 version 1.0, which is work in progress. As the specification changes, so will this project.

License

Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.

Please note that Docker images can contain other software which may be licensed under different licenses. This License file is also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.