This library for ESP32 to connect to ThingsBoard IoT platform over MQTT protocol, thin wrapper on ESP-MQTT component, which can be used under ESP-IDF and ESP-ADF.

Current version is based on ESP-IDF-v4.4.x, and is compatible with ThingsBoard IoT platform starting from version 3.4.x.

Supported ThingsBoard MQTT API Features

Example implementations for all features can be found in the examples folder.

How to use

ESP32 ThingsBoard MQTT Client library is a ESP-IDF component. Please refer to ESP-IDF for more usage instructions.

Git or download code of this library;

Modify your project's CMakeLists.txt, insert this line set(EXTRA_COMPONENT_DIRS ..../components/tbcmh)， replace .... with your library path, eg:

cmake_minimum_required(VERSION 3.5)

set(EXTRA_COMPONENT_DIRS C:/esp32-thingsboard-mqtt-client/components/tbcmh)

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(hello_world)

And/or modify your project's Makefile, insert this line EXTRA_COMPONENT_DIRS := ..../components/tbcmh, replace .... with your library path, eg:

PROJECT_NAME := hello_world

EXTRA_COMPONENT_DIRS := C:/esp32-thingsboard-mqtt-client/components/tbcmh

include $(IDF_PATH)/make/project.mk

Now, you can call API in
- tbc_mqtt_helper.h
- tbc_extension.h

A simplified version example

Modify your entry function:

void app_main(void)
{
    ESP_LOGI(TAG, "[APP] Startup..");
    ESP_LOGI(TAG, "[APP] Free memory: %d bytes", esp_get_free_heap_size());
    ESP_LOGI(TAG, "[APP] IDF version: %s", esp_get_idf_version());

    esp_log_level_set("*", ESP_LOG_INFO); //ESP_LOG_DEBUG

    ESP_ERROR_CHECK(nvs_flash_init());
    ESP_ERROR_CHECK(esp_netif_init());
    ESP_ERROR_CHECK(esp_event_loop_create_default());

    /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
     * Read "Establishing Wi-Fi or Ethernet Connection" section in
     * examples/protocols/README.md for more information about this function.
     */
    ESP_ERROR_CHECK(example_connect());

    mqtt_app_start();
}

Modify the main function of the MQTT application:

void mqtt_app_start(void)
{
    ESP_LOGI(TAG, "Init tbcmh ...");
    tbcmh_handle_t client = tbcmh_init();
    if (!client) {
        ESP_LOGE(TAG, "Failure to init tbcmh!");
        return;
    }

    ESP_LOGI(TAG, "Connect tbcmh ...");
    tbc_transport_config_esay_t config = {
        .uri = "mqtt://192.168.0.187",          // TODO: replace it with your ThingsBoard URI
        .access_token = "mKqOP8kQwxdDsVnCRU20", // TODO: replace it with your device's Access Token in ThingsBoard
        .log_rxtx_package = true                // Print Rx/Tx MQTT package
     };
    bool result = tbcmh_connect_using_url(client, &config,
                        NULL, tb_on_connected, tb_on_disconnected);
    if (!result) {
        ESP_LOGE(TAG, "failure to connect to tbcmh!");
        goto exit_destroy;
    }

    ESP_LOGI(TAG, "connect tbcmh ...");
    int i = 0;
    while (i<4) {
        if (tbcmh_has_events(client)) {
            tbcmh_run(client);
        }

        i++;
        if (tbcmh_is_connected(client)) {
            tbcmh_telemetry_upload(client, "{\"temprature\": 25.5}",
                    1/*qos*/, 0/*retain*/);
        } else {
            ESP_LOGI(TAG, "Still NOT connected to server!");
        }
        sleep(5);
    }

    ESP_LOGI(TAG, "Disconnect tbcmh ...");
    tbcmh_disconnect(client);

exit_destroy:
    ESP_LOGI(TAG, "Destroy tbcmh ...");
    tbcmh_destroy(client);
}

Add two callback functions:

/*!< Callback of connected ThingsBoard MQTT */
void tb_on_connected(tbcmh_handle_t client, void *context)
{
    ESP_LOGI(TAG, "Connected to thingsboard server!");
}

/*!< Callback of disconnected ThingsBoard MQTT */
void tb_on_disconnected(tbcmh_handle_t client, void *context)
{
    ESP_LOGI(TAG, "Disconnected from thingsboard server!");
}

Modify EXTRA_COMPONENT_DIRS in Makefile and CMakeLists.txt of your project to using this library。

Run the program, you will receive a log similar to:

...
I (5607) example_connect: Got IPv6 event: Interface "example_connect: sta" address: fe80:0000:0000:0000:bedd:c2ff:fed1:beb0, type: ESP_IP6_ADDR_IS_LINK_LOCAL
I (6107) esp_netif_handlers: example_connect: sta ip: 192.168.0.126, mask: 255.255.255.0, gw: 192.168.0.1
I (6107) example_connect: Got IPv4 event: Interface "example_connect: sta" address: 192.168.0.126
I (6117) example_connect: Connected to example_connect: sta
I (6117) example_connect: - IPv4 address: 192.168.0.126
I (6127) example_connect: - IPv6 address: fe80:0000:0000:0000:bedd:c2ff:fed1:beb0, type: ESP_IP6_ADDR_IS_LINK_LOCAL
I (6137) TELEMETRY_UPLOAD_MAIN: Init tbcmh ...
I (6147) TELEMETRY_UPLOAD_MAIN: Connect tbcmh ...
I (6147) tb_mqtt_client_helper: connecting to mqtt://192.168.0.187:1883 ...
I (6157) TELEMETRY_UPLOAD_MAIN: connect tbcmh ...
I (6157) tb_mqtt_client_helper: TBCM_EVENT_BEFORE_CONNECT, msg_id=0
I (6167) TELEMETRY_UPLOAD_MAIN: Still NOT connected to server!
I (11177) tb_mqtt_client_helper: TBCM_EVENT_CONNECTED
I (11177) tb_mqtt_client_helper: client->tbmqttclient = 0x3ffc5c24
I (11177) tb_mqtt_client_helper: Connected to thingsboard MQTT server!
I (11177) tb_mqtt_client_helper: before call on_connected()...
I (11187) TELEMETRY_UPLOAD_MAIN: Connected to thingsboard server!
I (11197) tb_mqtt_client_helper: after call on_connected()
I (11197) tb_mqtt_wapper: [Telemetry][Tx] {"temprature": 25.5}
I (16217) tb_mqtt_client_helper: TBCM_EVENT_PUBLISHED, msg_id=4395
I (16217) tb_mqtt_wapper: [Telemetry][Tx] {"temprature": 25.5}
I (21217) tb_mqtt_client_helper: TBCM_EVENT_PUBLISHED, msg_id=3118
I (21217) tb_mqtt_wapper: [Telemetry][Tx] {"temprature": 25.5}
I (26217) TELEMETRY_UPLOAD_MAIN: Disconnect tbcmh ...
I (26217) tb_mqtt_client_helper: disconnecting from mqtt://192.168.0.187:1883 ...
I (26217) tb_mqtt_client_helper: TBCM_EVENT_PUBLISHED, msg_id=63413
I (26327) tb_mqtt_wapper: tbcm_disconnect(): call esp_mqtt_client_stop()...
I (26337) tb_mqtt_wapper: tbcm_disconnect(): call esp_mqtt_client_destroy()...
W (26337) MQTT_CLIENT: Client asked to stop, but was not started
I (26437) TELEMETRY_UPLOAD_MAIN: Destroy tbcmh ...
I (26437) tb_mqtt_client_helper: It already disconnected from thingsboard MQTT server!