Configuration
voraus Robot UI reads these environment variables of the voraus-robot-ui service once at startup.
After a change, run docker compose up -d so that Compose recreates the container. Open browsers
reload on their own when a change affects them. A missing required variable stops the container at
startup with a message that names it. The defaults are those of the container image.
voraus Robot Control and Error Handler
| Variable | Default | Effect |
|---|---|---|
OPCUA_URL | opc.tcp://voraus-core:48401/ | OPC UA endpoint of voraus Robot Control. |
ERROR_HANDLER_ENABLED | true | Whether a dedicated Error Handler exists. With false, Reset goes to voraus Robot Control. |
OPCUA_ERROR_URL | opc.tcp://voraus-core:48404/ | OPC UA endpoint of the Error Handler. |
Pose Management
| Variable | Default | Effect |
|---|---|---|
PARAMETER_SERVER_ENABLED | true | Shows the Pose Management widget. |
PARAMETER_SERVER_URL | http://voraus-parameter:80 | Base URL of voraus Parameter as reachable from the container. |
3D Visualization
| Variable | Default | Effect |
|---|---|---|
VORAUS_3D_VISU_ENABLED | true | Shows the 3D Visualization widget. |
VORAUS_3D_VISU_BROWSER_URL | required when enabled | Base URL of voraus 3D Visualization as reachable from the browser. |
VORAUS_3D_VISU_SYNC_ENABLED | true | Whether voraus Robot UI adds the robot, the TCP frame, the jogging arrows, and the pose previews to voraus 3D Visualization. |
VORAUS_3D_VISU_SYNC_URL | required when sync is enabled | Base URL of voraus 3D Visualization as reachable from the container. |
VORAUS_CORE_URL | unset | URL of voraus.core as reachable from the container. When set, the robot configuration and the robot model for voraus 3D Visualization come from it, see Robot Files. |
VORAUS_CORE_ASSET_URL | value of VORAUS_CORE_URL | URL of voraus.core as reachable from voraus 3D Visualization, which loads the robot model from it. Only needed when that differs from VORAUS_CORE_URL. |
ROBOTS_DIR | /robots | Directory with the robot packages, used when VORAUS_CORE_URL is not set, see Robot Files. |
Robot Files
With the sync enabled, voraus Robot UI needs the robot configuration (robot.json) and the 3D
model (GLB) of the robot. It takes them from one of two sources:
-
voraus.core, when
VORAUS_CORE_URLis set. This is what the reference configuration does. voraus Robot UI reads the robot type and the configuration from voraus.core and voraus 3D Visualization loads the model from it, so voraus.core must be listed in theV3DVISU_ALLOWED_HOSTSof thevoraus-3d-visuservice. -
A mounted directory, when
VORAUS_CORE_URLis not set. voraus Robot UI reads the robot type from voraus Robot Control and opens the folder of that name inROBOTS_DIR, mounted into the container at/robots. The directory holds one folder per robot:robots/└── VORAUS_INDUSTRIAL_ROBOT/├── VORAUS_INDUSTRIAL_ROBOT.robot.json└── VORAUS_INDUSTRIAL_ROBOT.glbThe folder name is the robot type that voraus Robot Control reports. voraus Robot UI reads
<ROBOT_TYPE>.robot.jsonin it and uploads the model that itsVisualModel.Assetnames, resolved relative to the folder, to voraus 3D Visualization. This source needs a voraus Robot Control that reports the robot type in itsRobotTypenode, as voraus.core does since 2.30.0. voraus 3D Visualization rejects models above its upload limit; raiseV3DVISU_MAX_UPLOAD_SIZE_MBon thevoraus-3d-visuservice for a larger model.To switch the reference stack to the directory, save this override next to
docker-compose.yml, put the robot's folder into./robots, and start the stack with both files:docker-compose.robots-dir.yml# Reads the robot for voraus 3D Visualization from ./robots instead of voraus.core# (needs Compose 2.24+):# docker compose -f docker-compose.yml -f docker-compose.robots-dir.yml up -dservices:voraus-robot-ui:environment:VORAUS_CORE_URL: !reset nullvolumes:# One folder per robot, named like the robot type voraus Robot Control reports, with# <type>.robot.json and the GLB it names next to it.- ./robots:/robots:rodocker compose -f docker-compose.yml -f docker-compose.robots-dir.yml up -d
Advanced View
| Variable | Default | Effect |
|---|---|---|
ADVANCED_VIEW_DEFAULT | false | With true, a browser starts in the advanced view until its operator switches it off in the app menu. A browser keeps a view that differs from this default. A browser that is on the default follows a later change of the variable. |
Logging
| Variable | Default | Effect |
|---|---|---|
RUST_LOG | warn,voraus_robot_ui=info | Log filter of the container, shown by docker compose logs voraus-robot-ui. debug adds the retries and the OPC UA traffic. |
Licensing
CODEMETER_HOST names the host of the CodeMeter runtime that holds the license, the codemeter
service in the reference file. Every voraus service in the file is configured the same way.