MQTT Integration

This page provides everything you need — from configuration to practical examples using MQTT topics and payloads.

Setup

After you connect your Doorman to your Wi-Fi network, it will pulse red and blue. This means the MQTT broker is not yet configured.

1. Open the web interface and go to the MQTT Configuration section.

2. Enter your MQTT broker credentials.

   

   If you don't see these settings, scroll to the bottom and click "Show all".

3. Save the settings — the firmware will then try to connect to your MQTT broker.

4. If it connects successfully, the status LED will light up solid blue for 3 seconds to confirm.

Topics

Various topics are published to your broker. Here's how the topic structure and controls work.

Structure

Each entity publishes its state to a topic in the following format:

<TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/state

You can control certain entities by publishing a telegram to this topic format:

Topic

<TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/command

Payload

ON or OFF or whatever is supported

Example

To enable or disable the Ring-To-Open automation, send ON or OFF as the payload to the topic:

Topic

doorman-s3/switch/ring_to_open/command

Payload

ON

Special Topics

Certain special topics allow for advanced telegrams.

Send a Bus Telegram (Hexadecimal)

Here's an example of how to send a hexadecimal telegram (uint32) to the bus:

Topic

doorman-s3/send_tc_raw_telegram

Payload

{
    "telegram": 0x1C30BA80
}

Advanced Payload

{
    "telegram": 0x00000680,
    "is_long": true
}

Send a Bus Telegram (Telegram Builder)

Here's an example of how to use the telegram builder to send a telegram to the bus:

Topic

doorman-s3/send_tc_telegram

Payload

{
    "type": "open_door",
    "address": 0,
    "payload": 0,
    "serial_number": 123456
}

Send a Indoor Station Telegram (Telegram Builder)

Here's an example of how to use the telegram builder to send a telegram to the bus:

Topic

doorman-s3/send_tc_is_telegram

Payload

{
    "type": "open_door",
    "address": 0,
    "payload": 0,
}

Receive parsed telegrams

Each telegram is published on a special topic. The messages contain the parsed telegram data.

Topic

doorman-s3/last_telegram

Payload

{
    "telegram": "1100",
    "type": "open_door",
    "address": "0",
    "payload": "0",
    "serial_number": "0"
}