Bivrost Gateway Protocol

This document is the communication protocol reference for the Bivrost gateway, version v1.19.7, intended for developers who need to integrate with the gateway programmatically. For instructions on installing and configuring the gateway and using its web management interface, please refer to the Bivrost Gateway Manual (referred to below as the “Manual”).

Communication Methods

HTTP CommunicationActively read/write machine data, transfer files, analyze data, and configure the gateway via HTTP interfaces. All features have corresponding interfaces.

MODBUS CommunicationThe gateway acts as a MODBUS server (port 502), storing automatic data collection task results in the corresponding address locations.

MQTT CommunicationThe gateway publishes automatic data collection task results as JSON messages to the specified MQTT server, and supports an RPC interface.

Database CommunicationThe gateway writes automatic data collection task results to the specified database (InfluxDB, MySQL, SQL Server, PostgreSQL, etc.).

MCP ServiceThe gateway's built-in MCP server exposes machine data, data analysis, and gateway status to AI clients as read-only tools.

Note

MODBUS, MQTT, and database communication all output the results of automatic data collection tasks. Before use, you need to enable the automatic data collection task for the target machine/group on the gateway management page (see the Manual, 5.3.1.2. Task Settings and 5.4.1.2. Group Task Settings) and restart the service.

Reading Guide

1. Start with 1. Important Notes for the common identifiers, data classes, and variable definitions.

2. Then consult the section for the communication method you use.

3. If you don’t have an actual machine tool available, use the mock machine to quickly test the communication protocol.

More Resources

FAQCommon errors and troubleshooting steps for each communication method.

Version Change HistoryProtocol and documentation changes in each gateway version.

Bivrost Gateway ManualInstructions for installing and configuring the gateway and using its web management interface.