# MQTT client

<!-- BEGIN GENERATED: __badges_mqttclient__ -->
<span class="badge stable">STABLE</span> <span class="badge origin-nymea">NYMEA</span> <span class="badge community">COMMUNITY</span>

Subscribe to the internal or an external MQTT broker and send and receive MQTT messages.

<!-- END GENERATED -->

_Installation guide coming soon._

## Reference

<!-- BEGIN GENERATED: integrationpluginmqttclient.json -->
!!! info "Application labels"
    The keys and labels below are the ones the application shows,
    **in English**. They are left verbatim so that you find them
    word for word on screen.

**Manufacturer:** nymea  
**Plugin:** `mqttclient`

#### Supported models
| Model | Role | Transport | Pairing | Quantities |
| --- | --- | --- | --- | --- |
| **Internal MQTT client** | inputtrigger, outputtrigger | — | Manual | 0 |
| **MQTT client** | inputtrigger, outputtrigger | — | Manual | 0 |

#### Per-model detail
??? abstract "Internal MQTT client — `internalMqttClient`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `topicFilter` | Subscription topic filter | QString | — | `#` | no |

??? abstract "MQTT client — `mqttClient`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `serverAddress` | Address | QString | — | — | no |
    | `serverPort` | Port | int | 0–65535 | `1883` | no |
    | `username` | Username | QString | — | — | no |
    | `clientId` | Client Id | QString | — | `nymea` | no |
    | `password` | Password | QString | — | — | no |
    | `topicFilter` | Subscription topic filter | QString | — | `#` | no |
    | `useSsl` | Use SSL | bool | — | `False` | no |
    | `willTopic` | Will topic | QString | — | — | no |
    | `willMessage` | Will message | QString | — | — | no |
    | `willRetain` | Retain will | bool | — | `False` | no |
    | `willQoS` | Will QoS | uint | 0–2 | `0` | no |
    | `keepAlive` | Keep alive | uint | 0–65535 | `60` | no |

<!-- END GENERATED -->