2015-05-24 16:02:22 +02:00
WebSocket Server and Client for Arduino
===========================================
2015-05-24 00:18:52 +02:00
2015-05-24 16:02:22 +02:00
a WebSocket Server and Client for Arduino based on RFC6455.
2015-12-10 11:16:08 +01:00
2015-05-24 16:02:22 +02:00
##### Supported features of RFC6455 #####
- text frame
- binary frame
- connection close
- ping
- pong
##### Not supported features of RFC6455 #####
- continuation frame
##### Limitations #####
- 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)
2015-12-28 03:25:01 +01:00
- Client send big frames with mask 0x00000000 (on AVR all frames)
2015-05-24 16:02:22 +02:00
##### Supported Hardware #####
- ESP8266 [Arduino for ESP8266 ](https://github.com/Links2004/Arduino )
2016-01-30 12:02:09 +01:00
- ESP31B
2016-01-29 13:44:18 +01:00
- ATmega328 with Ethernet Shield (ATmega branch)
- ATmega328 with enc28j60 (ATmega branch)
- ATmega2560 with Ethernet Shield (ATmega branch)
- ATmega2560 with enc28j60 (ATmega branch)
###### Note: ######
2016-02-20 12:30:38 +01:00
version 2.0 and up is not compatible with AVR/ATmega, check ATmega branch.
2016-01-29 13:44:18 +01:00
Arduino for AVR not supports std namespace of c++.
2015-12-10 11:16:08 +01:00
### wss / SSL ###
supported for:
- wss client on the ESP8266
2015-05-24 16:02:22 +02:00
2016-01-29 13:28:05 +01:00
### ESP Async TCP ###
2016-01-29 13:44:18 +01:00
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).
2016-02-20 12:30:38 +01:00
[ESPAsyncTCP ](https://github.com/me-no-dev/ESPAsyncTCP ) libary is required.
2016-01-29 13:44:18 +01:00
Note: in this mode wss / SSL is not possible.
2016-01-29 13:28:05 +01:00
2015-05-24 16:02:22 +02:00
### Issues ###
Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
2015-11-27 00:44:52 +01:00
[](https://gitter.im/Links2004/arduinoWebSockets?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2015-05-24 16:02:22 +02:00
### License and credits ###
The library is licensed under [LGPLv2.1 ](https://github.com/Links2004/arduinoWebSockets/blob/master/LICENSE )
[libb64 ](http://libb64.sourceforge.net/ ) written by Chris Venter. It is distributed under Public Domain see [LICENSE ](https://github.com/Links2004/arduinoWebSockets/blob/master/src/libb64/LICENSE ).
