Logo
openPOWERLINK
An open-source POWERLINK protocol stack

Documentation

The documentation of the openPOWERLINK stack is maintained as part of the source code distribution. It can be compiled into HTML format and viewed online.

The documentation of the latest version is found below.

Online documentation

Version
V2.6 2.6.0 (html)
V2.5 2.5.0 (html) 2.5.1 (html) 2.5.2 (html)
V2.4 2.4.0 (html) 2.4.1 (html)
V2.3 2.3.0 (html) 2.3.1 (html) 2.3.2 (html)
V2.2 2.2.0 (html) 2.2.1 (html) 2.2.2 (html)
V2.1 2.1.0 (html) 2.1.1 (html) 2.1.2 (html)
V2.0 2.0.0 (html) 2.0.1 (html) 2.0.2 (html)

How to generate the documentation

The documentation of the openPOWERLINK protocol stack can be found in the subdirectory "doc" in the source code package. It is written in markdown markup format. The openPOWERLINK software manual can be generated from the markdown documentation and the in-source documentation with the tool Doxygen. Doxygen version 1.8 or higher is required.

To generate the software manual:
> cd doc/software-manual
> doxygen

The software manual will be created in HTML format under doc/software-manual/html.