Warning
This repository has been moved alongside Eclipse AASX Package Explorer to the eclipse-aaspe organisation.
Branches and issues will be unaffected.
All links to the previous repository location are automatically redirected to the new location, e.g. when using git clone, git push etc.
It is, however, recommended to update the origin of any clones to avoid confusion.
AASX Server is a companion app for AASX Package Explorer. It provides a local service to host and serve Industrie 4.0 AASX packages. The Core version exposes endpoints for REST, OPC UA and MQTT protocols. The GUI version offers the same functionality and additionally uses Blazor Framework to provide a GUI in the browser for exploring AASX Packages.
Important
AASX Server is now V3 and branch main includes a first release:
https://github.com/admin-shell-io/aasx-server/releases/tag/v2023-09-13.alpha
The latest work takes place in branch policy3, which will be included in main then.
Tip
A demo server is running on https://v3.admin-shell-io.com.
https://v3.admin-shell-io.com/swagger shows the API and you can try it manually.
An AASX Server with security enabled can be found here: https://v3security.admin-shell-io.com/.
Mainly AasxServerBlazor is currently used, but AasxServerCore will also be supported.
AasxServerWindows will not be further developed, since .NET 6 works well also on Windows.
--rest, --host, --port are no more supported and will be removed soon. This was the old V2 API.
Please ignore the "Connect to REST by:" message.
Maybe you put your AASXs into ./aasxs.
In the examples below please change YOURPORT and YOURURL.
You may run AASX server directly by dotnet:
export DOTNET_gcServer=1
export Kestrel__Endpoints__Http__Url=http://*:YOURPORT
dotnet AasxServerBlazor.dll --no-security --data-path ./aasxs --external-blazor YOURURL
(ASP.NET Core Runtime 6.0 can be downloaded here: https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
The related docker is:
docker.io/adminshellio/aasx-server-blazor-for-demo:main
Put your AASXs into ./aasxs and you may run the docker by e.g.:
docker run
-p 5001:5001
--restart unless-stopped
-v ./aasxs:/AasxServerBlazor/aasxs
docker.io/adminshellio/aasx-server-blazor-for-demo:main
If you like to use docker compose, see docker-compose.yaml below.
services:
aasx-server:
container_name: aasx-server
image: docker.io/adminshellio/aasx-server-blazor-for-demo:main
restart: unless-stopped
ports:
- YOURPORT:5001
environment:
- Kestrel__Endpoints__Http__Url=http://*:5001
volumes:
- ./aasxs:/usr/share/aasxs
command: --no-security --data-path /usr/share/aasxs --external-blazor YOURURL
The V3 also has a first basic implementation of persistence in a database. We are using the Entity Framework, which has been tested with SQLite and PostgreSQL. SQLite is part of the standard deployment. (PostgreSQL will be explained in the README later in the future.)
Add --with-db to turn on database storage. For the first start please add "--start-index 0" to get the AASX files in --data-path imported into the database. For further starts add "--start-index number" with number greater than you number of AASX files, e.g. 1000. If you change content by the API, you may add "--save-temp number_of_seconds" and the changes will written to the database after the number_of_seconds. With "--aasx-in-memory number" you can specifiy how many AAS shall be shown in the blazor tree. Only the latest changed AAS will be shown.
You can find an example server with database running here: https://cloudrepo.h2894164.stratoserver.net The database content can be seen here: https://cloudrepo.h2894164.stratoserver.net/db . Click on the links on the right. You may also do GraphQL queries to the database here: https://cloudrepo.h2894164.stratoserver.net/graphql/ On the graphql page enter { followed by a space and the wizard will lead you further. An example graphql query is: { searchSubmodels (semanticId: "https://admin-shell.io/zvei/nameplate/1/0/Nameplate") { submodelId url } }
If you want to createa registry and also automatically POST to it, please take a look at: #189
This documentation will be updated to V3 soon.
AASX Server serves Industrie 4.0 AASX packages accessible by REST, OPC UA and MQTT protocols.
The AASX Server is based on code of AASX Package Explorer ( https://github.com/admin-shell-io/aasx-package-explorer ).
There are three variants of the server:
-
blazor. This variant uses Blazor framework to provide a graphical user interface in the browser for exploring the AASX packages. The other APIs are the same as in the core variant.
-
core. This is a server based on .NET Core 3.1.
-
windows. This variant uses .NET Framework 4.7.2, which is the only way how you can start a server on your Windows machine without administrator privileges. If you run on windows start with this variant first and try blazor later.
Mind that blazor and core variants require administrator privileges, so they can not be used for demonstration purposes on tightly-administered machines (which are wide-spread in larger organizations and enterprises).
A blazor demo server is running on https://admin-shell-io.com/5001/. Please click on an AAS and use the DOWNLOAD button on the right or use "https://admin-shell-io.com/51411/server/getaasx/0" etc. by browser or CURL on the command line. You can connect to this AASX Server by AASX Package Explorer by "File / AASX File Repository / Connect HTTP/REST repository" with REST endpoint "https://admin-shell-io.com/51411".
The binaries are available in the Releases section. We provide portable dotnet assemblies.
AASX Server depends on .NET Core 3.1 runtime (blazor and core variants)
and .NET Framework (windows variant), respectively. You need to install the
respective runtimes before you start the server. .NET framework is part of windows.
See https://dotnet.microsoft.com/download/dotnet-core/3.1
To deploy the binaries, simply extract the release bundle (e.g.,
AasxServerWindows.zip or AasxServerCore.zip) somewhere on your system.
We include an example AASX and various extra files (e.g., certificates) in
the release bundle so that you can readily start the server for demonstration
purposes. The scripts startForDemo.sh and startForDemo.bat will start the
server with these pre-packaged files.
For example, if you run on Linux, change to the directory where you extracted the release bundle and invoke:
./startForDemo.sh
On Windows please start startForDemo.bat.
We provide a couple of sample admin shells (packaged as .aasx) for you to test
and play with the software at: http://www.admin-shell-io.com/samples/.
Please copy these to the aasxs subdirectory as needed.
Change to the directory where you extracted the release bundle.
Start startForDemo.bat or invoke the executable with the same name as the
server variant. For example:
AasxServerWindows.exe --opc --rest -data-path /path/to/aasxs
You can see the AAS on the server with: http://localhost:51310/server/listaas. To show the JSON of the exampleMotor AAS please use: http://localhost:51310/aas/ExampleMotor. To show submodel "Identification" please use: http://localhost:51310/aas/ExampleMotor/submodels/Identification/complete.
To obtain help on individual flags and options, supply the argument --help:
AasxServerWindows.exe --help or AasxServerCore.exe --help
AasxServerCore:
serve AASX packages over different interfaces
Usage:
AasxServerCore [options]
Options:
-h, --host <host> Host which the server listens on [default: localhost]
-p, --port <port> Port which the server listens on [default: 51310]
--https If set, opens SSL connections. Make sure you bind a certificate to the port before.
--data-path <data-path> Path to where the AASXs reside
--rest If set, starts the REST server
--opc If set, starts the OPC server
--mqtt If set, starts a MQTT publisher
--debug-wait If set, waits for Debugger to attach
--opc-client-rate <opc-client-rate> If set, starts an OPC client and refreshes on the given period (in milliseconds)
--connect <connect> If set, connects to AAS connect server. Given as a comma-separated-values (server, node name, period in milliseconds) or as a flag (in which case it connects to a default server).
--proxy-file <proxy-file> If set, parses the proxy information from the given proxy file
--no-security If set, no authentication is required
--edit If set, allows edits in the user interface
--name <name> Name of the server
--version Show version information
-?, -h, --help Show help and usage information
Change to the directory where you extracted the release bundle.
Start startForDemo.bat or use dotnet to execute the DLL with the same name
as the server variant. For example:
dotnet AasxServerCore.dll --opc --rest --data-path /path/to/aasxs
You can use AasxServerWindows with Mono. Change to the directory where you extracted the release bundle.
Use mono to execute the EXE:
mono AasxServerWindows.exe --rest --data-path /path/to/aasxs
If you want to also use "--opc" with Mono you need to change Opc.Ua.SampleServer.Config.xml:
change <StoreType>X509Store</StoreType> to <StoreType>Directory</StoreType>.
Mono gives you the possibility to run AasxServer on platforms like x86, PowerPC or MIPS.
See supported Mono platforms on: https://www.mono-project.com/docs/about-mono/supported-platforms/
Find Mono downloads on: https://www.mono-project.com/download/stable/
To build the binaries from the source code, run the powershell script
src/BuildForRelease.ps1.
To package the binaries for release, call src/PackageRelease.ps1.
For more information on continuous integration, see .github/workflows/build-and-package-release.yml for a workflow executed on each release and .github/workflows/check-release.yml for a workflow which is executed on each push to master branch.
We provide pre-built docker images meant for demonstration purposes at the following DockerHub repositories:
blazorlinux/amd64blazorlinux/arm32blazorlinux/arm64corelinux/amd64corelinux/arm32corelinux/arm64
In case you want to deploy on Raspberry PI, you probably need to use ARM 32-bit.
Ideally, we would like to set up a multi-arch docker container (see this article). If you have experience with multi-arch images and would like to help, please let us know by creating an issue.
For example, to pull the latest core variant of the server for the
demonstration on a x86 64-bit machine (linux/amd64), invoke:
docker pull adminshellio/aasx-server-core-for-demo
You can then run the container with:
docker run \
--detach \
--network host \
adminshellio/aasx-server-core-for-demo
The server should be accessible now on your localhost. For example, curl:
curl http://localhost:51310/server/listaas
should give you something like this:
{
"aaslist": [
"0 : ExampleMotor : [IRI] http://customer.com/aas/9175_7013_7091_9168 : ./aasxs/Example_AAS_ServoDCMotor_21.aasx"
]
}
As you can see, we already provide an example AASX in the container. For a more thorough demo, you might want to copy additional AASX packages (e.g., from the samples) into the container. Find the container ID of your running container with:
docker ps
Then use docker cp to copy the AASX packages into the aasxs directory
(assuming your docker container ID is 70fe45f1f102):
docker cp /path/to/aasx/samples/ 70fe45f1f102:/AasxServerCore/aasxs/
If you demo with blazor variant, change the destination path analogously to
AasxServerBlazor.
For example a docker with blazor may be startet by
docker run -p 51000:51310 -p 51001:5001 -v ~/samples:/AasxServerBlazor/aasxs adminshellio/aasx-server-blazor-for-demo
/AasxServerBlazor
connecting host port 51000 to REST port 51310 and host port 51001 to blazor view port 5001. In addition the host directory ~/samples is used to load .AASX files from inside the docker.
Mind that there are many other options for managing containers for custom demos such as Docker multi-stage builds (using one of our demo images as base), bind mounts etc.
We provide a powershell script to build the docker containers meant for
demonstrations at src/BuildDockerImages.ps1.
Please find a short description of the REST API below.
{aas-identifier} = idShort of AAS
{submodel-identifier} = idShort of Submodel
{se-identifier} = idShort of SubmodelElement
{sec-identifier} = idShort of SubmodelElementCollection
| Cmd | String | Example |
|---|---|---|
| GET | /server/profile | http://localhost:51310/server/profile |
| GET | /server/listaas | http://localhost:51310/server/listaas |
| Cmd | String | Example |
|---|---|---|
| GET | /aas/{aas-identifier} /aas/{aas-identifier}/core /aas/{aas-identifier}/complete /aas/{aas-identifier}/thumbnail /aas/{aas-identifier}/aasenv |
http://localhost:51310/aas/ExampleMotor http://localhost:51310/aas/ExampleMotor/core http://localhost:51310/aas/ExampleMotor/complete http://localhost:51310/aas/ExampleMotor/thumbnail http://localhost:51310/aas/ExampleMotor/aasenv |
| Cmd | String |
|---|---|
| GET | /aas/{aas-identifier}/submodels/{submodel-identifier} /aas/{aas-identifier}/submodels/{submodel-identifier}/core /aas/{aas-identifier}/submodels/{submodel-identifier}/deep /aas/{aas-identifier}/submodels/{submodel-identifier}/complete /aas/{aas-identifier}/submodels/{submodel-identifier}/table |
Example: http://localhost:51310/aas/ExampleMotor/submodels/Documentation/complete
| Cmd | String |
|---|---|
| GET | /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{se-identifier} /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{se-identifier}/core /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{se-identifier}/complete /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{se-identifier}/deep /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{se-identifier}/value |
| PUT | /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/ + Payload Payload = content of "elem"-part of a SubmodelElement (see example below) |
| DELETE | /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{se-identifier} |
Example: http://localhost:51310/aas/ExampleMotor/submodels/OperationalData/elements/RotationSpeed/complete
| Cmd | String |
|---|---|
| GET | /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier}/{se-identifier} /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier}/{se-identifier}/core /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier}/{se-identifier}/complete /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier}/{se-identifier}/deep /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier}/{se-identifier}/value |
| PUT | /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier} + Payload Payload = content of "elem"-part of a SubmodelElement (see example below) |
| DELETE | /aas/{aas-identifier}/submodels/{submodel-identifier}/elements/{sec-identifier}/{se-identifier} |
PUT http://localhost:51310/aas/ExampleMotor/submodels/OperationalData/elements
Payload:
{
"value": "1234",
"valueId": null,
"semanticId": {
"keys": [
{
"type": "ConceptDescription",
"local": true,
"value": "http://customer.com/cd//1/1/18EBD56F6B43D895",
"index": 0,
"idType": "IRI"
}
]
},
"constraints": [],
"hasDataSpecification": [],
"idShort": "RotationSpeedNEW",
"category": "VARIABLE",
"modelType": {
"name": "Property"
},
"valueType": {
"dataObjectType": {
"name": "integer"
}
}
}
Test with: GET http://localhost:51310/aas/ExampleMotor/submodels/OperationalData/elements/RotationSpeedNEW
If you want to request new features or report bugs, please create an issue.
Code contributions are very welcome! Please see CONTRIBUTING.md for more information.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent