The NOVAAS-PROSYS-OPCUA-Simulation-Server is an particular instance of the NOVAAS open-source project. This repository contains file that are needed to build a docker image for attaching NOVAAS to the PROSYS OPC-UA Simulation Server using the node-red-contrib-opcua package.
In order to install and run it, dowload/clone the repository and build and run the dockerfile and/or the docker-compose file. The repository is preloaded with all the necessary files (documentation, asset, manifest) for creating the specific version of NOVAAS.
The docker command to create the NOVAAS image is the following:
docker build -t name_of_the_image:ver .
Once the image has been created the followig docker command can be used to start a new container that runs the NOVAAS image:
docker run --env PORT_FORWARDING=1860 --env HOST=localhost --env BROKER_SERVICE_HOST=localhost --env BROKER_SERVICE_PORT=1883 --env PROSYS_OPCUA_SERVICE=opc.tcp://server_name:53530/OPCUA/SimulationServer -p 1860:1880 name_of_the_image:ver -d
After executing the above commands, the NOVAAS will be accessible at the following link:
"NOVAAS Main Screen"
The two environmental variables are needed to properly configure the internal iFrame node that is used to expose in the ui the dashboards for each one of the internal data sources. Specifically, the $HOST environmental variable should be the ip address of the host machine where NOVAAS is deployed. Setting this variable to localhost will only expose the dash tab within the ui in the host.
The NOVAAS embeds an MQTT client for pushing out data. This client needs to be configured. To do that it is possible to access the NOVAAS backend by using the following link:
or by properly configure the following environmental variables: i) $BROKER_SERVICE_HOST that is used to set-up the host where the mqtt broker is running; and ii) $BROKER_SERVICE_PORT that is used to set-up the port used by the mqtt broker.
"NOVAAS Backend once user is logged in"
To access the backend the user needs to insert username and password. These are the default username and password from the node-red settings file, namely:
- username: admin
- password: password
Finally, the $PROSYS_OPCUA_SERVICE environmental varialbe is used to configure the NOVAAS internal opc-ua connector. THis variable should be set with the value of the PROSYS simulation server connection address.
"PROSYS Simulation SErver Overview Screen"
The docker-compose command is the following:
docker-compose up -d
To build and run the image. Furthermore, the command:
docker-compose build
can be used to build a new image. The started docker container will run on port 1870,however it is possible to change this behaviour by setting the environmental variables PORT_FORWARDING, HOST, BROKER_SERVICE_HOST, BROKER_SERIVCE_PORT, PROSYS_OPCUA_SERVICE in the .env file.
An already built image is part of the repository and can be accessed here:
NOVAAS has been designed in order to be as generic as possible, if you want to run your own version of the NOVAAS you should perform the following steps:
- Add the environment model file within the folder "files/". Note that the name of the file must be kept -> model.aasx. In particular this file follows the data model provided in https://www.plattform-i40.de/PI40/Redaktion/EN/Downloads/Publikation/Details_of_the_Asset_Administration_Shell_Part1_V3.html and can be created by using the aasx-package-explorer tool (https://github.com/eclipse-aaspe/package-explorer); The aasx-package-explorer tool allows to save the environment model in several formats. However, the file format currently supported by NOVAAS is "aasx w/ JSON";
- Change the httpauth file in the folder "files/httpauth" properly;
- Run the docker and/or docker-compose commands.
###Notes
The current aasx model file has been generated using the following version of the AASX Explorer selecting the option aasx w/ JSON:
https://github.com/eclipse-aaspe/package-explorer/releases/tag/v2024-06-10.alpha