iot_skeleton/esp32/managed_components/espressif__esp_websocket_client/CHANGELOG.md

Changelog

1.6.1

Bug Fixes

• Fix race conditions, memory leak, and data loss (23ca97d5)
  • Add state check in abort_connection to prevent double-close
  • Fix memory leak: free errormsg_buffer on disconnect
  • Reset connection state on reconnect to prevent stale data
  • Implement lock ordering for separate TX lock mode
  • Read buffered data immediately after connection to prevent data loss
  • Added sdkconfig.ci.tx_lock config

1.6.0

Features

• add WEBSOCKET_EVENT_HEADER_RECEIVED (#827) (18f0d028, #715)
• enhance example with docs, pytest setup, and standalone test server - Add comprehensive README with TOC and quick start - Add pytest setup and certificate generation scripts - Add standalone WebSocket test server with TLS support - Add troubleshooting and multiple testing approaches (cad527d2)
• Add websocket HTTP redirect (ce1560ac)

Bug Fixes

• remove redundant timeout check in client task loop (1e83bee4)
• fix PING timing - enable periodic PING during active traffic (7f424325)
• Update linux build docs on required libs (e52a5757)
• clean up component dependencies - Remove unused 'json', 'nvs_flash', 'esp_stubs', dependency from Linux build configuration - Add cJSON dependency to target example's idf_component.yml (d665e6f1)
• fix relying on asprintf() to NULL strp on failure (54eb0027)
• Update Remaining Websocket Echo Server (#893) (18faeb3d)
• avoid long stopping time when waiting to auto-reconnect (2432e41d)
• Update Websocket Echo Server (94bd5b07)

Updated

• ci(common): Update test component dir for IDFv6.0 (18418c83)

1.5.0

Features

• add separate tx lock for send and receive (250eebf)
• add unregister event to websocket client (ce16050)
• add ability to reconnect after close (19891d8)

Bug Fixes

• release client-lock during WEBSOCKET_EVENT_DATA (030cb75)

1.4.0

Features

• Support DS peripheral for mutual TLS (55385ec3)

Bug Fixes

• wait for task on destroy (42674b49)
• Fix pytest to verify client correctly (9046af8f)
• propagate error type (eeeb9006)
• fix example buffer leak (5219c39d)

Updated

• chore(websocket): align structure members (beb6e57e)
• chore(websocket): remove unused client variable (15d3a01e)

1.3.0

Features

• add events for begin/end thread (d7fa24bc)
• Make example to use certificate bundle (aecf6f80)
• propagate esp_tls stack error and cert verify flags (234f579b)
• Add option to set and use cert_common_name in Websocket client (3a6720de)
• adding support for if_name when using WSS transport (333a6893)
• allow updating reconnect timeout for retry backoffs (bd9f0627)
• allow using external tcp transport handle (83ea2876)
• adding support for keep_alive_enable when using WSS transport (c728eae5)

Bug Fixes

• Prevent crash on network disconnect during send (a453ca1f)
• use proper interface to delete semaphore (991ac40d)
• Move client to different state when disconnecting (0d8f2a6d)
• fix of websocket host example (5ccc018a)
• don't get transport from the list if external transport is used (9d4d5d2d)
• Fix locking issues of esp_websocket_client_send_with_exact_opcode API (6393fcd7)

1.2.3

Features

• Expanded example to demonstrate the transfer over TLS (0d0630ed76)

Bug Fixes

• fix esp_event dependency management (1fb02a9a60)
• Skip warn on zero timeout and auto reconnect is disabled (5b467cbf5c)
• Fixed to use int return value in Tx functions (9c54b72e1f)
• Fixed Tx functions with DYNAMIC_BUFFER (16174470ee)
• added dependency checks, sdkconfig.defaults and refined README.md (312982e4aa)
• Close websocket and dispatch event if server does not close within a reasonable amount of time. (d85311880d)
• Continue waiting for TCP connection to be closed (2b092e0db4)

Updated

• docs(websocket): Added README for websocket host example (2f7c58259d)

1.2.2

Bug Fixes

• continuation after FIN in websocket client (#460) (774d1c75e6)
• Re-applie refs to common comps idf_component.yml (9fe44a4504)

1.2.1

Bug Fixes

• consider failure if return value of esp_websocket_client_send_with_exact_opcode less than 0 (f523b4d)
• fix of return value for esp_websocket_client_send_with_opcode API (ba33588)

1.2.0

Features

• Added new API esp_websocket_client_append_header (39e9725)
• Added new APIs to support fragmented messages transmission (fae80e2)

Bug Fixes

• Reference common component from IDF (74fc228)
• Revert referencing protocol_examples_common from IDF (b176d3a)
• reference protocol_examples_common from IDF (025ede1)
• specify override_path in example manifests (d5e7898)
• Return status code correctly on esp_websocket_client_send_with_opcode (ac8f1de)
• Fix pytest exclusion, gitignore, and changelog checks (2696221)

1.1.0

Features

• Added linux port for websocket (a22391a)

Bug Fixes

• added idf_component.yml for examples (d273e10)

1.0.1

Bug Fixes

• esp_websocket_client client allow sending 0 byte packets (b5177cb)
• Cleaned up printf/format warnings (-Wno-format) (e085826)
• Added unit tests to CI + minor fix to pass it (c974c14)
• Reintroduce missing CHANGELOGs (200cbb3, #235)

Updated

• docs(common): updated component and example links (f48d9b2)
• docs(common): improving documentation (ca3fce0)
• Fix weird error message spacings (8bb207e)

1.0.0

Updated

• esp_websocket_client: Updated version to 1.0.0 Updated tests to run agains release-v5.0 (996fef7)
• esp_websocket_client: * Error handling improved to show status code from server * Added new API esp_websocket_client_set_headers * Dispatches 'WEBSOCKET_EVENT_BEFORE_CONNECT' event before tcp connection (d047ff5)
• unite all tags under common structure py test: update tags under common structure (c6db3ea)
• websocket: Support HTTP basic authorization (1b13448)
• Add task_name config option (1d68884)
• Add websocket error messages (d68624e)
• websocket: Added new API esp_websocket_client_destroy_on_exit (f9b4790)
• Added badges with version of components to the respective README files (e4c8a59)

0.0.4

Updated

• websocket: make esp_websocket_client_send_with_opcode a public API (3330b96)
• websocket: updated example to use local websocket echo server (55dc564)
• CI: Created a common requirements.txt (23a537b)
• Examples: using pytest.ini from top level directory (aee016d)
• CI: fixing the files to be complient with pre-commit hooks (945bd17)
• websocket: updated example to show json data transfer (3456781)

0.0.3

Updated

• esp_websocket_client: Upgraded version to 0.0.3 (5c245db)
• CI: Fix build issues (6e4e4fa)

0.0.2

Features

• Optimize memory size for websocket client init (4cefcd3)
• allow users to attach CA bundle (d56b5d9)

Bug Fixes

• Docs to refer esp-protocols (91a177e)

Updated

• Bump asio/mdns/esp_websocket_client versions (57afa38)
• ignore format warnings (d66f9dc)
• Minor fixes here and there (8fe2a3a)
• CI: Added CI example run job (76298ff)
• Implement websocket client connect error (9e37f53)
• Add methods to allow get/set of websocket client ping interval (e55f54b)
• esp_websocket_client: Expose frame fin flag in websocket event (b72a9ae)

0.0.1

Updated

• websocket: Initial version based on IDF 5.0 (80c3cf0)
• freertos: Remove legacy data types (b3c777a, IDF@57fd78f)
• websocket: Added configs reconnect_timeout_ms and network_timeout_ms (8ce791e, IDF#8263, IDF@6c26d65)
• Add http_parser (new component) dependency (bece6e7, IDF@8e94cf2)
• websocket: removed deprecated API "esp_websocket_client_send" (46bd32d, IDF@7f6ab93)
• refactor (test_utils)!: separate file for memory check functions (525c70c, IDF@16514f9)
• Build & config: Remove leftover files from the unsupported "make" build system (19c0455, IDF@766aa57)
• transport: Add CONFI_WS_TRANSPORT for optimize the code size (9118e0f, IDF@8b02c90)
• ws_client: Fix const correctness in the API config structure (fbdbd55, IDF@70b1247)
• components: Remove repeated keep alive function by ssl layer function (de7cd72, IDF@c79a907)
• components: Support bind socket to specified interface in esp_http_client and esp_websocket_client component (4a608ec, IDF@bead359)
• esp_websocket_client: Don't log the filename when logging "Websocket already stop" (f0351ff, IDF@10bde42)
• websocket: Add websocket unit tests (9219ff7, IDF@cd01a0c)
• websockets: Set keepalive options after adding transport to the list (86aa0b8, IDF@99805d8)
• websocket: Add configurable ping interval (1933367, IDF@9ff9137)
• ws_transport: Add option to propagate control packets to the app (95cf983, IDF#6307, IDF@acc7bd2)
• Add options for esp_http_client and esp_websocket_client to support keepalive (8a6c320, IDF@b53e46a)
• websocket: support mutual tls for websocket Closes https://github.com/espressif/esp-idf/issues/6059 (d1dd6ec, IDF#6059, IDF@5ab774f)
• Whitespace: Automated whitespace fixes (large commit) (d376480, IDF@66fb5a2)
• Websocket client: avoid deadlock if stop called from event handler (e90272c, IDF@c2bb076)
• tcp_transport: Added internal API for underlying socket, used for custom select on connection end for WS (6d12d06, IDF@5e9f8b5)
• ws_client: Added support for close frame, closing connection gracefully (1455bc0, IDF@b213f2c)
• driver, http_client, web_socket, tcp_transport: remove FILE from log messages (01b4f64, IDF#5637, IDF@caaf62b)
• websocket_client : fix some issues for websocket client (6ab0aea, IDF@341e480)
• websocket: add configurable timeout for PONG not received (b71c49c, IDF@0049385)
• websocket client: the client now aborts the connection if send fails. (f8e3ba7, IDF@6bebfc8)
• ws_client: fix fragmented send setting proper opcodes (7a5b2d5, IDF#4974, IDF@14992e6)
• esp32: add implementation of esp_timer based on TG0 LAC timer (17281a5, IDF@739eb05)
• tcp_transport/ws_client: websockets now correctly handle messages longer than buffer (aec6a75, IDF@ffeda30)
• websocket: added missing event data (a6be8e2, IDF@7c0e376)
• Add User-Agent and additional headers to esp_websocket_client (a48b0fa, IDF@9200250)
• ws_client: fix handling timeouts by websocket client. (1fcc001, IDF#4316, IDF@e1f9829)
• websocket_client: fix locking mechanism in ws-client task and when sending data (d0121b9, IDF@7c5011f)
• ws_client: fix for not sending ping responses, updated to pass events also for PING and PONG messages, added interfaces to send both binary and text data (f55d839, IDF@abf9345)
• websocket_client: fix URI parsing to include also query part in websocket connection path (f5a26c4, IDF@271e6c4)
• ws_client: fixed posting to event loop with websocket timeout (23f6a1d, IDF@5050506)
• ws_client: added subprotocol configuration option to websocket client (2553d65, IDF@de6ea39)
• ws_client: fixed path config issue when ws server configured using host and path instead of uri (67949f9, IDF@c0ba9e1)
• ws_client: fixed transport config option when server address configured as host, port, transport rather then uri (bfc88ab, IDF@adee25d)
• esp_wifi: wifi support new event mechanism (4d64495, IDF@003a987)
• tools: Mass fixing of empty prototypes (for -Wstrict-prototypes) (da74a4a, IDF@afbaf74)
• ws_client: fix double delete issue in ws client initialization (f718676, IDF@9b507c4)
• ws_client: removed dependency on internal tcp_transport header (13a40d2, IDF@d143356)
• examples: use new component registration api (35d6f9a, IDF@6771eea)
• esp_websocket_client: Add websocket client component (f3a0586, IDF#2829, IDF@2a2d932)