/opentcs-commadapter-vda5050

An implementation of the VDA5050 interface for openTCS (by Fraunhofer IML)

Primary LanguageJavaMIT LicenseMIT

VDA5050 communication adapter for openTCS

This openTCS vehicle communication adapter implements the VDA5050 protocol specification versions 1.1 and 2.0, using JSON messages via MQTT. (openTCS vehicle communication adapter means it implements the interface on the openTCS side. If you are looking for an open-source library that helps you use VDA5050 on the vehicle side, check e.g. libVDA5050++, instead.)

How to use this driver

To be able to use this driver, its JAR file needs to be on the Java classpath of both the openTCS Kernel application as well as the Kernel Control Center application. Optionally you can also add it to the classpath of the Model Editor application for property key/value suggestions.

The artifact is published via Maven Central. In your openTCS integration project, add the following dependency to the build.gradle file with the respective application’s subproject, replacing <VERSION> with the appropriate driver version number:

implementation 'org.opentcs.commadapter.vehicle.vda5050:opentcs-commadapter-vda5050:<VERSION>'

Configuration

To make use of the driver, some configuration data needs to be made available to it as part of the kernel’s configuration files or as plant model elements or transport orders. Common configuration required for all VDA5050 specification versions is described in the following documents:

To use the driver with specific versions of the VDA5050 specification, the following documentation applies:

Licensing

Code

Unless stated otherwise, all of this software project’s source code, including scripts and configuration files, is distributed under the MIT License.

Assets

Unless stated otherwise, all of this software project’s documentation, resource bundles and media files are distributed under the Creative Commons Attribution 4.0 International (CC BY 4.0) license.

Contributing

This project is being maintained by the openTCS team at the Fraunhofer Institute for Material Flow and Logistics. You are very welcome to contribute to this project. Please see CONTRIBUTING.adoc for a few guidelines related to this.