wolfmqtt_template

Example of the component wolfssl/wolfmqtt v1.18.0-preview8e

wolfSSL Template Project

This is an example minimally viable wolfSSL + wolfMQTT template to get started with your own project.

For details on wolfMQTT see the wolfMQTT Manual.

Prerequisites

It is assumed the ESP-IDF environment has been installed.

Files Included

  • main.c with a simple call to an Espressif library (ESP_LOGI) and a call to a wolfSSL library (esp_ShowExtendedSystemInfo) .

  • See components/wolfssl/include directory to edit the wolfSSL user_settings.h.

  • Edit main/CMakeLists.txt to add/remove source files.

  • The components/wolfssl/CMakeLists.txt typically does not need to be changed.

  • Optional VisualGDB Project for Visual Studio using ESP32 and ESP-IDF v5.1.

  • Edit the project CMakeLists.txt to optionally point this project's wolfSSL component source code at a different directory:

Plaintext

set(WOLFSSL_ROOT "~/workspace/wolfssl-other-source")

Getting Started with ESP Registry Managed Components:

The quickest way to get started is with wolfMQTT Managed Components.

Coming soon. See Staging Site.

Getting Started with ESP-IDF local examples:

Here's an example using the command-line idf.py:

Edit your WRK_IDF_PATHto point to your ESP-IDF install directory.

Plaintext

WRK_IDF_PATH=/mnt/c/SysGCC/esp32/esp-idf/v5.1

echo "Run export.sh from ${WRK_IDF_PATH}"
. ${WRK_IDF_PATH}/export.sh

# build the example:
idf.py build

# flash the code onto the serial device at /dev/ttyS19
idf.py flash -p /dev/ttyS19 -b 115200

# build, flash, and view UART output with one command:
idf.py flash -p /dev/ttyS19 -b 115200 monitor

Press Ctrl+] to exit idf.py monitor. See additional monitor keyboard commands.

Other Examples:

For examples, see:

To create a project from this example, run:

idf.py create-project-from-example "wolfssl/wolfmqtt=1.18.0-preview8e:wolfmqtt_template"

or download archive (~15.67 KB)