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: https://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: https://localhost:51310/server/listaas. To show the JSON of the exampleMotor AAS please use: https://localhost:51310/aas/ExampleMotor. To show submodel "Identification" please use: https://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