v1.6.2 adds Async_WebSocketsServer example

### Releases v1.6.2

1. Add examples [Async_WebSocketsServer](https://github.com/khoih-prog/AsyncWebServer_Teensy41/tree/main/examples/Async_WebSocketsServer) to demo how to use `Async_WebSockets`

Author: khoih-prog

CONTRIBUTING.md

@@ -10,29 +10,34 @@ However, before reporting a bug please check through the following:
 
 If you don't find anything, please [open a new issue](https://github.com/khoih-prog/AsyncWebServer_Teensy41/issues/new).
 
+---
+
 ### How to submit a bug report
 
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
 * `Teensyduino` Core Version (e.g. `Teensyduino core v1.57`)
-* `QNEthernet` library version (e.g. `QNEthernet v0.16.0`)
+* `QNEthernet` library version (e.g. `QNEthernet v0.17.0`)
 * Board type and relevant info
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
   * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
   * Network configuration
 
+Please be educated, civilized and constructive as you've always been. Disrespective posts against [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-event-code-of-conduct) will be ignored and deleted.
+
+---
 
 ### Example
 
 ```
 Arduino IDE version: 1.8.19
 Teensyduino core v1.57
-Teensy 4.1 using QNEthernet v0.16.0
+Teensy 4.1 using QNEthernet v0.17.0
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.15.0-58-generic #64~20.04.1-Ubuntu SMP Fri Jan 6 16:42:31 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while using this library

README.md

@@ -107,6 +107,7 @@
   * [6. Async_AdvancedWebServer_MemoryIssues_Send_CString on Teensy4.1 QNEthernet](#6-Async_AdvancedWebServer_MemoryIssues_Send_CString-on-Teensy41-QNEthernet)
   * [7. Async_AdvancedWebServer_SendChunked on Teensy4.1 QNEthernet](#7-Async_AdvancedWebServer_SendChunked-on-Teensy41-QNEthernet)
   * [8. AsyncWebServer_SendChunked on Teensy4.1 QNEthernet](#8-AsyncWebServer_SendChunked-on-Teensy41-QNEthernet)
+  * [9. Async_WebSocketsServer on Teensy4.1 QNEthernet](#9-Async_WebSocketsServer-on-Teensy41-QNEthernet)
 * [Debug](#debug)
 * [Troubleshooting](#troubleshooting)
 * [Issues](#issues)
@@ -233,8 +234,8 @@ to apply the better and faster **asynchronous** feature of the **powerful** [ESP
 ## 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. [`Teensy core v1.57+`](https://www.pjrc.com/teensy/td_download.html) for Teensy 4.1.  [![GitHub release](https://img.shields.io/github/release/PaulStoffregen/cores.svg)](https://github.com/PaulStoffregen/cores/releases/latest)
- 3. [`QNEthernet Library version v0.16.0+`](https://github.com/ssilverman/QNEthernet) for Teensy 4.1 built-in Ethernet
+ 2. [`Teensy core v1.57+`](https://github.com/PaulStoffregen/cores) for Teensy 4.1.  [![GitHub release](https://img.shields.io/github/release/PaulStoffregen/cores.svg)](https://github.com/PaulStoffregen/cores/releases/latest)
+ 3. [`QNEthernet Library version v0.17.0+`](https://github.com/ssilverman/QNEthernet) for Teensy 4.1 built-in Ethernet
  4. [`Teensy41_AsyncTCP library v1.1.0+`](https://github.com/khoih-prog/Teensy41_AsyncTCP) to use **Teensy 4.1 using QNEthernet Library**. [![GitHub release](https://img.shields.io/github/release/khoih-prog/Teensy41_AsyncTCP.svg)](https://github.com/khoih-prog/Teensy41_AsyncTCP/releases/latest)
 
 ---
@@ -1062,29 +1063,29 @@ When sending a web socket message using the above methods a buffer is created.
 ```cpp
 void sendDataWs(AsyncWebSocketClient * client)
 {
-    DynamicJsonBuffer jsonBuffer;
-    JsonObject& root = jsonBuffer.createObject();
-    root["a"] = "abc";
-    root["b"] = "abcd";
-    root["c"] = "abcde";
-    root["d"] = "abcdef";
-    root["e"] = "abcdefg";
-    size_t len = root.measureLength();
-    AsyncWebSocketMessageBuffer * buffer = ws.makeBuffer(len); //  creates a buffer (len + 1) for you.
+  DynamicJsonBuffer jsonBuffer;
+  JsonObject& root = jsonBuffer.createObject();
+  root["a"] = "abc";
+  root["b"] = "abcd";
+  root["c"] = "abcde";
+  root["d"] = "abcdef";
+  root["e"] = "abcdefg";
+  size_t len = root.measureLength();
+  AsyncWebSocketMessageBuffer * buffer = ws.makeBuffer(len); //  creates a buffer (len + 1) for you.
+  
+  if (buffer) 
+  {
+    root.printTo((char *)buffer->get(), len + 1);
     
-    if (buffer) 
+    if (client) 
     {
-        root.printTo((char *)buffer->get(), len + 1);
-        
-        if (client) 
-        {
-            client->text(buffer);
-        } 
-        else 
-        {
-            ws.textAll(buffer);
-        }
+        client->text(buffer);
+    } 
+    else 
+    {
+        ws.textAll(buffer);
     }
+  }
 }
 ```
 
@@ -1259,20 +1260,19 @@ void setup()
 
 void loop() 
 {
-
 }
 ```
 
 ### Methods for controlling websocket connections
 
 ```cpp
-  // Disable client connections if it was activated
-  if ( ws.enabled() )
-    ws.enable(false);
+// Disable client connections if it was activated
+if ( ws.enabled() )
+  ws.enable(false);
 
-  // enable client connections if it was disabled
-  if ( !ws.enabled() )
-    ws.enable(true);
+// enable client connections if it was disabled
+if ( !ws.enabled() )
+  ws.enable(true);
 ```
 
 
@@ -1365,11 +1365,12 @@ build_flags =
 11. [**MQTT_ThingStream**](examples/MQTT_ThingStream)
 12. [WebClient](examples/WebClient)
 13. [WebClientRepeating](examples/WebClientRepeating)
-14. [Async_AdvancedWebServer_favicon](examples/Async_AdvancedWebServer_favicon) **New**
-15. [Async_AdvancedWebServer_MemoryIssues_SendArduinoString](examples/Async_AdvancedWebServer_MemoryIssues_SendArduinoString) **New**
-16. [Async_AdvancedWebServer_MemoryIssues_Send_CString](examples/Async_AdvancedWebServer_MemoryIssues_Send_CString) **New**
-17. [Async_AdvancedWebServer_SendChunked](examples/Async_AdvancedWebServer_SendChunked) **New**
-18. [AsyncWebServer_SendChunked](examples/AsyncWebServer_SendChunked) **New**
+14. [Async_AdvancedWebServer_favicon](examples/Async_AdvancedWebServer_favicon)
+15. [Async_AdvancedWebServer_MemoryIssues_SendArduinoString](examples/Async_AdvancedWebServer_MemoryIssues_SendArduinoString)
+16. [Async_AdvancedWebServer_MemoryIssues_Send_CString](examples/Async_AdvancedWebServer_MemoryIssues_Send_CString)
+17. [Async_AdvancedWebServer_SendChunked](examples/Async_AdvancedWebServer_SendChunked)
+18. [AsyncWebServer_SendChunked](examples/AsyncWebServer_SendChunked)
+19. [Async_WebSocketsServer](examples/Async_WebSocketsServer) **New**
 
 ---
 ---
@@ -1402,7 +1403,7 @@ Following are debug terminal output and screen shots when running example [Async
 
 ```cpp
 Start Async_AdvancedWebServer on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.107
 HTTP EthernetWebServer is @ IP : 192.168.2.107
 ```
@@ -1420,7 +1421,7 @@ Following is debug terminal output when running example [WebClient](examples/Web
 
 ```cpp
 Start WebClient on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.107
 
 Starting connection to server...
@@ -1491,7 +1492,7 @@ Following is debug terminal output when running example [MQTTClient_Auth](exampl
 
 ```cpp
 Start MQTTClient_Auth on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.107
 Attempting MQTT connection to broker.emqx.io...connected
 Message Send : MQTT_Pub => Hello from MQTTClient_Auth on TEENSY 4.1 with Teensy4.1 QNEthernet
@@ -1511,7 +1512,7 @@ Following is debug terminal output when running example [MQTTClient_Basic](examp
 
 ```cpp
 Start MQTTClient_Basic on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.107
 Attempting MQTT connection to broker.emqx.io...connected
 Message Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY 4.1 with Teensy4.1 QNEthernet
@@ -1538,7 +1539,7 @@ Following is debug terminal output when running example [MQTT_ThingStream](examp
 
 ```cpp
 Start MQTT_ThingStream on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.107
 ***************************************
 Teensy41_Pub
@@ -1571,7 +1572,7 @@ Following is the debug terminal and screen shot when running example [Async_Adva
 
 ```cpp
 Start Async_AdvancedWebServer_MemoryIssues_Send_CString on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 
 HEAP DATA - Start =>  Free heap: 483328  Used heap: 0
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.83
@@ -1595,7 +1596,7 @@ While using `Arduino String`, the HEAP usage is very large
 
 ```cpp
 Start Async_AdvancedWebServer_MemoryIssues_SendArduinoString on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 
 HEAP DATA - Start =>  Free heap: 483328  Used heap: 0
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.83
@@ -1635,7 +1636,7 @@ Following is debug terminal output when running example [Async_AdvancedWebServer
 
 ```cpp
 Start Async_AdvancedWebServer_SendChunked on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.92
 AsyncWebServer is @ IP : 192.168.2.92
 .[AWS] Total length to send in chunks = 31235
@@ -1704,7 +1705,7 @@ Following is debug terminal output when running example [AsyncWebServer_SendChun
 
 ```cpp
 Start AsyncWebServer_SendChunked on TEENSY 4.1 with Teensy4.1 QNEthernet
-AsyncWebServer_Teensy41 v1.6.1
+AsyncWebServer_Teensy41 v1.6.2
 Initialize Ethernet using DHCP => Connected! IP address:192.168.2.92
 AsyncWebServer is @ IP : 192.168.2.92
 .[AWS] Total length to send in chunks = 46302
@@ -1750,6 +1751,30 @@ AsyncWebServer is @ IP : 192.168.2.92
 ```
 
 
+---
+
+#### 9. Async_WebSocketsServer on TEENSY 4.1 QNEthernet
+
+
+Following is debug terminal output when running example [Async_WebSocketsServer](examples/Async_WebSocketsServer) on `Teensy4.1` using Built-in Ethernet and `QNEthernet` Library, to demo how to use to demo how to use `Async_WebSockets`. The Client is using [WSClient.py](https://github.com/khoih-prog/AsyncWebServer_Teensy41/blob/main/examples/Async_WebSocketsServer/WSClient_Python/WSClient.py)
+
+
+```cpp
+Starting Async_WebSocketsServer on TEENSY 4.1 with Teensy4.1 QNEthernet
+AsyncWebServer_Teensy41 v1.6.2
+Initialize Ethernet using DHCP => Connected! IP address:192.168.2.119
+ws[Server: /ws][ClientID: 1] WSClient connected
+ws[Server: /ws][ClientID: 1] text-message[len: 13]: Hello, Server
+ws[Server: /ws][ClientID: 1] WSClient disconnected
+ws[Server: /ws][ClientID: 2] WSClient connected
+ws[Server: /ws][ClientID: 2] text-message[len: 13]: Hello, Server
+ws[Server: /ws][ClientID: 2] WSClient disconnected
+ws[Server: /ws][ClientID: 3] WSClient connected
+ws[Server: /ws][ClientID: 3] text-message[len: 13]: Hello, Server
+```
+
+
+
 ---
 ---
 
@@ -1801,7 +1826,7 @@ Submit issues to: [AsyncWebServer_Teensy41 issues](https://github.com/khoih-prog
  8. Support using `CString` to save heap to send `very large data`. Check [request->send(200, textPlainStr, jsonChartDataCharStr); - Without using String Class - to save heap #8](https://github.com/khoih-prog/Portenta_H7_AsyncWebServer/pull/8)
  9. Add examples [Async_AdvancedWebServer_SendChunked](https://github.com/khoih-prog/AsyncWebServer_RP2040W/tree/main/examples/Async_AdvancedWebServer_SendChunked) and [AsyncWebServer_SendChunked](https://github.com/khoih-prog/AsyncWebServer_RP2040W/tree/main/examples/AsyncWebServer_SendChunked) to demo how to use `beginChunkedResponse()` to send large `html` in chunks
 10. Use `allman astyle` and add `utils`
-
+11. Add examples [Async_WebSocketsServer](https://github.com/khoih-prog/AsyncWebServer_Teensy41/tree/main/examples/Async_WebSocketsServer) to demo how to use `Async_WebSockets`
 
 
 ---

changelog.md

@@ -9,13 +9,15 @@
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
 
+
 ---
 ---
 
 ## Table of contents
 
 * [Table of contents](#table-of-contents)
 * [Changelog](#changelog)
+  * [Releases v1.6.2](#releases-v162)
   * [Releases v1.6.1](#releases-v161)
   * [Releases v1.6.0](#releases-v160)
   * [Releases v1.5.0](#releases-v150)
@@ -26,11 +28,16 @@
 
 ## Changelog
 
+### Releases v1.6.2
+
+1. Add examples [Async_WebSocketsServer](https://github.com/khoih-prog/AsyncWebServer_Teensy41/tree/main/examples/Async_WebSocketsServer) to demo how to use `Async_WebSockets`
+
 ### Releases v1.6.1
 
 1. Add examples [Async_AdvancedWebServer_SendChunked](https://github.com/khoih-prog/AsyncWebServer_Teensy41/tree/main/examples/Async_AdvancedWebServer_SendChunked) and [AsyncWebServer_SendChunked](https://github.com/khoih-prog/AsyncWebServer_Teensy41/tree/main/examples/AsyncWebServer_SendChunked) to demo how to use `beginChunkedResponse()` to send large `html` in chunks
 2. Use `allman astyle` and add `utils`
 
+
 ### Releases v1.6.0
 
 1. Support using `CString` to save heap to send `very large data`. Check [request->send(200, textPlainStr, jsonChartDataCharStr); - Without using String Class - to save heap #8](https://github.com/khoih-prog/Portenta_H7_AsyncWebServer/pull/8) and [All memmove() removed - string no longer destroyed #11](https://github.com/khoih-prog/Portenta_H7_AsyncWebServer/pull/11)

library.json

@@ -1,6 +1,6 @@
 {
   "name":"AsyncWebServer_Teensy41",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description":"Asynchronous HTTP and WebSocket Server Library for Teensy 4.1 using QNEthernet. This library is one of the current or future Async libraries to support Teensy 4.1 using QNEthernet, such as AsyncHTTPRequest_Generic, AsyncHTTPSRequest_Generic, AsyncMQTT_Generic, Teensy41_AsyncWebServer, Teensy41_AsyncUDP, Teensy41_AsyncDNSServer, AsyncWebServer_Teensy41_SSL, etc. Now supporting using CString to save heap to send very large data and examples to demo how to use beginChunkedResponse() to send large html in chunks",
   "keywords":"async, tcp, http, websocket, webserver, async-tcp, async-http, async-webserver, async-websocket, teensy, teensy41, teensy-41, qnethernet, lwip",
   "authors": 
@@ -32,7 +32,7 @@
     {
       "owner": "ssilverman",
       "name": "QNEthernet",
-      "version": ">=0.16.0",
+      "version": ">=0.17.0",
       "platforms": ["teensy"]
     }
   ],

library.properties

@@ -1,5 +1,5 @@
 name=AsyncWebServer_Teensy41
-version=1.6.1
+version=1.6.2
 author=Hristo Gochkov, Khoi Hoang
 maintainer=Khoi Hoang <khoih-dot-prog@gmail.com>
 sentence=Asynchronous HTTP and WebSocket Server Library for Teensy 4.1 using QNEthernet

platformio/platformio.ini

@@ -26,26 +26,29 @@ upload_speed = 921600
 ;monitor_speed = 9600
 ;monitor_port = COM11
 
+; ============================================================
 ; Checks for the compatibility with frameworks and dev/platforms
 ; Adjust as necessary
 lib_compat_mode = strict
 lib_ldf_mode = chain+
 ;lib_ldf_mode = deep+
 
+; ============================================================
 lib_deps =
 ; PlatformIO 4.x
 ; Teensy41_AsyncTCP@>=1.1.0
-; QNEthernet@>=0.16.0
+; QNEthernet@>=0.17.0
 ;
 ; PlatformIO 5.x  
   khoih-prog/Teensy41_AsyncTCP@>=1.1.0
-  ssilverman/QNEthernet@>=0.16.0
+  ssilverman/QNEthernet@>=0.17.0
 
-  
+; ============================================================
 build_flags =
 ; set your build_flags
 
-[env:STM32]
+; ============================================================ 
+[env:teensy]
 platform = teensy
 framework = arduino
 

src/AsyncEventSource_Teensy41.cpp

@@ -17,7 +17,7 @@
   You should have received a copy of the GNU General Public License along with this program.
   If not, see <https://www.gnu.org/licenses/>.
 
-  Version: 1.6.1
+  Version: 1.6.2
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -26,6 +26,7 @@
   1.5.0   K Hoang      01/10/2022 Fix issue with slow browsers or network. Add function and example to support favicon.ico
   1.6.0   K Hoang      06/10/2022 Option to use non-destroyed cString instead of String to save Heap
   1.6.1   K Hoang      10/11/2022 Add examples to demo how to use beginChunkedResponse() to send in chunks
+  1.6.2   K Hoang      16/01/2023 Add examples Async_WebSocketsServer
  *****************************************************************************************************************************/
 
 #if !defined(_AWS_TEENSY41_LOGLEVEL_)

src/AsyncEventSource_Teensy41.h

@@ -17,7 +17,7 @@
   You should have received a copy of the GNU General Public License along with this program.
   If not, see <https://www.gnu.org/licenses/>.
 
-  Version: 1.6.1
+  Version: 1.6.2
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -26,6 +26,7 @@
   1.5.0   K Hoang      01/10/2022 Fix issue with slow browsers or network. Add function and example to support favicon.ico
   1.6.0   K Hoang      06/10/2022 Option to use non-destroyed cString instead of String to save Heap
   1.6.1   K Hoang      10/11/2022 Add examples to demo how to use beginChunkedResponse() to send in chunks
+  1.6.2   K Hoang      16/01/2023 Add examples Async_WebSocketsServer
  *****************************************************************************************************************************/
 
 #pragma once