ESP-IDF

https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3
Admin
ESP-IDF is the Espressif IoT Development Framework providing tools, APIs, and components to develop...
Tokens:848,733
Snippets:9,958
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Application Startup Output

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/ble/get-started/ble-connection.html

Example output showing the application has started.

```text
...
main_task: Returned from app_main()
```

--------------------------------

### Static Timer Creation and Scheduler Start

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/freertos_idf.html

Example demonstrating the setup of a static timer and starting the FreeRTOS scheduler.

```c
*                                  prvTimerCallback, // The function to execute when the timer expires.
*                                  &xTimerBuffer );  // The buffer that will hold the software timer structure.
*
*     // The scheduler has not started yet so a block time is not used.
*     xReturned = xTimerStart( xTimer, 0 );
*
*     // ...
*     // Create tasks here.
*     // ...
*
*     // Starting the scheduler will start the timers running as they have already
*     // been set into the active state.
*     vTaskStartScheduler();
*
*     // Should not reach here.
*     for( ;; );
* }
```

--------------------------------

### Receive Queue Item Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/freertos_idf.html

Shows the initial setup for creating a queue and defining a task to post a value for later retrieval.

```c
struct AMessage
{
 char ucMessageID;
 char ucData[ 20 ];
} xMessage;

QueueHandle_t xQueue;

// Task to create a queue and post a value.
void vATask( void *pvParameters )
{
struct AMessage *pxMessage;
```

--------------------------------

### Implement Post-Attach Callback

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp_netif_driver.html

Example of a post-attach callback function that configures the driver and starts the network interface.

```c
static esp_err_t my_post_attach_start(esp_netif_t * esp_netif, void * args)
{
    my_netif_driver_t *driver = args;
    const esp_netif_driver_ifconfig_t driver_ifconfig = {
            .driver_free_rx_buffer = my_free_rx_buf,
            .transmit = my_transmit,
            .handle = driver->driver_impl
    };
    driver->base.netif = esp_netif;
    ESP_ERROR_CHECK(esp_netif_set_driver_config(esp_netif, &driver_ifconfig));
    my_driver_start(driver->driver_impl);
    return ESP_OK;
}
```

--------------------------------

### Build System Output Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/windows-setup.html

Example output showing the build process and the manual esptool command for flashing.

```text
$ idf.py build
Running cmake in directory /path/to/hello_world/build
Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"...
Warn about uninitialized values.
-- Found Git: /usr/bin/git (found version "2.17.0")
-- Building empty aws_iot component due to configuration
-- Component names: ...
-- Component paths: ...

... (more lines of build system output)

[527/527] Generating hello_world.bin
esptool.py v2.3.1

Project build complete. To flash, run this command:
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello_world.bin  build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
or run 'idf.py -p PORT flash'
```

--------------------------------

### Project Folder Structure Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/esp-idf-tests-with-pytest.html

Example directory layout for an application with multiple sdkconfig files.

```text
.
└── my_app/
    ├── main/
    │   └── ...
    ├── CMakeLists.txt
    ├── sdkconfig.ci.foo
    ├── sdkconfig.ci.bar
    └── pytest_foo.py

```

--------------------------------

### Install ESP-IDF Tools

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/windows-setup-update.html

Run the installation script from the ESP-IDF directory to download and install required tools.

```batch
install.bat
```

```powershell
install.ps1
```

--------------------------------

### MQTT Client Initialization and Start

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/protocols/mqtt.html

Demonstrates how to initialize the MQTT client with a broker URI, register an event handler, and start the client.

```APIDOC
## MQTT Client Initialization

### Description
Initializes the MQTT client using the provided configuration, registers an event handler for MQTT events, and starts the client connection.

### Code Example
```c
const esp_mqtt_client_config_t mqtt_cfg = {
    .broker.address.uri = "mqtt://mqtt.eclipseprojects.io",
};
esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
esp_mqtt_client_register_event(client, ESP_EVENT_ANY_ID, mqtt_event_handler, client);
esp_mqtt_client_start(client);
```
```

--------------------------------

### Navigate to NimBLE_Connection Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/ble/get-started/ble-connection.html

Command to change the working directory to the NimBLE_Connection example path.

```bash
$ cd <ESP-IDF Path>/examples/bluetooth/ble_get_started/nimble/NimBLE_Connection
```

--------------------------------

### Navigate to the BLE Example Directory

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/ble/get-started/ble-introduction.html

Use this command to change the working directory to the NimBLE GATT server example project.

```bash
$ cd <ESP-IDF Path>/examples/bluetooth/ble_get_started/nimble/NimBLE_GATT_Server
```

--------------------------------

### Install esp-idf-sbom

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-sbom.html

Install the tool from PyPI using pip.

```bash
$ pip install esp-idf-sbom
```

--------------------------------

### Define Scheduler Setup Server Model

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/bluetooth/esp-ble-mesh.html

Initializes a new Scheduler Setup Server Model, which extends the Scheduler Server and Scene Setup Server models.

```c
ESP_BLE_MESH_MODEL_SCHEDULER_SETUP_SRV(srv_pub, srv_data)
```

--------------------------------

### start

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp_eth.html

Starts the Ethernet MAC interface.

```APIDOC
## esp_err_t (*start)(esp_eth_mac_t *mac)

### Description
Start Ethernet MAC.

### Parameters
- **mac** (esp_eth_mac_t *) - [in] Ethernet MAC instance

### Return
- **ESP_OK**: start Ethernet MAC successfully
- **ESP_FAIL**: start Ethernet MAC failed because some other error occurred
```

--------------------------------

### Navigate to NimBLE_Beacon Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/ble/get-started/ble-device-discovery.html

Command to change the current directory to the NimBLE_Beacon example project.

```bash
$ cd <ESP-IDF Path>/examples/bluetooth/ble_get_started/nimble/NimBLE_Beacon
```

--------------------------------

### Install pre-commit package

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/install-pre-commit-hook.html

Install the pre-commit framework using pip.

```bash
pip install pre-commit
```

--------------------------------

### Install QEMU Binaries

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/qemu.html

Command to install the pre-built QEMU binaries for Xtensa and RISC-V architectures using the ESP-IDF tools script.

```bash
python $IDF_PATH/tools/idf_tools.py install qemu-xtensa qemu-riscv32
```

--------------------------------

### Install Ethernet Driver

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp_eth.html

Uses the ETH_DEFAULT_CONFIG macro to initialize the driver configuration and install the Ethernet driver.

```c
esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, phy); // apply default driver configuration
esp_eth_handle_t eth_handle = NULL; // after the driver is installed, we will get the handle of the driver
esp_eth_driver_install(&config, &eth_handle); // install driver
```

--------------------------------

### Install Prerequisites on Linux

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/linux-macos-setup.html

Commands to install necessary build packages for various Linux distributions.

```bash
sudo apt-get install git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
```

```bash
sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util libusbx
```

```bash
sudo pacman -S --needed gcc git make flex bison gperf python cmake ninja ccache dfu-util libusb python-pip
```

--------------------------------

### Define Scene Setup Server Model

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/bluetooth/esp-ble-mesh.html

Initializes a new Scene Setup Server Model, which extends the Scene Server and Generic Default Transition Time Server models.

```c
ESP_BLE_MESH_MODEL_SCENE_SETUP_SRV(srv_pub, srv_data)
```

--------------------------------

### Define Light LC Setup Server Model

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/bluetooth/esp-ble-mesh.html

Macro to define a new Light LC Setup Server model instance requiring pointers to publication and data structures.

```c
ESP_BLE_MESH_MODEL_LIGHT_LC_SETUP_SRV(srv_pub, srv_data)
```

--------------------------------

### C++ spaceship implementation example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/style-guide.html

Comprehensive example showing namespace usage, class inheritance, templates, and implementation file structure.

```C++
// file spaceship.h
#ifndef SPACESHIP_H_
#define SPACESHIP_H_
#include <cstdlib>

namespace spaceships {

class SpaceShip {
public:
    SpaceShip(size_t crew);
    size_t get_crew_size() const;

private:
    const size_t crew;
};

class SpaceShuttle : public SpaceShip {
public:
    SpaceShuttle();
};

class Sojuz : public SpaceShip {
public:
    Sojuz();
};

template <typename T>
class CargoShip {
public:
    CargoShip(const T &cargo);

private:
    T cargo;
};

} // namespace spaceships

#endif // SPACESHIP_H_

// file spaceship.cpp
#include "spaceship.h"

namespace spaceships {

// Putting the curly braces in the same line for constructors is OK if it only initializes
// values in the initializer list
SpaceShip::SpaceShip(size_t crew) : crew(crew) { }

size_t SpaceShip::get_crew_size() const
{
    return crew;
}

SpaceShuttle::SpaceShuttle() : SpaceShip(7)
{
    // doing further initialization
}

Sojuz::Sojuz() : SpaceShip(3)
{
    // doing further initialization
}

template <typename T>
CargoShip<T>::CargoShip(const T &cargo) : cargo(cargo) { }

} // namespace spaceships

```

--------------------------------

### Install QEMU System Dependencies

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/qemu.html

Commands to install required system libraries for QEMU on different Linux distributions and macOS.

```bash
sudo apt-get install -y libgcrypt20 libglib2.0-0 libpixman-1-0 libsdl2-2.0-0 libslirp0
```

```bash
sudo yum install -y --enablerepo=powertools libgcrypt glib2 pixman SDL2 libslirp
```

```bash
sudo pacman -S --needed libgcrypt glib2 pixman sdl2 libslirp
```

```bash
brew install libgcrypt glib pixman sdl2 libslirp
```

--------------------------------

### Define Time Setup Server Model

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/bluetooth/esp-ble-mesh.html

Initializes a new Time Setup Server Model, which extends the Time Server model and requires authorized access.

```c
ESP_BLE_MESH_MODEL_TIME_SETUP_SRV(srv_data)
```

--------------------------------

### esp_wifi_get_max_tx_power

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp_wifi.html

Get maximum transmitting power after WiFi start.

```APIDOC
## esp_wifi_get_max_tx_power

### Description
Get maximum transmitting power after WiFi start.

### Parameters
- **power** (int8_t *) - Required - Maximum WiFi transmitting power, unit is 0.25dBm.

### Returns
- **ESP_OK**: succeed
- **ESP_ERR_WIFI_NOT_INIT**: WiFi is not initialized
- **ESP_ERR_WIFI_NOT_STARTED**: WiFi is not started
- **ESP_ERR_INVALID_ARG**: invalid argument
```

--------------------------------

### Starting the Web Server

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/protocols/esp_http_server.html

Initializes the server with default configuration and registers URI handlers.

```c
//Function for starting the webserver
httpd_handle_t start_webserver(void)
{
// Generate default configuration
httpd_config_t config = HTTPD_DEFAULT_CONFIG();

// Empty handle to http_server
     httpd_handle_t server = NULL;

// Start the httpd server
if (httpd_start(&server, &config) == ESP_OK) {
// Register URI handlers
         httpd_register_uri_handler(server, &uri_get);
         httpd_register_uri_handler(server, &uri_post);
     }
// If server failed to start, handle will be NULL
return server;
}
```

--------------------------------

### Touch Element Initialization and Configuration Flow

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/peripherals/touch_element.html

Demonstrates the standard sequence for installing the library, configuring elements, subscribing to events, and setting up a callback-based dispatch method.

```c
static touch_xxx_handle_t element_handle; //Declare a touch element handle

//Define the subscribed event handler
void event_handler(touch_xxx_handle_t out_handle, touch_xxx_message_t out_message, void *arg)
{
    //Event handler logic
}

void app_main()
{
    //Using the default initializer to config Touch Element library
    touch_elem_global_config_t global_config = TOUCH_ELEM_GLOBAL_DEFAULT_CONFIG();
    touch_element_install(&global_config);

    //Using the default initializer to config Touch elements
    touch_xxx_global_config_t elem_global_config = TOUCH_XXXX_GLOBAL_DEFAULT_CONFIG();
    touch_xxx_install(&elem_global_config);

    //Create a new instance
    touch_xxx_config_t element_config = {
        ...
        ...
    };
    touch_xxx_create(&element_config, &element_handle);

    //Subscribe the specified events by using the event mask
    touch_xxx_subscribe_event(element_handle, TOUCH_ELEM_EVENT_ON_PRESS | TOUCH_ELEM_EVENT_ON_RELEASE, NULL);

    //Choose CALLBACK as the dispatch method
    touch_xxx_set_dispatch_method(element_handle, TOUCH_ELEM_DISP_CALLBACK);

    //Register the callback routine
    touch_xxx_set_callback(element_handle, event_handler);

    //Start Touch Element library processing
    touch_element_start();
}
```

--------------------------------

### Get Ethernet Driver Attributes

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp_eth.html

Retrieves the MAC address and PHY address using the esp_eth_ioctl function after the driver is installed.

```c
/* get MAC address */
uint8_t mac_addr[6];
memset(mac_addr, 0, sizeof(mac_addr));
esp_eth_ioctl(eth_handle, ETH_CMD_G_MAC_ADDR, mac_addr);
ESP_LOGI(TAG, "Ethernet MAC Address: %02x:%02x:%02x:%02x:%02x:%02x",
         mac_addr[0], mac_addr[1], mac_addr[2], mac_addr[3], mac_addr[4], mac_addr[5]);

/* get PHY address */
int phy_addr = -1;
esp_eth_ioctl(eth_handle, ETH_CMD_G_PHY_ADDR, &phy_addr);
ESP_LOGI(TAG, "Ethernet PHY Address: %d", phy_addr);
```

--------------------------------

### Copy the Hello World project

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/linux-macos-start-project.html

Copies the hello_world example project from the ESP-IDF directory to the local ~/esp directory.

```bash
cd ~/esp
cp -r $IDF_PATH/examples/get-started/hello_world .
```

--------------------------------

### Collect Tracing Data with OpenOCD

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/app_trace.html

Examples of using the 'esp apptrace start' command with various configurations for polling, size limits, and timeouts.

```bash
esp apptrace start file://trace.log 1 2048 5 0 0
```

```bash
esp apptrace start file://trace.log 1 -1 -1 0 0
```

```bash
esp apptrace start file://trace.log 0 -1 -1 0 0
```

```bash
esp apptrace start file://trace.log 0 2048 -1 1 0
```

--------------------------------

### esp_err_t uart_detect_bitrate_start(uart_port_t uart_num, const uart_bitrate_detect_config_t *config)

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/peripherals/uart.html

Starts the bitrate detection process for an incoming data signal on a specified UART port. This function can be used as a standalone API without requiring the UART driver to be installed.

```APIDOC
## esp_err_t uart_detect_bitrate_start(uart_port_t uart_num, const uart_bitrate_detect_config_t *config)

### Description
Starts the bitrate detection for an incoming data signal. It is recommended that the incoming data line contains alternating bit sequences like 0x55 or 0xAA.

### Parameters
- **uart_num** (uart_port_t) - Required - The ID of the UART port to be used. Only HP UART ports are supported.
- **config** (const uart_bitrate_detect_config_t*) - Required - Pointer to the configuration structure for the UART port.

### Returns
- **ESP_OK** - Success
- **ESP_ERR_INVALID_ARG** - Parameter error
- **ESP_FAIL** - No free UART port or invalid source clock
```

--------------------------------

### httpd_start()

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/protocols/esp_http_server.html

Creates an instance of the HTTP server, allocates necessary resources based on the provided configuration, and returns a handle to the server instance.

```APIDOC
## httpd_start()

### Description
Creates an instance of the HTTP server, allocates memory/resources for it based on the specified configuration, and outputs a handle to the server instance.

### Parameters
- **config** (httpd_config_t) - Required - Configuration structure containing task priority, stack size, and other server settings.

### Returns
- **handle** (httpd_handle_t) - The handle to the created server instance.
```

--------------------------------

### Initialize and Start MQTT Client

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/protocols/mqtt.html

Minimal configuration and initialization sequence for an MQTT client using a URI.

```c
const esp_mqtt_client_config_t mqtt_cfg = {
    .broker.address.uri = "mqtt://mqtt.eclipseprojects.io",
};
esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
esp_mqtt_client_register_event(client, ESP_EVENT_ANY_ID, mqtt_event_handler, client);
esp_mqtt_client_start(client);
```

--------------------------------

### Build Configuration Output

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/ble/get-started/ble-connection.html

Example output indicating successful project configuration.

```text
...
-- Configuring done
-- Generating done
-- Build files have been written to ...
```

--------------------------------

### ST32 Instruction Examples

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/ulp_instruction_set.html

Usage examples for the ST32 instruction.

```assembly
1:        ST32  R1, R2, 0x12, 0       // MEM[R2 + 0x12 / 4][31:0] = {PC[10:0],0[2:0],Label[1:0],Rsrc[15:0]}

2:        .data                       // Data section definition
  Addr1:  .word     123               // Define label Addr1 16 bit
          .set      offs, 0x00        // Define constant offs
          .text                       // Text section definition
          MOVE      R1, 1             // R1 = 1
          MOVE      R2, Addr1         // R2 = Addr1
          ST32      R1, R2, offs, 1   // MEM[R2 +  0] = {PC[10:0],0[2:0],Label[1:0],Rsrc[15:0]}
                                      // MEM[Addr1 + 0] will be 32'h00010001
```

--------------------------------

### STH Instruction Examples

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/ulp_instruction_set.html

Usage examples for the STH instruction.

```assembly
1:        STH  R1, R2, 0x12           // MEM[R2 + 0x12 / 4][31:16] = R1

2:        .data                       // Data section definition
  Addr1:  .word     123               // Define label Addr1 16 bit
          .set      offs, 0x00        // Define constant offs
          .text                       // Text section definition
          MOVE      R1, 1             // R1 = 1
          MOVE      R2, Addr1         // R2 = Addr1
          STH       R1, R2, offs      // MEM[R2 +  0 / 4] = R1
                                      // MEM[Addr1 + 0] will be 32'h0001xxxx
3:
          MOVE      R1, 1             // R1 = 1
          STH       R1, R2, 0x12, 1   // MEM[R2 + 0x12 / 4] 0x4001xxxx
```

--------------------------------

### Start the graphical configuration tool

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-py.html

Opens the menuconfig interface for project configuration.

```bash
idf.py menuconfig
```

--------------------------------

### esp_https_ota_begin

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/esp_https_ota.html

Initializes the HTTPS OTA context and establishes the connection to start the upgrade process.

```APIDOC
## esp_err_t esp_https_ota_begin(const esp_https_ota_config_t *ota_config, esp_https_ota_handle_t *handle)

### Description
Initializes the OTA context and establishes the HTTPS connection. This must be the first function called in a manual OTA sequence.

### Parameters
- **ota_config** (const esp_https_ota_config_t*) - Required - Pointer to the configuration structure.
- **handle** (esp_https_ota_handle_t*) - Required - Pointer to an allocated handle to be initialized.

### Returns
- **ESP_OK**: Context initialized and connection established.
- **ESP_FAIL**: Generic failure.
- **ESP_ERR_INVALID_ARG**: Invalid configuration or certificate.
- **ESP_ERR_HTTP_NOT_MODIFIED**: Image not modified on server.
```

--------------------------------

### Logging Output Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/log.html

Example of the console output generated by the logging macros.

```text
I (112500) MyModule: Baud rate error 1.5%. Requested: 115200 baud, actual: 116928 baud
W (112500) MyModule: Early log message 1
E TAG_IN_DRAM: DRAM log message 2
```

--------------------------------

### Create a Temperature Sensor Handle

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/peripherals/temp_sensor.html

Initialize the temperature sensor by defining a configuration structure with a specific range and installing the driver.

```c
temperature_sensor_handle_t temp_handle = NULL;
temperature_sensor_config_t temp_sensor_config = TEMPERATURE_SENSOR_CONFIG_DEFAULT(20, 50);
ESP_ERROR_CHECK(temperature_sensor_install(&temp_sensor_config, &temp_handle));
```

--------------------------------

### Queue Operations Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/freertos_idf.html

Demonstrates creating queues and sending data using xQueueSendToFront and xQueueSendToBack.

```c
// Create a queue capable of containing 10 uint32_t values.
 xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );

 // Create a queue capable of containing 10 pointers to AMessage structures.
 // These should be passed by pointer as they contain a lot of data.
 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );

 // ...

 if( xQueue1 != 0 )
 {
// Send an uint32_t.  Wait for 10 ticks for space to become
// available if necessary.
if( xQueueSendToFront( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )
     {
// Failed to post the message, even after 10 ticks.
     }
 }

 if( xQueue2 != 0 )
 {
// Send a pointer to a struct AMessage object.  Don't block if the
// queue is already full.
     pxMessage = & xMessage;
     xQueueSendToFront( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );
 }

 // ... Rest of task code.
}
```

```c
struct AMessage
{
 char ucMessageID;
 char ucData[ 20 ];
} xMessage;

uint32_t ulVar = 10UL;

void vATask( void *pvParameters )
{
QueueHandle_t xQueue1, xQueue2;
struct AMessage *pxMessage;

 // Create a queue capable of containing 10 uint32_t values.
 xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );

 // Create a queue capable of containing 10 pointers to AMessage structures.
 // These should be passed by pointer as they contain a lot of data.
 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );

 // ...

 if( xQueue1 != 0 )
 {
// Send an uint32_t.  Wait for 10 ticks for space to become
// available if necessary.
if( xQueueSendToBack( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )
     {
// Failed to post the message, even after 10 ticks.
     }
 }

 if( xQueue2 != 0 )
 {
// Send a pointer to a struct AMessage object.  Don't block if the
// queue is already full.
     pxMessage = & xMessage;
     xQueueSendToBack( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );
 }

 // ... Rest of task code.
}
```

```c
struct AMessage
{
 char ucMessageID;
 char ucData[ 20 ];
} xMessage;

uint32_t ulVar = 10UL;

void vATask( void *pvParameters )
{
QueueHandle_t xQueue1, xQueue2;
struct AMessage *pxMessage;

 // Create a queue capable of containing 10 uint32_t values.
 xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );

 // Create a queue capable of containing 10 pointers to AMessage structures.
 // These should be passed by pointer as they contain a lot of data.
 xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );

 // ...
```

--------------------------------

### Install ESP-IDF Tools

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/linux-macos-setup.html

Installs the required compiler and tools for specific chip targets.

```bash
cd ~/esp/esp-idf
./install.sh esp32s3
```

```fish
cd ~/esp/esp-idf
./install.fish esp32s3
```

```bash
cd ~/esp/esp-idf
./install.sh esp32,esp32s2
```

```fish
cd ~/esp/esp-idf
./install.fish esp32,esp32s2
```

```bash
cd ~/esp/esp-idf
./install.sh all
```

```fish
cd ~/esp/esp-idf
./install.fish all
```

--------------------------------

### Configure the project target and settings

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/linux-macos-start-project.html

Navigates to the project directory, sets the target chip to esp32s3, and opens the menuconfig utility.

```bash
cd ~/esp/hello_world
idf.py set-target esp32s3
idf.py menuconfig
```

--------------------------------

### Perform Unattended Installation

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-windows-installer.html

Executes the installer in silent mode without user interaction.

```bash
esp-idf-tools-setup-x.x.exe /VERYSILENT /SUPPRESSMSGBOXES /SP- /NOCANCEL
```

--------------------------------

### Install Build Dependencies

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/jtag-debugging/building-openocd-macos.html

Install required packages for compiling OpenOCD using Homebrew.

```bash
brew install automake libtool libusb wget gcc@4.9 pkg-config
```

--------------------------------

### Example build directory structure

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/esp-idf-tests-with-pytest.html

Visual representation of the directory structure for built binaries across different targets and configurations.

```text
.
├── build_esp32_history/
│   └── ...
├── build_esp32_nohistory/
│   └── ...
├── build_esp32s2_history/
│   └── ...
├── ...
├── main/
├── CMakeLists.txt
├── sdkconfig.ci.history
├── sdkconfig.ci.nohistory
└── ...
```

--------------------------------

### esp_ble_cs_security_enable

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/bluetooth/esp_gap_ble.html

Starts or restarts the Channel Sounding Security Start procedure in the local Controller.

```APIDOC
## esp_ble_cs_security_enable

### Description
This function is used to start or restart the Channel Sounding Security Start procedure in the local Controller.

### Parameters
- **conn_handle** (uint16_t) - Required - The ACL connection identified.

### Returns
- **ESP_OK** - Success
- **other** - Failed
```

--------------------------------

### Example Bootloader Image Info Output

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/bootloader_image_format.html

Sample output showing the structure of an ESP32-S3 bootloader image.

```text
File size: 26576 (bytes)

ESP32 image header
==================
Image version: 1
Entry point: 0x40080658
Segments: 4
Flash size: 2MB
Flash freq: 40m
Flash mode: DIO

ESP32 extended image header
===========================
WP pin: 0xee
Flash pins drive settings: clk_drv: 0x0, q_drv: 0x0, d_drv: 0x0, cs0_drv: 0x0, hd_drv: 0x0, wp_drv: 0x0
Chip ID: 0
Minimal chip revision: v0.0, (legacy min_rev = 0)
Maximal chip revision: v3.99

Segments information
====================
Segment   Length   Load addr   File offs  Memory types
-------  -------  ----------  ----------  ------------
    1  0x01bb0  0x3fff0030  0x00000018  BYTE_ACCESSIBLE, DRAM, DIRAM_DRAM
    2  0x03c90  0x40078000  0x00001bd0  CACHE_APP
    3  0x00004  0x40080400  0x00005868  IRAM
    4  0x00f2c  0x40080404  0x00005874  IRAM

ESP32 image footer
==================
Checksum: 0x65 (valid)
Validation hash: 6f31a7f8512f26f6bce7c3b270f93bf6cf1ee4602c322998ca8ce27433527e92 (valid)

Bootloader information
======================
Bootloader version: 1
ESP-IDF: v5.1-dev-4304-gcb51a3b-dirty
Compile time: Mar 30 2023 19:14:17
```

--------------------------------

### esp_err_t httpd_start(httpd_handle_t *handle, const httpd_config_t *config)

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/protocols/esp_http_server.html

Starts the web server by creating an instance and allocating necessary resources based on the provided configuration.

```APIDOC
## esp_err_t httpd_start(httpd_handle_t *handle, const httpd_config_t *config)

### Description
Starts the web server. Create an instance of HTTP server and allocate memory/resources for it depending upon the specified configuration.

### Parameters
- **config** (httpd_config_t*) - Required - Configuration for new instance of the server
- **handle** (httpd_handle_t*) - Required - Handle to newly created instance of the server. NULL on error

### Returns
- **ESP_OK** : Instance created successfully
- **ESP_ERR_INVALID_ARG** : Null argument(s)
- **ESP_ERR_HTTPD_ALLOC_MEM** : Failed to allocate memory for instance
- **ESP_ERR_HTTPD_TASK** : Failed to launch server task
```

--------------------------------

### Flash the project

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-py.html

Builds the project if necessary and flashes it to the target device.

```bash
idf.py flash
```

--------------------------------

### Install pytest dependencies

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/esp-idf-tests-with-pytest.html

Commands to install basic and test-specific dependencies for ESP-IDF pytest integration.

```bash
$ install.sh --enable-pytest
```

```bash
$ install.sh --enable-test-specific
```

--------------------------------

### Verify OpenOCD Installation

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/jtag-debugging/index.html

Check the installed version of OpenOCD to ensure the environment is correctly set up.

```bash
openocd --version
```

--------------------------------

### Enable Graphics Support

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/qemu.html

Launches QEMU with a virtual framebuffer device for graphics testing.

```bash
idf.py qemu --graphics monitor
```

--------------------------------

### Start ULP RISC-V Program

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/ulp-risc-v.html

Starts the execution of the previously loaded ULP RISC-V program.

```c
ESP_ERROR_CHECK( ulp_riscv_run() );
```

--------------------------------

### Example Application Output

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/windows-setup.html

Sample diagnostic and application logs displayed in the terminal after startup.

```text
    ...
    Hello world!
    Restarting in 10 seconds...
    This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2 MB embedded flash
Minimum free heap size: 390684 bytes
    Restarting in 9 seconds...
    Restarting in 8 seconds...
    Restarting in 7 seconds...
```

--------------------------------

### ROM Address Decoding Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-monitor.html

Example output when an address is resolved to a function within the ROM.

```text
abort() was called at PC 0x40007c69 on core 0
0x40007c69: ets_write_char in ROM

Backtrace: 0x40081656:0x3ffb4ac0 0x40085729:0x3ffb4ae0 0x4008a7ce:0x3ffb4b00 0x40007c69:0x3ffb4b70 0x40008148:0x3ffb4b90 0x400d51d7:0x3ffb4c20 0x400e31bc:0x3ffb4c50 0x40087bc5:0x3ffb4c80
0x40081656: panic_abort at /Users/espressif/esp-idf/components/esp_system/panic.c:452
0x40085729: esp_system_abort at /Users/espressif/esp-idf/components/esp_system/port/esp_system_chip.c:90
0x4008a7ce: abort at /Users/espressif/esp-idf/components/newlib/abort.c:38
0x40007c69: ets_write_char in ROM
0x40008148: ets_printf in ROM
0x400d51d7: app_main at /Users/espressif/esp-idf/examples/get-started/hello_world/main/hello_world_main.c:49
0x400e31bc: main_task at /Users/espressif/esp-idf/components/freertos/app_startup.c:208 (discriminator 13)
0x40087bc5: vPortTaskWrapper at /Users/espressif/esp-idf/components/freertos/FreeRTOS-Kernel/portable/xtensa/port.c:162
.....
```

--------------------------------

### touch_element_install

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/peripherals/touch_element.html

Initializes the touch element processing system.

```APIDOC
## esp_err_t touch_element_install(const touch_elem_global_config_t *global_config)

### Description
Initializes the touch element processing system. Call touch_element_uninstall() before reinitializing.

### Parameters
- **global_config** (const touch_elem_global_config_t *) - Required - Global initialization configuration structure

### Returns
- **ESP_OK**: Successfully initialized
- **ESP_ERR_INVALID_ARG**: Invalid argument
- **ESP_ERR_NO_MEM**: Insufficient memory
- **ESP_ERR_INVALID_STATE**: Touch element is already initialized
```

--------------------------------

### Initialize LwIP and Wi-Fi prerequisites

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp-wifi-mesh.html

Perform these steps to initialize the network stack and Wi-Fi driver before starting the mesh stack.

```c
ESP_ERROR_CHECK(esp_netif_init());

/*  event initialization */
ESP_ERROR_CHECK(esp_event_loop_create_default());

/*  Wi-Fi initialization */
wifi_init_config_t config = WIFI_INIT_CONFIG_DEFAULT();
ESP_ERROR_CHECK(esp_wifi_init(&config));
/*  register IP events handler */
ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &ip_event_handler, NULL));
ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_FLASH));
ESP_ERROR_CHECK(esp_wifi_start());
```

--------------------------------

### Example Mapping for Archive

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/linker-script-generation.html

A simple mapping example applying the 'noflash' scheme to all objects in an archive.

```text
[mapping:map]
archive: libfreertos.a
entries:
    * (noflash)
```

--------------------------------

### Run Application in QEMU

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/qemu.html

Starts the application in QEMU and connects the IDF monitor to the emulated UART.

```bash
idf.py qemu monitor
```

--------------------------------

### ESP_ERROR_CHECK Failure Output Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/error-handling.html

Example of the console output generated when an ESP_ERROR_CHECK macro fails.

```text
ESP_ERROR_CHECK failed: esp_err_t 0x107 (ESP_ERR_TIMEOUT) at 0x400d1fdf

file: "/Users/user/esp/example/main/main.c" line 20
func: app_main
expression: sdmmc_card_init(host, &card)

Backtrace: 0x40086e7c:0x3ffb4ff0 0x40087328:0x3ffb5010 0x400d1fdf:0x3ffb5030 0x400d0816:0x3ffb5050
```

--------------------------------

### Install Build Tools on macOS

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/get-started/linux-macos-setup.html

Commands to install CMake, Ninja, and DFU-util using package managers.

```bash
brew install cmake ninja dfu-util
```

```bash
sudo port install cmake ninja dfu-util
```

--------------------------------

### Configure NimBLE Host Stack

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/ble/get-started/ble-device-discovery.html

Sets up host callback functions and initializes the storage configuration.

```c
static void nimble_host_config_init(void) {
    /* Set host callbacks */
    ble_hs_cfg.reset_cb = on_stack_reset;
    ble_hs_cfg.sync_cb = on_stack_sync;
    ble_hs_cfg.store_status_cb = ble_store_util_status_rr;

    /* Store host configuration */
    ble_store_config_init();
}

void app_main(void) {
    ...

    /* NimBLE host configuration initialization */
    nimble_host_config_init();

    ...
}
```

--------------------------------

### Wait for Unattended Installation in PowerShell

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-windows-installer.html

Uses PowerShell to wait for the background installer process to complete after launching it.

```powershell
esp-idf-tools-setup-x.x.exe /VERYSILENT /SUPPRESSMSGBOXES /SP- /NOCANCEL
$InstallerProcess = Get-Process esp-idf-tools-setup
Wait-Process -Id $InstallerProcess.id
```

--------------------------------

### STI32 Usage Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/ulp_instruction_set.html

Demonstrates initializing the offset with STO and performing sequential STI32 operations.

```assembly
1:        STO    0x12
          STI32  R1, R2, 0    // MEM[R2 + 0x12 / 4][31:0] = {PC[10:0],0[2:0],Label[1:0],Rsrc[15:0]}
                              // offset += (1 * 4) //offset is incremented by 1 word
          STI32  R1, R2, 0    // MEM[R2 + 0x16 / 4][31:0] = {PC[10:0],0[2:0],Label[1:0],Rsrc[15:0]}
```

--------------------------------

### Configure and Install Clang-Tidy

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/tools/idf-clang-tidy.html

Commands to set the required toolchain, install necessary binaries, and refresh the environment.

```bash
IDF_TOOLCHAIN=clang
```

```bash
idf_tools.py install esp-clang
```

```bash
export.sh
```

--------------------------------

### ESP_BLE_MESH_MODEL_LIGHT_LC_SETUP_SRV

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/bluetooth/esp-ble-mesh.html

Macro to define a new Light LC Setup Server Model instance.

```APIDOC
## ESP_BLE_MESH_MODEL_LIGHT_LC_SETUP_SRV(srv_pub, srv_data)

### Description
Defines a new Light LC Setup Server Model. This model extends the Light LC Server model and is used to configure setup parameters.

### Parameters
- **srv_pub** (esp_ble_mesh_model_pub_t*) - Required - Pointer to the unique model publication structure.
- **srv_data** (esp_ble_mesh_light_lc_setup_srv_t*) - Required - Pointer to the unique model data structure.

### Returns
New Light LC Setup Server Model instance.
```

--------------------------------

### Install Build Dependencies

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/jtag-debugging/building-openocd-linux.html

Install the required system packages for compiling OpenOCD on Debian-based Linux distributions.

```bash
sudo apt-get install make
sudo apt-get install libtool
sudo apt-get install pkg-config
sudo apt-get install autoconf
sudo apt-get install automake
sudo apt-get install texinfo
sudo apt-get install libusb-1.0
```

--------------------------------

### Start the SNTP service

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp_netif_programming.html

Explicitly starts the SNTP service, typically called after network connection is established.

```c
esp_netif_sntp_start();
```

--------------------------------

### touch_button_install

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/peripherals/touch_element.html

Initializes the touch button global configuration for all touch button instances.

```APIDOC
## esp_err_t touch_button_install(const touch_button_global_config_t *global_config)

### Description
Initializes touch button global settings and acts on all touch button instances.

### Parameters
- **global_config** (const touch_button_global_config_t *) - [in] - Button object initialization configuration

### Returns
- **ESP_OK**: Successfully initialized touch button
- **ESP_ERR_INVALID_STATE**: Touch element library was not initialized
- **ESP_ERR_INVALID_ARG**: button_init is NULL
- **ESP_ERR_NO_MEM**: Insufficient memory
```

--------------------------------

### LD Usage Examples

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/ulp_instruction_set.html

Provides examples of direct memory loading and loading from a defined data label.

```assembly
1:        LD  R1, R2, 0x12            // R1 = MEM[R2 + 0x12 / 4]

2:        .data                       // Data section definition
  Addr1:  .word     123               // Define label Addr1 16 bit
          .set      offs, 0x00        // Define constant offs
          .text                       // Text section definition
          MOVE      R1, 1             // R1 = 1
          MOVE      R2, Addr1         // R2 = Addr1 / 4 (address of label is converted into words)
          LD        R1, R2, offs      // R1 = MEM[R2 +  0]
                                      // R1 will be 123
```

--------------------------------

### Enable documentation dependencies

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/documenting-code.html

Run this command to install the esp-docs Python package required for building documentation.

```bash
./install.sh --enable-docs
```

--------------------------------

### Example of -Waddress-of-packed-member Warning

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/migration-guides/release-5.x/5.0/gcc.html

An example of the compiler output generated when accessing an unaligned member of a packed struct.

```text
components/bt/host/bluedroid/btc/profile/std/gatt/btc_gatt_util.c: In function 'btc_to_bta_gatt_id':
components/bt/host/bluedroid/btc/profile/std/gatt/btc_gatt_util.c:105:21: warning: taking address of packed member of 'struct <anonymous>' may result in an unaligned pointer value [-Waddress-of-packed-member]
  105 |     btc_to_bta_uuid(&p_dest->uuid, &p_src->uuid);
      |                     ^~~~~~~~~~~~~
```

--------------------------------

### temperature_sensor_install

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/peripherals/temp_sensor.html

Instantiates the temperature sensor and returns a handle based on the provided configuration.

```APIDOC
## temperature_sensor_install

### Description
Installs the temperature sensor instance and returns a handle for further operations.

### Parameters
- **config** (temperature_sensor_config_t*) - Required - Pointer to the configuration structure containing range_min, range_max, and allow_pd.
- **ret_handle** (temperature_sensor_handle_t*) - Required - Pointer to store the returned sensor handle.
```

--------------------------------

### CSV Field Definition Examples

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/system/efuse.html

Examples of mapping fields to specific eFuse blocks and bit ranges.

```text
USER_DATA,          EFUSE_BLK3,    0,  256,     User data
USER_DATA.FIELD1,   EFUSE_BLK3,    16,  16,     Field1

ID,                 EFUSE_BLK4,    8,  3,      ID bit[0..2]
,                   EFUSE_BLK4,    16, 2,      ID bit[3..4]
,                   EFUSE_BLK4,    32, 3,      ID bit[5..7]
```

--------------------------------

### esp_mqtt_client_start

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/protocols/mqtt.html

Starts the MQTT client using a previously created client handle.

```APIDOC
## esp_mqtt_client_start

### Description
Starts the MQTT client with an already created client handle.

### Parameters
- **client** (esp_mqtt_client_handle_t) - Required - MQTT client handle

### Returns
- **esp_err_t** - ESP_OK on success, ESP_ERR_INVALID_ARG on wrong initialization, ESP_FAIL on other error
```

--------------------------------

### Segmentation Fault Backtrace Example

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-guides/host-apps.html

Example output showing a backtrace generated upon a segmentation fault.

```text
...
Hello world!
ERROR: Segmentation Fault, here's your backtrace:
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x2d1b)[0x55d3f636ad1b]
/lib/x86_64-linux-gnu/libc.so.6(+0x3c050)[0x7f49f0e00050]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x6198)[0x55d3f636e198]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x5909)[0x55d3f636d909]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x2c93)[0x55d3f636ac93]
path/to/esp-idf/examples/get-started/hello_world/build/hello_world.elf(+0x484e)[0x55d3f636c84e]
/lib/x86_64-linux-gnu/libc.so.6(+0x89134)[0x7f49f0e4d134]
/lib/x86_64-linux-gnu/libc.so.6(+0x1097dc)[0x7f49f0ecd7dc]
```

--------------------------------

### Install ESP-IDF Test Dependencies

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/contribute/esp-idf-tests-with-pytest.html

Install the necessary Python requirements for running pytest within the ESP-IDF environment.

```bash
$ cd $IDF_PATH
$ bash install.sh --enable-ci --enable-pytest
$ . ./export.sh
```

--------------------------------

### Start ESP-WIFI-MESH

Source: https://docs.espressif.com/projects/esp-idf/en/v5.5.4/esp32s3/api-reference/network/esp-wifi-mesh.html

Initiate the mesh network startup process.

```c
/* mesh start */
ESP_ERROR_CHECK(esp_mesh_start());
```
Tokens:
Raw