Connect KODE MQTT to KODE OS for other data integration
Overview
Use this integration to publish and subscribe to MQTT topics through KODE OS. You map devices from broker metadata topics, collect delta sensor streams, and use schedules and actions where your broker and topic layout allow.
See KODE MQTT on the KODE Labs Integrations Library.
Supported Capabilities
- Discover Devices & Points
- Collect Sensor Data
- Discover Schedules
- Create Schedules
- Update Schedules
- Delete Schedules
Prerequisites
- Access to the MQTT broker used by KODE MQTT
- Broker hostname, port, and credentials
- KODE OS environment with access to Data Sources
Broker credentials
- Log in to the MQTT broker admin console or identity provider used by KODE MQTT
- Create or locate a broker user with subscribe (and publish, if actions or schedules are required) permissions
- Note the username, password, and any TLS certificate material
- Store these values securely — you will need them when configuring the connector in Cloud BMS
Configure Connector in Cloud BMS
- Navigate to Data Sources in your building
- Click API Catalog and search for KODE MQTT
- Click + Add Datasource
- Fill in the fields below and complete the three-page setup flow
Device and point mapping
MQTT connectors usually receive data as it arrives and often do not use a REST-style discovery step. Configure the metadata and telemetry topics so KODE OS can map devices from published messages. If your deployment exposes a Discover action, review mapped devices and register the ones you want in KODE OS. For more details on discovery behavior by protocol, see the Discovery guide and MQTT integrations.What Data You Get
Point History
Time-series sensor readings such as temperature, humidity, CO2, occupancy counts, energy consumption, light levels, and other measurable values from physical sensorsSchedule Sync
Schedule state synchronization data between KODE OS and the external system’s controller schedulesSchedule Sync (Partial)
Partial schedule synchronization for incremental schedule updatesPolling Schedule
- Point History — Default interval: 30 seconds (min: 30 seconds, max: 10 minutes)
Available Actions
This integration supports actions that allow you to send commands to the KODE MQTT system. Available actions are displayed on the device or entity detail page in KODE OS.Example Request
Expected Result
- KODE OS publishes the action to the configured command topic using the MQTT client credentials
- Devices or services subscribed to that topic process the command and may reply on the response topic
Schedule Management
This integration supports discovering and managing schedules in the KODE MQTT system. You can discover existing schedules, create new ones, and sync schedule states between KODE OS and the external system. For more details, see the Schedules guide.Use Cases
Once connected, this integration enables you to:- Centralize KODE MQTT data in your building operations dashboard
- Correlate data from this system with other building systems for comprehensive analytics
Troubleshooting
No data arriving from MQTT broker
No data arriving from MQTT broker
Verify the MQTT broker hostname, port, and credentials. Check that the topic patterns match the topics being published by the KODE MQTT devices. Ensure the MQTT client has subscribe permissions.
Discovery returns no devices
Discovery returns no devices
Confirm the metadata topic matches what devices publish and that the MQTT client has subscribe permissions on that topic. MQTT connectors often map devices from metadata messages rather than querying a REST catalog.
Data collection stops or gaps appear
Data collection stops or gaps appear
Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired broker credentials, network changes, or broker ACL restrictions.