wolfssl/IDE/Espressif/ESP-IDF/examples/template/README.md

wolfSSL Template Project

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

For general information on wolfSSL examples for Espressif, see the README file.

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.2. See also template for other devices.

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

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

Getting Started:

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

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

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

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

# build the example:
idf.py build

# optionally erase the flash
idf.py erase-flash -p /dev/ttyS19 -b 115200

# 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:

• TLS Client
• TLS Server
• Benchmark
• Test
• wolfssl-examples
• wolfssh-examples

See the README.md file in the upper level 'examples' directory for more information about examples.