# SOFTWARE DOCUMENTATION

> Documentation for voraus - the industrial automation software platform.

**Develop, simulate and run** robots, drives and peripherals on standard industrial PCs.

- **voraus.core** - the real-time runtime: motion, fieldbus (EtherCAT, PROFINET), I/O, OPC UA
- **voraus.pioneer** -  virtual commissioning, automated tests, CI
- **Components** - libraries, integrations and examples (Python, Rust)

New here? Start with the Software Manual.

Every page has two addresses. The readable one, `/<project>/<version>/<page>`, is a JavaScript
application that renders the page inside a frame, so a plain HTTP fetch of it returns an empty shell.
The static one, `/static/projects/<project>/<version>/<page>`, is the page itself as server-rendered
HTML. Fetch the static address.

Quote the readable one. The two differ by nothing but the `/static/projects` prefix, and a person
handed a link wants the page inside the interface, with its navigation, version picker and search,
rather than the bare file. Read from the static address, pass on the readable one.

`latest` stands in for a version and resolves to the newest published one, so
`/static/projects/<project>/latest/index.html` stays correct as versions are added. The
links below name a resolved version instead, because that is what is newest right now.

The REST API described by `https://docs.vorausrobotik.com/openapi.json` lists projects, versions and categories as JSON.

## General

- [Software Manual 2.3.3](https://docs.vorausrobotik.com/static/projects/voraus-software-manual/2.3.3/index.html): the newest of 26 published versions

## Examples

- [voraus.pioneer Examples 1.18.0](https://docs.vorausrobotik.com/static/projects/voraus-pioneer-examples/1.18.0/index.html): the newest of 9 published versions

## Components

- [3D Visu (Visualization) 3.1.2](https://docs.vorausrobotik.com/static/projects/voraus-3d-visu/3.1.2/index.html): the newest of 26 published versions
- [EtherCAT Master 2.2.0](https://docs.vorausrobotik.com/static/projects/voraus-ethercat-master/2.2.0/index.html): the newest of 11 published versions
- [EtherCAT Python Client 2.0.0](https://docs.vorausrobotik.com/static/projects/voraus-ecat-py/2.0.0/index.html): the newest of 10 published versions
- [Roboception 0.8.6](https://docs.vorausrobotik.com/static/projects/voraus-roboception-app/0.8.6/index.html): the newest of 5 published versions
- [Robot Arm (Robot Interface) 1.6.0](https://docs.vorausrobotik.com/static/projects/voraus-robot-arm-py/1.6.0/index.html): the newest of 16 published versions
- [Robot Control 20.3.0](https://docs.vorausrobotik.com/static/projects/voraus-robot-control/20.3.0/index.html): the newest of 6 published versions
- [Simulation 0.11.3](https://docs.vorausrobotik.com/static/projects/voraus-simulation/0.11.3/index.html): the newest of 16 published versions

## Page indexes

One request that enumerates every page of a version, instead of crawling it:

- [3D Visu (Visualization) 3.1.2 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-3d-visu/3.1.2/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [EtherCAT Python Client 2.0.0 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-ecat-py/2.0.0/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [EtherCAT Master 2.2.0 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-ethercat-master/2.2.0/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [voraus.pioneer Examples 1.18.0 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-pioneer-examples/1.18.0/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [Roboception 0.8.6 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-roboception-app/0.8.6/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [Robot Arm (Robot Interface) 1.6.0 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-robot-arm-py/1.6.0/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [Robot Control 20.3.0 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-robot-control/20.3.0/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [Simulation 0.11.3 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-simulation/0.11.3/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)
- [Software Manual 2.3.3 objects.inv](https://docs.vorausrobotik.com/static/projects/voraus-software-manual/2.3.3/objects.inv): Sphinx inventory of every page and cross-reference target (zlib-compressed)