Skip to content

Process Orchestration Layer for Research

License

Notifications You must be signed in to change notification settings

p2o-lab/polaris-backend

Repository files navigation

polaris-backend

Polaris is a Process Orchestration Layer application for controlling process equipment assemblies (PEA) in the context of modular production in process industries. Thus, it follows the VDI/VDE/NAMUR 2658 standards. polaris-backend is a NodeJs application which can be controlled via REST. Furthermore it provides recent state changes via websockets. For testing and debugging purposes, polaris-backend provides also a testserver which behaves like a PEA.

A HTML user interface for this project is provided via the polaris-frontend project.

Build Status Docker Badge MicroBadger Size Greenkeeper badge CodeFactor codecov

Polaris component diagram

Installation and Deployment

Dependencies

All dependencies are installed via NPM

npm install
npm run build

Start

npm start

or use ready binary (which should also be installed globally and in modules)

./bin/polaris-backend

Available CLI options are provided by:

./bin/polaris-backend -h

Docker

Use ready docker image, which are automatically updated during drone.io integration

docker pull p2olab/polaris-backend
docker run -d -p 3000:3000 p2olab/polaris-backend

Usage

After starting polaris-backend its REST interface is available under http://localhost:3000

polaris-backend has several command line parameters which are documented by calling npm start -- -h

Its documentation is served by the application under the path /doc (e.g. http://localhost:3000/doc)

Test Process Equipment Assembly

Polaris can serve a test PEA with an OPC UA server via port 4334. It has two services with some parameters and some other variables which change over time. You can start this testserver via

npm run testserver

or

./bin/test-pea

or via docker container

docker run -p 4334:4334 p2olab/test-pea

The corresponding JSON file assets/modules/module_testserver_1.0.0.json can be directly loaded in Polaris.