Merge remote-tracking branch 'Links2004/master'

Author: Me No Dev

README.md

@@ -18,18 +18,37 @@ a WebSocket Server and Client for Arduino based on RFC6455.
  - max input length is limited to the ram size and the ```WEBSOCKETS_MAX_DATA_SIZE``` define
  - max output length has no limit (the hardware is the limit)
  - Client send big frames with mask 0x00000000 (on AVR all frames)
-
+ 
+ ##### Limitations for Async #####
+ - Functions called from within the context of the websocket event might not honor `yield()` and/or `delay()`.  See [this issue](https://github.com/Links2004/arduinoWebSockets/issues/58#issuecomment-192376395) for more info and a potential workaround.
+ - wss / SSL is not possible.
+ 
 ##### Supported Hardware #####
  - ESP8266 [Arduino for ESP8266](https://github.com/Links2004/Arduino)
- - ATmega328 with Ethernet Shield (alpha)
- - ATmega328 with enc28j60 (alpha)
- - ATmega2560 with Ethernet Shield (alpha)
- - ATmega2560 with enc28j60 (alpha)
+ - ESP31B
+ - ATmega328 with Ethernet Shield (ATmega branch) 
+ - ATmega328 with enc28j60 (ATmega branch) 
+ - ATmega2560 with Ethernet Shield (ATmega branch) 
+ - ATmega2560 with enc28j60 (ATmega branch) 
+ 
+###### Note: ######
+
+  version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch.
+  
+  Arduino for AVR not supports std namespace of c++.
 
 ### wss / SSL ###
  supported for:
  - wss client on the ESP8266
 
+### ESP Async TCP ###
+
+This libary can run in Async TCP mode on the ESP.
+
+The mode can be aktivated in the ```WebSockets.h``` (see WEBSOCKETS_NETWORK_TYPE define).
+
+[ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) libary is required.
+
 ### Issues ###
 Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
 

examples/WebSocketClient/WebSocketClient.ino

@@ -77,6 +77,7 @@ void setup() {
     }
 
     webSocket.begin("192.168.0.123", 81);
+    //webSocket.setAuthorization("user", "Password"); // HTTP Basic Authorization
     webSocket.onEvent(webSocketEvent);
 
 }

examples/WebSocketClientSSL/WebSocketClientSSL.ino

@@ -22,7 +22,7 @@ WebSocketsClient webSocket;
 
 #define USE_SERIAL Serial1
 
-void webSocketEvent(WStype_t type, uint8_t * payload, size_t lenght) {
+void webSocketEvent(WStype_t type, uint8_t * payload, size_t length) {
 
 
     switch(type) {
@@ -44,11 +44,11 @@ void webSocketEvent(WStype_t type, uint8_t * payload, size_t lenght) {
 			// webSocket.sendTXT("message here");
             break;
         case WStype_BIN:
-            USE_SERIAL.printf("[WSc] get binary lenght: %u\n", lenght);
-            hexdump(payload, lenght);
+            USE_SERIAL.printf("[WSc] get binary length: %u\n", length);
+            hexdump(payload, length);
 
             // send data to server
-            // webSocket.sendBIN(payload, lenght);
+            // webSocket.sendBIN(payload, length);
             break;
     }
 

library.properties

@@ -1,9 +1,9 @@
 name=WebSockets
-version=1.3
+version=2.0.2
 author=Markus Sattler
 maintainer=Markus Sattler 
 sentence=WebSockets for Arduino (Server + Client)
-paragraph=
+paragraph=use 2.x.x for ESP and 1.3 for AVR
 category=Communication
 url=https://github.com/Links2004/arduinoWebSockets
 architectures=*