@@ -31,7 +31,29 @@ a WebSocket Server and Client for Arduino based on RFC6455.
31
31
- ATmega2560 with Ethernet Shield (ATmega branch)
32
32
- ATmega2560 with enc28j60 (ATmega branch)
33
33
34
- ##### High Level API #####
34
+ ###### Note: ######
35
+
36
+ version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch.
37
+
38
+ Arduino for AVR not supports std namespace of c++.
39
+
40
+ ### wss / SSL ###
41
+ supported for:
42
+ - wss client on the ESP8266
43
+ - wss / SSL is not natively supported in WebSocketsServer however it is possible to achieve secure websockets
44
+ by running the device behind an SSL proxy. See [ Nginx] ( examples/Nginx/esp8266.ssl.reverse.proxy.conf ) for a
45
+ sample Nginx server configuration file to enable this.
46
+
47
+ ### ESP Async TCP ###
48
+
49
+ This libary can run in Async TCP mode on the ESP.
50
+
51
+ The mode can be activated in the ``` WebSockets.h ``` (see WEBSOCKETS_NETWORK_TYPE define).
52
+
53
+ [ ESPAsyncTCP] ( https://github.com/me-no-dev/ESPAsyncTCP ) libary is required.
54
+
55
+
56
+ ### High Level Client API ###
35
57
36
58
- ` begin ` : Initiate connection sequence to the websocket host.
37
59
```
@@ -63,29 +85,6 @@ Where `WStype_t type` is defined as:
63
85
} WStype_t;
64
86
```
65
87
66
-
67
- ###### Note: ######
68
-
69
- version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch.
70
-
71
- Arduino for AVR not supports std namespace of c++.
72
-
73
- ### wss / SSL ###
74
- supported for:
75
- - wss client on the ESP8266
76
- - wss / SSL is not natively supported in WebSocketsServer however it is possible to achieve secure websockets
77
- by running the device behind an SSL proxy. See [ Nginx] ( examples/Nginx/esp8266.ssl.reverse.proxy.conf ) for a
78
- sample Nginx server configuration file to enable this.
79
-
80
- ### ESP Async TCP ###
81
-
82
- This libary can run in Async TCP mode on the ESP.
83
-
84
- The mode can be activated in the ``` WebSockets.h ``` (see WEBSOCKETS_NETWORK_TYPE define).
85
-
86
- [ ESPAsyncTCP] ( https://github.com/me-no-dev/ESPAsyncTCP ) libary is required.
87
-
88
-
89
88
### Issues ###
90
89
Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
91
90
0 commit comments