espressif/libwebsockets

4.3.3

uploaded 1 month ago
The component provides a simple ESP-IDF port of libwebsockets client.

readme

# ESP32 libwebsockets Port

This is a lightweight port of the libwebsockets library designed to run on the ESP32. It provides WebSocket client functionalities.

## Supported Options

The ESP-IDF port of libwebsockets supports a set of common WebSocket configurations for clients. These options can be configured through a structure passed to the `lws_create_context()` function.

Key features supported:
- WebSocket with optional SSL/TLS
- HTTP/1.1 client support

## Memory Footprint Considerations

The memory consumption primarily depends on the number of concurrent connections and the selected options for WebSocket frames, protocol handling, and SSL/TLS features. It consumes approximately 300 kB of program memory.

### Client:
The values bellow were extracted from the client example (./examples/client/main/lws-client.c)
- **Initial Memory Usage**: ~8 kB of heap on startup
- **Connected Memory Usage Over TLS**: ~35.3 kB of heap after connected to a server
- **Connected Memory Usage Over TCP (Plain)**: ~4.5 kB of heap after connected to a server

#### When configuring a WebSocket client, ensure that you have enough heap space to handle the desired number of concurrent client connections.
#### SSL/TLS configurations may require additional memory overhead, depending on the certificate size and cryptographic settings.

Links

Supports all targets

License: Custom

To add this component to your project, run:

idf.py add-dependency "espressif/libwebsockets^4.3.3"

or download archive

Stats

  • Archive size
    Archive size ~ 19.21 MB
  • Downloaded in total
    Downloaded in total 25 times
  • Downloaded this version
    This version: 25 times

Badge

espressif/libwebsockets version: 4.3.3
|