v1.3.1 to improve stability

### Releases v1.3.1 1. Increase `ASYNC_QUEUE_LENGTH` to default 512 from 32 and make it user-configurable 2. Increase `ASYNC_TCP_PRIORITY` to default 10 from 3, and make it user-configurable
khoih-prog · Sep 18, 2022 · 8029070 · 8029070
1 parent 043ba06
commit 8029070
Show file tree

Hide file tree

Showing 13 changed files with 140 additions and 93 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
-* `ESP32` Core Version (e.g. ESP32 core v2.0.4)
+* `ESP32` Core Version (e.g. ESP32 core v2.0.5)
 * `ESP32` Board type (e.g. ESP32_DEV, ESP32_S2, ESP32_S3, ESP32_C3, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
@@ -28,7 +28,7 @@ Please ensure to specify the following:
 
 ```
 Arduino IDE version: 1.8.19
-ESP32 core v2.0.4
+ESP32 core v2.0.5
 ESP32_DEV Module
 OS: Ubuntu 20.04 LTS
 Linux xy-Inspiron-3593 5.15.0-46-generic #49~20.04.1-Ubuntu SMP Thu Aug 4 19:15:44 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux

diff --git a/README.md b/README.md
@@ -57,7 +57,9 @@
 
 ### Important Note for ESP32_S3
 
-**Don't use `ESP32_S3` with core v2.0.4**. Check [ESP32-S3 Powercycling right after uploading a sketch using Arduino IDE and Arduino Core 2.0.4 #7165](https://github.com/espressif/arduino-esp32/issues/7165)
+**Don't use `ESP32_S3` with core v2.0.4**. Check `already fixed` [ESP32-S3 Powercycling right after uploading a sketch using Arduino IDE and Arduino Core 2.0.4 #7165](https://github.com/espressif/arduino-esp32/issues/7165)
+
+**ESP32_S3 is OK now with core v2.0.5**
 
 ---
 
@@ -101,7 +103,7 @@ to apply the better and faster **asynchronous** feature of the **powerful** [Asy
 1. `ESP32` boards, such as ESP32_DEV, etc.
 2. `ESP32_S2`-based boards, such as ESP32S2_DEV, ESP32_S2 Saola, etc.
 3. `ESP32_C3`-based boards, such as ESP32C3_DEV, etc.
-4. `ESP32_S3`-based boards, such as ESP32S3_DEV, etc., using ESP32 core `v2.0.3`
+4. `ESP32_S3`-based boards, such as ESP32S3_DEV, etc., using ESP32 core `v2.0.3` or `v2.0.5+`
 
 
 ---
@@ -110,8 +112,8 @@ to apply the better and faster **asynchronous** feature of the **powerful** [Asy
 ## Prerequisites
 
  1. [`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [![GitHub release](https://img.shields.io/github/release/arduino/Arduino.svg)](https://github.com/arduino/Arduino/releases/latest)
- 2. [`ESP32 Core 2.0.4+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/) for ESP32, ESP32_S2, ESP32_C3
- 3. [`ESP32 Core 2.0.3`](https://github.com/espressif/arduino-esp32) for ESP32_S3-based boards. For ESP32_S3 until [ESP32-S3 Powercycling right after uploading a sketch using Arduino IDE and Arduino Core 2.0.4 #7165](https://github.com/espressif/arduino-esp32/issues/7165) is fixed.
+ 2. [`ESP32 Core 2.0.5+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/) for ESP32, ESP32_S2, ESP32_C3
+ 3. [`ESP32 Core 2.0.4`](https://github.com/espressif/arduino-esp32) can't be used for ESP32_S3-based boards. Check `already fixed` [ESP32-S3 Powercycling right after uploading a sketch using Arduino IDE and Arduino Core 2.0.4 #7165](https://github.com/espressif/arduino-esp32/issues/7165)
 
 ---
 ---
@@ -280,46 +282,46 @@ Following is the debug terminal when running example [AsyncHTTPSRequest_ESP](htt
 
 ```
 Starting AsyncHTTPSRequest_ESP using ESP32_DEV
-AsyncTCP_SSL v1.3.0
-AsyncHTTPSRequest_Generic v2.1.0
+AsyncTCP_SSL v1.3.1
+AsyncHTTPSRequest_Generic v2.1.2
 Connecting to WiFi SSID: HueNet1
 .......
 AsyncHTTPSRequest @ IP : 192.168.2.133
 
 **************************************
 abbreviation: EDT
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-04T19:41:10.727385-04:00
+datetime: 2022-09-18T01:35:32.451975-04:00
 day_of_week: 0
-day_of_year: 247
+day_of_year: 261
 dst: true
 dst_from: 2022-03-13T07:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-11-06T06:00:00+00:00
 raw_offset: -18000
 timezone: America/Toronto
-unixtime: 1662334870
-utc_datetime: 2022-09-04T23:41:10.727385+00:00
+unixtime: 1663479332
+utc_datetime: 2022-09-18T05:35:32.451975+00:00
 utc_offset: -04:00
-week_number: 35
+week_number: 37
 **************************************
 HHHHHH
 **************************************
 abbreviation: EDT
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-04T19:42:10.039223-04:00
+datetime: 2022-09-18T01:36:31.992595-04:00
 day_of_week: 0
-day_of_year: 247
+day_of_year: 261
 dst: true
 dst_from: 2022-03-13T07:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-11-06T06:00:00+00:00
 raw_offset: -18000
 timezone: America/Toronto
-unixtime: 1662334930
-utc_datetime: 2022-09-04T23:42:10.039223+00:00
+unixtime: 1663479391
+utc_datetime: 2022-09-18T05:36:31.992595+00:00
 utc_offset: -04:00
-week_number: 35
+week_number: 37
 ```
 ---
 
@@ -329,8 +331,8 @@ Following is the debug terminal when running example [AsyncHTTPSRequest_ESP](htt
 
 ```
 Starting AsyncHTTPSRequest_ESP using ESP32S2_DEV
-AsyncTCP_SSL v1.3.0
-AsyncHTTPSRequest_Generic v2.1.0
+AsyncTCP_SSL v1.3.1
+AsyncHTTPSRequest_Generic v2.1.2
 Connecting to WiFi SSID: HueNet1
 .......
 AsyncHTTPSRequest @ IP : 192.168.2.79
@@ -361,19 +363,19 @@ AsyncHTTPSRequest @ IP : 192.168.2.79
 **************************************
 abbreviation: EDT
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-04T19:27:33.745787-04:00
+datetime: 2022-09-18T01:46:31.858783-04:00
 day_of_week: 0
-day_of_year: 247
+day_of_year: 261
 dst: true
 dst_from: 2022-03-13T07:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-11-06T06:00:00+00:00
 raw_offset: -18000
 timezone: America/Toronto
-unixtime: 1662334053
-utc_datetime: 2022-09-04T23:27:33.745787+00:00
+unixtime: 1663479991
+utc_datetime: 2022-09-18T05:46:31.858783+00:00
 utc_offset: -04:00
-week_number: 35
+week_number: 37
 **************************************
 ```
 
@@ -385,27 +387,27 @@ Following is the debug terminal when running example [AsyncHTTPSRequest_ESP](htt
 
 ```
 Starting AsyncHTTPSRequest_ESP using ESP32C3_DEV
-AsyncTCP_SSL v1.3.0
-AsyncHTTPSRequest_Generic v2.1.0
+AsyncTCP_SSL v1.3.1
+AsyncHTTPSRequest_Generic v2.1.2
 Connecting to WiFi SSID: HueNet1
 .........
 AsyncHTTPSRequest @ IP : 192.168.2.80
 **************************************
 abbreviation: EDT
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-04T19:27:33.745787-04:00
+datetime: 2022-09-18T01:35:32.451975-04:00
 day_of_week: 0
-day_of_year: 247
+day_of_year: 261
 dst: true
 dst_from: 2022-03-13T07:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-11-06T06:00:00+00:00
 raw_offset: -18000
 timezone: America/Toronto
-unixtime: 1662334053
-utc_datetime: 2022-09-04T23:27:33.745787+00:00
+unixtime: 1663479332
+utc_datetime: 2022-09-18T05:35:32.451975+00:00
 utc_offset: -04:00
-week_number: 35
+week_number: 37
 **************************************
 ```
 
@@ -417,9 +419,9 @@ Following is the debug terminal when running example [AsyncHTTPSRequest_ESP_WiFi
 
 ```
 Starting AsyncHTTPSRequest_ESP_WiFiManager using LittleFS on ESP32_DEV
-ESPAsync_WiFiManager v1.11.0
-AsyncTCP_SSL v1.3.0
-AsyncHTTPSRequest_Generic v2.1.0
+ESPAsync_WiFiManager v1.14.1
+AsyncTCP_SSL v1.3.1
+AsyncHTTPSRequest_Generic v2.1.2
 Stored: SSID = HueNet1, Pass = 12345678
 Got stored Credentials. Timeout 120s
 ConnectMultiWiFi in setup
@@ -428,19 +430,19 @@ H
 **************************************
 abbreviation: EDT
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-04T19:41:10.727385-04:00
+datetime: 2022-09-18T01:36:31.992595-04:00
 day_of_week: 0
-day_of_year: 247
+day_of_year: 261
 dst: true
 dst_from: 2022-03-13T07:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-11-06T06:00:00+00:00
 raw_offset: -18000
 timezone: America/Toronto
-unixtime: 1662334870
-utc_datetime: 2022-09-04T23:41:10.727385+00:00
+unixtime: 1663479391
+utc_datetime: 2022-09-18T05:36:31.992595+00:00
 utc_offset: -04:00
-week_number: 35
+week_number: 37
 **************************************
 H
 ```
@@ -454,8 +456,8 @@ Following is the debug terminal when running example [AsyncHTTPSRequest_ESP_Mult
 
 ```
 Starting AsyncHTTPSRequest_ESP_Multi on ESP32S3_DEV
-AsyncTCP_SSL v1.3.0
-AsyncHTTPSRequest_Generic v2.1.0
+AsyncTCP_SSL v1.3.1
+AsyncHTTPSRequest_Generic v2.1.2
 Connecting to WiFi SSID: HueNet1
 ...
 AsyncHTTPSRequest @ IP : 192.168.2.187
@@ -464,58 +466,59 @@ Sending request: https://worldtimeapi.org/api/timezone/Europe/Prague.txt
 
 Sending request: https://www.myexternalip.com/raw
 [AHTTPS] _onError handler SSL error = OK
+[AHTTPS] _onError handler SSL error = OK
+
+**************************************
+[AHTTPS] Response Code =  HTTP OK
+
+**************************************
+aaa.bbb.ccc.ddd
+**************************************
 
 **************************************
 [AHTTPS] Response Code =  HTTP OK
 
 **************************************
 abbreviation: CEST
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-05T01:27:33.313946+02:00
-day_of_week: 1
-day_of_year: 248
+datetime: 2022-09-18T07:50:04.395849+02:00
+day_of_week: 0
+day_of_year: 261
 dst: true
 dst_from: 2022-03-27T01:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-10-30T01:00:00+00:00
 raw_offset: 3600
 timezone: Europe/Prague
-unixtime: 1662334053
-utc_datetime: 2022-09-04T23:27:33.313946+00:00
+unixtime: 1663480204
+utc_datetime: 2022-09-18T05:50:04.395849+00:00
 utc_offset: +02:00
-week_number: 36
+week_number: 37
 **************************************
 
-Sending request: [AHTTPS] _onError handler SSL error = OK
-https://worldtimeapi.org/api/timezone/America/Toronto.txt
+Sending request: https://worldtimeapi.org/api/timezone/America/Toronto.txt
 
 **************************************
 [AHTTPS] Response Code =  HTTP OK
 
 **************************************
 abbreviation: EDT
 client_ip: aaa.bbb.ccc.ddd
-datetime: 2022-09-04T19:27:33.745787-04:00
+datetime: 2022-09-18T01:50:05.382100-04:00
 day_of_week: 0
-day_of_year: 247
+day_of_year: 261
 dst: true
 dst_from: 2022-03-13T07:00:00+00:00
 dst_offset: 3600
 dst_until: 2022-11-06T06:00:00+00:00
 raw_offset: -18000
 timezone: America/Toronto
-unixtime: 1662334053
-utc_datetime: 2022-09-04T23:27:33.745787+00:00
+unixtime: 1663480205
+utc_datetime: 2022-09-18T05:50:05.382100+00:00
 utc_offset: -04:00
-week_number: 35
-**************************************
-
-**************************************
-[AHTTPS] Response Code =  HTTP OK
-
-**************************************
-aaa.bbb.ccc.ddd
+week_number: 37
 **************************************
+H
 ```
 
 ---
@@ -559,14 +562,17 @@ Submit issues to: [AsyncTCP_SSL issues](https://github.com/khoih-prog/AsyncTCP_S
 
 ## DONE
 
-1. Add support to ESP32 using SSL
-2. Add Table of Contents
-3. Add debug feature
-4. Fix `multiple-definitions` linker error
-5. Add example
-6. Remove hard-code if possible
-7. Improve debug messages by adding functions to display `error/state messages` instead of `cryptic error/state number`
-8. Add support to `ESP32_S3`, using ESP32 core `v2.0.3`. **Don't use `ESP32_S3` with core v2.0.4**. Check [ESP32-S3 Powercycling right after uploading a sketch using Arduino IDE and Arduino Core 2.0.4 #7165](https://github.com/espressif/arduino-esp32/issues/7165)
+ 1. Add support to ESP32 using SSL
+ 2. Add Table of Contents
+ 3. Add debug feature
+ 4. Fix `multiple-definitions` linker error
+ 5. Add examples
+ 6. Remove hard-code if possible
+ 7. Improve debug messages by adding functions to display `error/state messages` instead of `cryptic error/state number`
+ 8. Add support to `ESP32_S3`, using ESP32 core `v2.0.3`. **Don't use `ESP32_S3` with core v2.0.4**. Check [ESP32-S3 Powercycling right after uploading a sketch using Arduino IDE and Arduino Core 2.0.4 #7165](https://github.com/espressif/arduino-esp32/issues/7165)
+ 9. Increase `ASYNC_QUEUE_LENGTH` to default **512 from 32** and make it user-configurable
+10. Increase `ASYNC_TCP_PRIORITY` to default **10 from 3**, and make it user-configurable
+
 
 ---
 ---

diff --git a/changelog.md b/changelog.md
@@ -11,6 +11,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.3.1](#Releases-v131)
   * [Releases v1.3.0](#Releases-v130)
   * [Releases v1.2.0](#Releases-v120)
   * [Releases v1.1.0](#Releases-v110)
@@ -21,6 +22,12 @@
 
 ## Changelog
 
+### Releases v1.3.1
+
+1. Increase `ASYNC_QUEUE_LENGTH` to default 512 from 32 and make it user-configurable
+2. Increase `ASYNC_TCP_PRIORITY` to default 10 from 3, and make it user-configurable
+
+
 ### Releases v1.3.0
 
 1. Remove hard-code if possible

diff --git a/examples/multiFileProject/multiFileProject.h b/examples/multiFileProject/multiFileProject.h
@@ -12,5 +12,11 @@
 
 #pragma once
 
+// Use larger queue size if necessary for large data transfer. Default is 512 bytes if not defined here
+#define ASYNC_QUEUE_LENGTH     512
+
+// Use larger priority if necessary. Default is 10 if not defined here. Must be > 4 or adjusted to 4
+#define CONFIG_ASYNC_TCP_PRIORITY   (12)
+
 // Can be included as many times as necessary, without `Multiple Definitions` Linker Error
 #include "AsyncTCP_SSL.hpp"
diff --git a/examples/multiFileProject/multiFileProject.ino b/examples/multiFileProject/multiFileProject.ino
@@ -14,8 +14,8 @@
   #error This code is intended to run on the ESP32 platform! Please check your Tools->Board setting.
 #endif
 
-#define ASYNC_TCP_SSL_VERSION_MIN_TARGET      "AsyncTCP_SSL v1.3.0"
-#define ASYNC_TCP_SSL_VERSION_MIN             1003000
+#define ASYNC_TCP_SSL_VERSION_MIN_TARGET      "AsyncTCP_SSL v1.3.1"
+#define ASYNC_TCP_SSL_VERSION_MIN             1003001
 
 #include "multiFileProject.h"
 

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name":"AsyncTCP_SSL",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "keywords":"communication, async, tcp, ssl, tls, mbed, free-rtos",
   "description":"Asynchronous SSL TCP Library for ESP32. This library is the base for future and more advanced Async SSL libraries, such as AsyncSSLWebServer, AsyncHTTPSRequest, etc", 
   "authors": 

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=AsyncTCP_SSL
-version=1.3.0
+version=1.3.1
 author=Hristo Gochkov, Maarten Fremouw, Thorsten von Eicken, Khoi Hoang
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=Asynchronous SSL TCP Library for ESP32.