ZBOS RAIL MQTT API Reference

Here you can find the latest MQTT API version 2.12.1 to communicate with ZBOS devices.

Use the sidebar on the left to navigate the different sections. For the Cloud MQTT API, refer to the dedicated section: ZBOS Cloud MQTT API

Compatibility chart

The chart below shows the correct API version for specific RAIL releases:

RAIL version	MQTT API version
2.12.1	2.12.1
2.11.x	2.12.0
2.10.x	2.12.0
2.9.x	2.12.0
2.8.x	2.11.x
2.7.x	2.10.x
2.6.x	2.9.x
2.5.x	2.8.x
2.4.x	2.7.x
2.3.x	2.6.x
2.2.x	2.5.x
2.1.x	2.4.x
2.0.x	2.3.x

RAIL version

MQTT API version

2.12.1

2.11.x

2.12.0

2.10.x

2.12.0

2.9.x

2.12.0

2.8.x

2.11.x

2.7.x

2.10.x

2.6.x

2.9.x

2.5.x

2.8.x

2.4.x

2.7.x

2.3.x

2.6.x

2.2.x

2.5.x

2.1.x

2.4.x

2.0.x

2.3.x

API source

You can always find the source of the latest ZBOS API as well as older versions in the ZBOS MQTT API git repository.

These JSON files are in AsyncAPI format, which you can use to generate documentation or code for use in your own application (see: AsyncAPI Generator).

The zbos_mqtt-all-asyncapi.json contains the complete API, while the other files contain specific parts, so you can be selective and only use the parts you need in your App.

Learning

The easiest way to comprehend the ZBOS API is by looking at the communication between a robot and ZBOS Control. For that we can recommend using MQTT Explorer, a free cross-platform third party application that shows all MQTT communication in a handy tree-view.

Just connect the application via mqtt:// protocol with the local IP of your robot on port 1883 and start exploring!

All communication from ZBOS Control uses our public MQTT API, so when unsure how to do something, just perform the action with ZBOS Control and use the explorer to see how it was executed.