Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.4 KB

README.md

File metadata and controls

47 lines (30 loc) · 2.4 KB

Disclaimer:
The UPT MQTT module is in early development and is not production ready.
It is not yet available through library managers. Have a look at the open issues to know what to expect.

Sensirion UPT MQTT Client

Arduino library for publishing messages to an MQTT broker.
It offers a simplified interface to the ESP-IDF mqtt_client libraries and optionaly handles Wi-Fi connectivity for you.

Getting started

Recommended Hardware

This project was developed and tested on Espressif ESP32 DevKitC and Lilygo T-Display S3 hardware.

IDE

PlatformIO (recommended)

We recommend using the PlatformIO VSCode extension to compile and flash the code in this example. You will find more instructions here

Arduino IDE

It is also possible to use the application using Arduino IDE. You will find more instructions here

Usage examples

Two example scripts are available in the examples folder:

  • delegatedWifiUsage: In this example the main application delegates the WiFi management to the MQTT client. Such approach should be used if your application does no use Wi-Fi overwise and you do not want any fancy Wi-Fi configuration.

  • selfManagedWifiUsage: In this example the main application will handle the WiFi management, and the MQTT client will not care about it. Such approach should be used in most cases since your application will likely use WiFi for other things.

API reference

You will find a more detailed API guide here

overview_schema

Dependencies

This library uses the following dependencies.