> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-mqtt/configure-client.md).

# Configure Client

The broker is configured in the Broker Details.

In the Broker Details, you can:

* Establish a connection to a broker
* Customize the existing connection data of the selected broker
* [↗ Create a Subscription](/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-mqtt/configure-a-subscription.md)

## Overview

<figure><img src="/files/wOUPdwXkxLRbMnEwYNmE" alt=""><figcaption><p>Fig. 1 – The Broker Details</p></figcaption></figure>

<table data-full-width="true"><thead><tr><th width="81.73332722981769">Symbol</th><th width="185.79998779296875">Description</th><th>Details</th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Section "Connection"</td><td>In this section, the connection data of the broker is configured</td></tr><tr><td><strong>[A1]</strong></td><td>Name</td><td>A name for the connection. This name appears in the broker list</td></tr><tr><td><strong>[A2]</strong></td><td>Client ID</td><td>Enter a Client ID. The MQTT Broker uses the Client ID to recognize when a client reconnects and to close any existing TCP connections.</td></tr><tr><td><strong>[A3]</strong></td><td>Host</td><td>Enter the host address of the broker to which you want to establish a connection</td></tr><tr><td><strong>[A4]</strong></td><td>Port</td><td>Enter the port of the broker. Usually (1883)</td></tr><tr><td><strong>[A5]</strong></td><td>Login</td><td>Enter the username for the broker here</td></tr><tr><td><strong>[A6]</strong></td><td>Password</td><td>Enter the password for the broker here</td></tr><tr><td><strong>[A7]</strong></td><td>More Options</td><td>Click to show or hide more options</td></tr><tr><td><strong>[A8]</strong></td><td>Keep Alive</td><td>This value indicates how much time elapses between two value transmissions until a client asks the broker whether it is still active.</td></tr><tr><td><strong>[A9]</strong></td><td>SOCKS5 Proxy</td><td>You can configure a proxy server</td></tr><tr><td><strong>[A10]</strong></td><td>Host</td><td>Enter the SOCKS5 host</td></tr><tr><td><strong>[A11]</strong></td><td>Port</td><td>Enter the SOCKS5 port</td></tr><tr><td><strong>[A12]</strong></td><td>Username</td><td>Enter the SOCKS5 username</td></tr><tr><td><strong>[A13]</strong></td><td>Password</td><td>Enter the SOCKS5 password</td></tr><tr><td><strong>[A14]</strong></td><td>Save</td><td>Click to save</td></tr><tr><td><strong>[B]</strong></td><td>Subscriptions</td><td>In this area, all subscriptions for the selected broker are displayed.</td></tr><tr><td><strong>[B1]</strong></td><td>Create subscription</td><td>Click this button to create a new subscription for this broker</td></tr><tr><td><strong>[B2]</strong></td><td>Edit subscription</td><td>Click this button to edit the corresponding subscription afterward</td></tr><tr><td><strong>[C]</strong></td><td>Publications</td><td>In this area, all publications for the selected broker are displayed</td></tr><tr><td><strong>[C1]</strong></td><td>Create publication</td><td>Click this button to create a new publication for this broker</td></tr><tr><td><strong>[C2]</strong></td><td>Edit publication</td><td>Click this button to edit the corresponding publication afterward</td></tr><tr><td><strong>[D]</strong></td><td>Connection status</td><td>In this area, the connection status from BuildingPro Suites to the current broker is displayed</td></tr><tr><td><strong>[D1]</strong></td><td>Test connection</td><td>Click here to test the connection to the broker</td></tr><tr><td><strong>[D2]</strong></td><td>Connection status</td><td>The connection status to the current broker is displayed here</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>

## Configure Broker

If you have just created the broker, the data under **\[A]** is empty.

Fill in the data and click on **Save \[A14]** to save the settings.

If necessary, check the connection (see next point).

## Check Connection

You can check whether the connection to the selected MQTT broker is valid.

1. Click on **\[D1]**

   ▷ Under **\[D2]**, the current connection status is displayed

## Create New Subscription

1. Click on **\[B1]** to create a new subscription

   ▷ The window [↗ Configure Subscription](/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-mqtt/configure-a-subscription.md) opens. Proceed as described there.

## Create New Publication

1. Click on **\[C1]** to create a new publication

   ▷ The window [↗ Configure Publication opens](/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-mqtt/configure-a-publication.md). Proceed as described there.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.buildings.ability.abb/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-mqtt/configure-client.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.